2
0
mirror of https://github.com/sudo-project/sudo.git synced 2025-09-03 15:55:40 +00:00

closer to BSD manpage style

This commit is contained in:
Todd C. Miller
1995-04-09 23:24:08 +00:00
parent 40b035adc2
commit 83c9206185

View File

@@ -1,22 +1,23 @@
.\" $Id$
.TH VISUDO 8 .TH VISUDO 8
.SH NAME .SH NAME
visudo \- edit the sudoers file visudo \- edit the sudoers file
.SH SYNOPSIS .SH SYNOPSIS
.B visudo .B visudo
[-V] [
.B \-V
]
.SH DESCRIPTION .SH DESCRIPTION
.I visudo .B visudo
edits the edits the
.I sudoers .I sudoers
file in a safe fashion, analogous to file in a safe fashion, analogous to
.BR vipw (8). .BR vipw (8).
.I visudo .B visudo
locks the locks the
.I sudoers .I sudoers
file against multiple simultaneous edits, provides basic sanity checks, file against multiple simultaneous edits, provides basic sanity checks,
and guards against parse errors. If the and checks for parse errors. If the
.I sudoers .I sudoers
file is currently being edited you will receive a message to try file is currently being edited you will receive a message to try
again later. In the default configuration, the again later. In the default configuration, the
@@ -25,7 +26,7 @@ editor is used, but there is a compile time option to allow use
of whatever editor the environmental variables EDITOR or VISUAL are of whatever editor the environmental variables EDITOR or VISUAL are
set to. set to.
.sp .sp
.I visudo .B visudo
parses the parses the
.I sudoers .I sudoers
file after the edit and will not save the changes if there is a file after the edit and will not save the changes if there is a
@@ -37,39 +38,36 @@ the user may enter "e" to re-edit the
file, enter "x" to exit without saving the changes, or "q" to quit file, enter "x" to exit without saving the changes, or "q" to quit
and save changes. The "q" option should be used with extreme care and save changes. The "q" option should be used with extreme care
because if because if
.I visudo .B visudo
believes there to be a parse error, so will believes there to be a parse error, so will
.I sudo .B sudo
and no one will be able to execute sudo again until the error is and no one will be able to execute
fixed. Any other command at this prompt will print a short help message. .B sudo
When editing the again until the error is fixed. Any other command at this prompt will print
a short help message. When editing the
.I sudoers .I sudoers
file after a parse error has been detected the cursor will be placed on the file after a parse error has been detected the cursor will be placed on the
line where the error occurred (if the editor supports this feature). line where the error occurred (if the editor supports this feature).
.SH OPTIONS .SH OPTIONS
.I visudo .B visudo
accepts the following command line option: accepts the following command line option:
.IP -V .IP -V
The -V (version) option causes visudo to print the version number The -V (version) option causes visudo to print the version number
and exit. and exit.
.SH FILES .SH FILES
.nf .nf
/etc/sudoers file of authorized users. /etc/sudoers file of authorized users.
/etc/stmp lock file for visudo. /etc/stmp lock file for visudo.
.fi .fi
.SH ENVIRONMENT VARIABLES .SH ENVIRONMENT VARIABLES
The following are used only if The following are used only if
.I visudo .B visudo
was compiled with the ENV_EDITOR option: was compiled with the ENV_EDITOR option:
.nf .nf
EDITOR Used by visudo as the editor to use. EDITOR Used by visudo as the editor to use.
VISUAL Used by visudo if EDITOR is not set. VISUAL Used by visudo if EDITOR is not set.
.fi .fi
.SH AUTHOR .SH AUTHOR
Many people have worked on Many people have worked on
.I sudo .I sudo
@@ -82,23 +80,20 @@ Todd Miller <Todd.Miller@cs.colorado.edu>
See the HISTORY file in the sudo distribution for more details. See the HISTORY file in the sudo distribution for more details.
.fi .fi
.sp
Please send all bugs, comments, and changes to sudo-bugs@cs.colorado.edu. Please send all bugs, comments, and changes to sudo-bugs@cs.colorado.edu.
.SH DISCLAIMER .SH DISCLAIMER
This program is distributed in the hope that it will be useful, but This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details. General Public License for more details.
.sp
You should have received a copy of the GNU General Public License along You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc., with this program; if not, write to the Free Software Foundation, Inc.,
675 Mass Ave, Cambridge, MA 02139, USA. 675 Mass Ave, Cambridge, MA 02139, USA.
.SH CAVEATS .SH CAVEATS
There is no easy way to prevent a user from gaining a root shell if There is no easy way to prevent a user from gaining a root shell if
the editor used by visudo allows shell escapes. the editor used by visudo allows shell escapes.
.SH BUGS .SH BUGS
The The
.I -V .I -V
@@ -107,7 +102,6 @@ flag gives the version of the
package rather than the individual package rather than the individual
.I visudo .I visudo
program. program.
.SH SEE ALSO .SH SEE ALSO
.BR sudo (8), .BR sudo (8),
.BR vipw (8) .BR vipw (8)