Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Certain hyphenated options on rsync manual page are unsearchable #686

Closed
purplearmadillo77 opened this issue Jan 3, 2025 · 1 comment
Closed

Comments

@purplearmadillo77
Copy link

Observed with

$ rsync --version
rsync  version 3.3.0  protocol version 31

on 64-bit Cygwin.

Steps to reproduce:

  • Run man rsync.
  • Search for no-compress. You find no results.
  • Search for implies --no. You find:
This  option can be used to override the automatic negotiation of
the compression algorithm that occurs when  --compress  is  used.
The  option implies --compress unless "none" was specified, which
instead implies --no‐compress.

I sure see --no-compress on the bottom. This is just one example. There are a couple other unsearchable hyphens in the manual page as well.

(Conjectured) Cause:
The nroff format that is used to write man pages has the following peculiarity:

  • The raw ASCII hyphen - in the nroff source is rendered as U+2010 HYPHEN.
  • The escaped ASCII hyphen \- in the nroff source is rendered as an ASCII hyphen.

Inspecting the source of rsync.1, we see that the relevant hyphens were not escaped:

This option can be used to override the automatic negotiation of the
compression algorithm that occurs when \fB\-\-compress\fP is used.  The
option implies \fB\-\-compress\fP unless "none" was specified, which
instead implies \fB\-\-no-compress\fP.
@WayneD
Copy link
Member

WayneD commented Jan 15, 2025

One thing you can do is to search the web version.

I know that the words are searchable in Chrome, since chrome will cross-match a dash and that hyphen.

@WayneD WayneD closed this as completed in 353506b Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants