Skip to content

Commit

Permalink
doc: fix manpage warnings
Browse files Browse the repository at this point in the history 
Fixes: #18434
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information
@silverwind
silverwind committed Jan 30, 2018
1 parent a178123 commit e56189e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/node.1
View file
Expand Up @@ -37,9 +37,9 @@ node \- Server-side JavaScript runtime
.RI [ script.js \ |
.B -e
.RI \&" script \&"
.R |
.RI |
.B -
.R ]
.RI ]
.B [--]
.RI [ arguments ]
.br
Expand Down

4 comments on commit e56189e

@silverwind
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR-URL: #18440

@Alhadis
Copy link
Contributor

@Alhadis Alhadis commented on e56189e Feb 3, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both of these should just be ordinary input lines (as opposed to command lines; those which start with a leading dot).

.RI \&" script \&"
|
.B -
]
.B [--]

Lines are soft-wrapped unless .nf ("No fill") is used:

This is
one
single
line.
.
.nf  \" No fill
These
are
separate
lines
.fi   \" Fill lines
.
Back to
soft-wrapping,
folks

@silverwind
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Alhadis Would you mind filing a pull request with your changes? You seem rather knowledable on the topic. Maybe you have a few more improvements in mind for the synopsis. For example, the [--] looks a bit odd on my pager.

@Alhadis
Copy link
Contributor

@Alhadis Alhadis commented on e56189e Feb 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did. See #18559.

Please sign in to comment.