Skip to content

Commit 963167e

Browse files
authored
Fix manpage synopsis formatting (#1241)
2 parents fdebaec + 88bd824 commit 963167e

File tree

2 files changed

+31
-13
lines changed

2 files changed

+31
-13
lines changed

docs/man/sudo.8.man

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,35 @@
55
\f[CR]sudo\f[R], \f[CR]sudoedit\f[R] \- execute a command as another
66
user
77
.SH SYNOPSIS
8+
.PP
89
\f[CR]sudo\f[R] \f[CR]\-h\f[R] | \f[CR]\-K\f[R] | \f[CR]\-k\f[R] |
9-
\f[CR]\-V\f[R] \f[CR]sudo\f[R] [\f[CR]\-u\f[R] \f[I]user\f[R]]
10-
[\f[CR]\-g\f[R] \f[I]group\f[R]] [\f[CR]\-D\f[R] \f[I]directory\f[R]]
10+
\f[CR]\-V\f[R]
11+
.PD 0
12+
.P
13+
.PD
14+
\f[CR]sudo\f[R] [\f[CR]\-u\f[R] \f[I]user\f[R]] [\f[CR]\-g\f[R]
15+
\f[I]group\f[R]] [\f[CR]\-D\f[R] \f[I]directory\f[R]]
1116
[\f[CR]\-BknS\f[R]] [\f[CR]\-i\f[R] | \f[CR]\-s\f[R]]
12-
[\f[CR]VAR=value\f[R]] [<\f[I]command\f[R]>] \f[CR]sudo\f[R]
13-
\f[CR]\-v\f[R] [\f[CR]\-BknS\f[R]] [\f[CR]\-u\f[R] \f[I]user\f[R]]
14-
[\f[CR]\-g\f[R] \f[I]group\f[R]] \f[CR]sudo\f[R] \f[CR]\-l\f[R]
15-
[\f[CR]\-BknS\f[R]] [\f[CR]\-U\f[R] \f[I]user\f[R]] [\f[CR]\-u\f[R]
16-
\f[I]user\f[R]] [\f[CR]\-g\f[R] \f[I]group\f[R]] [command [arg \&...]]
17+
[\f[CR]VAR=value\f[R]] [<\f[I]command\f[R]>]
18+
.PD 0
19+
.P
20+
.PD
21+
\f[CR]sudo\f[R] \f[CR]\-v\f[R] [\f[CR]\-BknS\f[R]] [\f[CR]\-u\f[R]
22+
\f[I]user\f[R]] [\f[CR]\-g\f[R] \f[I]group\f[R]]
23+
.PD 0
24+
.P
25+
.PD
26+
\f[CR]sudo\f[R] \f[CR]\-l\f[R] [\f[CR]\-BknS\f[R]] [\f[CR]\-U\f[R]
27+
\f[I]user\f[R]] [\f[CR]\-u\f[R] \f[I]user\f[R]] [\f[CR]\-g\f[R]
28+
\f[I]group\f[R]] [command [arg \&...]]
29+
.PD 0
30+
.P
31+
.PD
1732
\f[CR]sudo\f[R] \f[CR]\-e\f[R] [\f[CR]\-BknS\f[R]] [\f[CR]\-u\f[R]
1833
\f[I]user\f[R]] [\f[CR]\-g\f[R] \f[I]group\f[R]] file \&...
34+
.PD 0
35+
.P
36+
.PD
1937
\f[CR]sudoedit\f[R] [\f[CR]\-BknS\f[R]] [\f[CR]\-u\f[R] \f[I]user\f[R]]
2038
[\f[CR]\-g\f[R] \f[I]group\f[R]] file \&...
2139
.SH DESCRIPTION

docs/man/sudo.8.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ title: SUDO(8) sudo-rs 0.2.8 | sudo-rs
88

99
# SYNOPSIS
1010

11-
`sudo` `-h` | `-K` | `-k` | `-V`
12-
`sudo` [`-u` *user*] [`-g` *group*] [`-D` *directory*] [`-BknS`] [`-i` | `-s`] [`VAR=value`] [<*command*>]
13-
`sudo` `-v` [`-BknS`] [`-u` *user*] [`-g` *group*]
14-
`sudo` `-l` [`-BknS`] [`-U` *user*] [`-u` *user*] [`-g` *group*] [command [arg ...]]
15-
`sudo` `-e` [`-BknS`] [`-u` *user*] [`-g` *group*] file ...
16-
`sudoedit` [`-BknS`] [`-u` *user*] [`-g` *group*] file ...
11+
| `sudo` `-h` | `-K` | `-k` | `-V`
12+
| `sudo` \[`-u` *user*\] \[`-g` *group*\] \[`-D` *directory*\] \[`-BknS`\] \[`-i` | `-s`\] \[`VAR=value`\] \[<*command*>\]
13+
| `sudo` `-v` \[`-BknS`\] \[`-u` *user*\] \[`-g` *group*\]
14+
| `sudo` `-l` \[`-BknS`\] \[`-U` *user*\] \[`-u` *user*\] \[`-g` *group*\] \[command \[arg ...\]\]
15+
| `sudo` `-e` \[`-BknS`\] \[`-u` *user*\] \[`-g` *group*\] file ...
16+
| `sudoedit` \[`-BknS`\] \[`-u` *user*\] \[`-g` *group*\] file ...
1717

1818

1919
# DESCRIPTION

0 commit comments

Comments
 (0)