Skip to content

Commit dc0f16d

Browse files
committed
Avoid using ".It Li foo ..." in sudo manuals.
The .Li macro is deprecated and makes no difference on terminal devices. Also avoid using items greater than 80 characters which will wrap incorrectly. Bug #1075.
1 parent aad6910 commit dc0f16d

File tree

2 files changed

+72
-26
lines changed

2 files changed

+72
-26
lines changed

docs/sudo.mdoc.in

Lines changed: 63 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1426,8 +1426,9 @@ $ sudo sh -c "cd /home ; du -s * | sort -rn > USAGE"
14261426
Error messages produced by
14271427
.Nm
14281428
include:
1429-
.Bl -tag -width 4n
1430-
.It Li editing files in a writable directory is not permitted
1429+
.Pp
1430+
editing files in a writable directory is not permitted
1431+
.Bd -ragged -offset 4n -compact
14311432
By default,
14321433
.Nm sudoedit
14331434
does not permit editing a file when any of the parent directories are writable
@@ -1439,7 +1440,10 @@ See the
14391440
option in
14401441
.Xr sudoers @mansectform@
14411442
for more information.
1442-
.It Li editing symbolic links is not permitted
1443+
.Ed
1444+
.Pp
1445+
editing symbolic links is not permitted
1446+
.Bd -ragged -offset 4n -compact
14431447
By default,
14441448
.Nm sudoedit
14451449
does not follow symbolic links when opening files.
@@ -1448,7 +1452,10 @@ See the
14481452
option in
14491453
.Xr sudoers @mansectform@
14501454
for more information.
1451-
.It Li effective uid is not 0, is sudo installed setuid root?
1455+
.Ed
1456+
.Pp
1457+
effective uid is not 0, is sudo installed setuid root?
1458+
.Bd -ragged -offset 4n -compact
14521459
.Nm
14531460
was not run with root privileges.
14541461
The
@@ -1457,7 +1464,11 @@ binary must be owned by the root user and have the set-user-ID bit set.
14571464
Also, it must not be located on a file system mounted with the
14581465
.Sq nosuid
14591466
option or on an NFS file system that maps uid 0 to an unprivileged uid.
1460-
.It Li effective uid is not 0, is sudo on a file system with the 'nosuid' option set or an NFS file system without root privileges?
1467+
.Ed
1468+
.Pp
1469+
effective uid is not 0, is sudo on a file system with the 'nosuid'
1470+
option set or an NFS file system without root privileges?
1471+
.Bd -ragged -offset 4n -compact
14611472
.Nm
14621473
was not run with root privileges.
14631474
The
@@ -1469,26 +1480,38 @@ The most common reason for this is that the file system the
14691480
binary is located on is mounted with the
14701481
.Sq nosuid
14711482
option or it is an NFS file system that maps uid 0 to an unprivileged uid.
1472-
.It Li fatal error, unable to load plugins
1483+
.Ed
1484+
.Pp
1485+
fatal error, unable to load plugins
1486+
.Bd -ragged -offset 4n -compact
14731487
An error occurred while loading or initializing the plugins specified in
14741488
.Xr sudo.conf @mansectform@ .
1475-
.It Li invalid environment variable name
1489+
.Ed
1490+
.Pp
1491+
invalid environment variable name
1492+
.Bd -ragged -offset 4n -compact
14761493
One or more environment variable names specified via the
14771494
.Fl E
14781495
option contained an equal sign
14791496
.Pq Ql = .
14801497
The arguments to the
14811498
.Fl E
14821499
option should be environment variable names without an associated value.
1483-
.It Li no password was provided
1500+
.Ed
1501+
.Pp
1502+
no password was provided
1503+
.Bd -ragged -offset 4n -compact
14841504
When
14851505
.Nm
14861506
tried to read the password, it did not receive any characters.
14871507
This may happen if no terminal is available (or the
14881508
.Fl S
14891509
option is specified) and the standard input has been redirected from
14901510
.Pa /dev/null .
1491-
.It Li a terminal is required to read the password
1511+
.Ed
1512+
.Pp
1513+
a terminal is required to read the password
1514+
.Bd -ragged -offset 4n -compact
14921515
.Nm
14931516
needs to read the password but there is no mechanism available for it
14941517
to do so.
@@ -1511,11 +1534,19 @@ an askpass helper can be configured via either the
15111534
file or by setting the
15121535
.Ev SUDO_ASKPASS
15131536
environment variable.
1514-
.It Li no writable temporary directory found
1537+
.Ed
1538+
.Pp
1539+
no writable temporary directory found
1540+
.Bd -ragged -offset 4n -compact
15151541
.Nm sudoedit
15161542
was unable to find a usable temporary directory in which to store its
15171543
intermediate files.
1518-
.It Li The Do "no new privileges" Dc "flag is set, which prevents sudo from running as root."
1544+
.Ed
1545+
.Pp
1546+
The
1547+
.Dq no new privileges
1548+
flag is set, which prevents sudo from running as root.
1549+
.Bd -ragged -offset 4n -compact
15191550
.Nm
15201551
was run by a process that has the Linux
15211552
.Dq no new privileges
@@ -1529,27 +1560,42 @@ The most likely cause for this is running
15291560
within a container that sets this flag.
15301561
Check the documentation to see if it is possible to configure the
15311562
container such that the flag is not set.
1532-
.It Li sudo must be owned by uid 0 and have the setuid bit set
1563+
.Ed
1564+
.Pp
1565+
sudo must be owned by uid 0 and have the setuid bit set
1566+
.Bd -ragged -offset 4n -compact
15331567
.Nm
15341568
was not run with root privileges.
15351569
The
15361570
.Nm
15371571
binary does not have the correct owner or permissions.
15381572
It must be owned by the root user and have the set-user-ID bit set.
1539-
.It Li sudoedit is not supported on this platform
1573+
.Ed
1574+
.Pp
1575+
sudoedit is not supported on this platform
1576+
.Bd -ragged -offset 4n -compact
15401577
It is only possible to run
15411578
.Nm sudoedit
15421579
on systems that support setting the effective user-ID.
1543-
.It Li timed out reading password
1580+
.Ed
1581+
.Pp
1582+
timed out reading password
1583+
.Bd -ragged -offset 4n -compact
15441584
The user did not enter a password before the password timeout
15451585
(5 minutes by default) expired.
1546-
.It Li you do not exist in the passwd database
1586+
.Ed
1587+
.Pp
1588+
you do not exist in the passwd database
1589+
.Bd -ragged -offset 4n -compact
15471590
Your user-ID does not appear in the system passwd database.
1548-
.It Li you may not specify environment variables in edit mode
1591+
.Ed
1592+
.Pp
1593+
you may not specify environment variables in edit mode
1594+
.Bd -ragged -offset 4n -compact
15491595
It is only possible to specify environment variables when running a
15501596
.Ar command .
15511597
When editing a file, the editor is run with the user's environment unmodified.
1552-
.El
1598+
.Ed
15531599
.Sh SEE ALSO
15541600
.Xr su 1 ,
15551601
.Xr stat 2 ,

docs/visudo.mdoc.in

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -398,17 +398,17 @@ syntax errors,
398398
.Nm
399399
may produce the following messages:
400400
.Bl -tag -width 4n
401-
.It Li sudoers file busy, try again later.
401+
.It sudoers file busy, try again later.
402402
Someone else is currently editing the
403403
.Em sudoers
404404
file.
405-
.It Li @sysconfdir@/sudoers: Permission denied
405+
.It @sysconfdir@/sudoers: Permission denied
406406
You didn't run
407407
.Nm
408408
as root.
409-
.It Li you do not exist in the passwd database
409+
.It you do not exist in the passwd database
410410
Your user-ID does not appear in the system passwd database.
411-
.It Li Warning: {User,Runas,Host,Cmnd}_Alias referenced but not defined
411+
.It Warning: {User,Runas,Host,Cmnd}_Alias referenced but not defined
412412
Either you are trying to use an undeclared {User,Runas,Host,Cmnd}_Alias
413413
or you have a user or host name listed that consists solely of
414414
uppercase letters, digits, and the underscore
@@ -425,14 +425,14 @@ file and the line number where the undefined alias was used.
425425
In
426426
.Fl s
427427
(strict) mode these are errors, not warnings.
428-
.It Li Warning: unused {User,Runas,Host,Cmnd}_Alias
428+
.It Warning: unused {User,Runas,Host,Cmnd}_Alias
429429
The specified {User,Runas,Host,Cmnd}_Alias was defined but never
430430
used.
431431
The message is prefixed with the path name of the
432432
.Em sudoers
433433
file and the line number where the unused alias was defined.
434434
You may wish to comment out or remove the unused alias.
435-
.It Li Warning: cycle in {User,Runas,Host,Cmnd}_Alias
435+
.It Warning: cycle in {User,Runas,Host,Cmnd}_Alias
436436
The specified {User,Runas,Host,Cmnd}_Alias includes a reference to
437437
itself, either directly or through an alias it includes.
438438
The message is prefixed with the path name of the
@@ -448,7 +448,7 @@ will ignore cycles when parsing
448448
the
449449
.Em sudoers
450450
file.
451-
.It Li ignoring editor backup file
451+
.It ignoring editor backup file
452452
While processing a
453453
.Em @includedir
454454
or
@@ -461,7 +461,7 @@ Such files are skipped by
461461
.Nm sudo
462462
and
463463
.Nm .
464-
.It Li ignoring file name containing '.'
464+
.It ignoring file name containing '.'
465465
While processing a
466466
.Em @includedir
467467
or
@@ -473,7 +473,7 @@ Such files are skipped by
473473
.Nm sudo
474474
and
475475
.Nm .
476-
.It Li unknown defaults entry \&"name\&"
476+
.It unknown defaults entry \&"name\&"
477477
The
478478
.Em sudoers
479479
file contains a

0 commit comments

Comments
 (0)