| Summary: | Issues in openssh manpages | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Portable OpenSSH | Reporter: | Helge Kreutzmann <debian> | ||||
| Component: | Documentation | Assignee: | Assigned to nobody <unassigned-bugs> | ||||
| Status: | CLOSED FIXED | ||||||
| Severity: | trivial | CC: | dtucker | ||||
| Priority: | P5 | ||||||
| Version: | 8.4p1 | ||||||
| Hardware: | All | ||||||
| OS: | All | ||||||
| Bug Depends on: | |||||||
| Bug Blocks: | 3217 | ||||||
| Attachments: |
|
||||||
|
Description
Helge Kreutzmann
2020-10-25 19:03:23 AEDT
(In reply to Helge Kreutzmann from comment #0) [...] > Man page: sftp.1 > Issue: Broken wrapping, everything before "Display" belongs to the > command This does not exist upstream. The formatted version of the upstream man page looks like ``` df [-hi] [path] Display usage information for the ``` The same applies to the following three items. > Man page: sftp.1 > Issue: Is this missing a dash? No. > "OpenSSH secure file transfer" > -- > Man page: ssh-agent.1 > Issue: eg → e.g. > > "There are two main ways to get an agent set up: The first is that > the agent " > "starts a new subcommand into which some environment variables are > exported, " > "eg E<.Cm ssh-agent xterm &>. This text does not exist in OpenSSH's man page: ``` There are two main ways to get an agent set up. The first is at the start of an X session, where all other windows or programs are started as children of the ssh-agent program. The agent starts a command under which its environment variables are exported, for example ssh-agent xterm &. When the command terminates, so does the agent. ``` > -- > Man page: ssh-agent.1 > Issue: ssh-agent. → E<.Nm> > > "In Debian, E<.Nm> is installed with the set-group-id bit set, to > prevent E<." This text also does not exist in the upstream text and looks like a Debian modification. > Man page: ssh-agent.1 > Issue: ssh(1) does not have a section caveats err, OK. So? > Man page: ssh-keygen.1 > Issue: private keys → prvivate key? Definitely no. > Man page: ssh-keygen.1 > Issue: safety → security? > > "Test DH group exchange candidate primes (generated using the E<.Fl > G> " > "option) for safety." No. Safe primes are a specific concept: https://en.wikipedia.org/wiki/Safe_and_Sophie_Germain_primes > -- > Man page: ssh-keygen.1 > Issue: 2011). → 2011), Yes. > Man page: ssh-keygen.1 > Issue: By default, the validity of certificates starts with the > E<.Ux> Epoch and is unlimited. the capitalization? probably yes. > -- > Man page: ssh-keygen.1 > Issue: See → see Yes. Created attachment 3452 [details]
fix identified man page nits
(In reply to Darren Tucker from comment #1) > > Man page: ssh-keygen.1 > > Issue: By default, the validity of certificates starts with the > > E<.Ux> Epoch and is unlimited. > > the capitalization? probably yes. Our man page expert prefers the existing text including the capitalization "from UNIX Epoch to the distant future." so I'm removing that part. I've committed the changes, thanks for the report. The changes will be visible soon on https://man.openbsd.org/ssh-keygen.1 and https://github.com/openssh/openssh-portable/blob/master/ssh-keygen.1 close bugs that were resolved in OpenSSH 8.5 release cycle |