Annotation of embedaddon/sudo/doc/visudo.man.in, revision 1.1.1.5
1.1.1.3 misho 1: .\" DO NOT EDIT THIS FILE, IT IS NOT THE MASTER!
2: .\" IT IS GENERATED AUTOMATICALLY FROM visudo.mdoc.in
3: .\"
1.1.1.5 ! misho 4: .\" Copyright (c) 1996,1998-2005, 2007-2013
1.1.1.3 misho 5: .\" Todd C. Miller <Todd.Miller@courtesan.com>
6: .\"
1.1 misho 7: .\" Permission to use, copy, modify, and distribute this software for any
8: .\" purpose with or without fee is hereby granted, provided that the above
9: .\" copyright notice and this permission notice appear in all copies.
1.1.1.3 misho 10: .\"
1.1 misho 11: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18: .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.1.1.3 misho 19: .\"
1.1 misho 20: .\" Sponsored in part by the Defense Advanced Research Projects
21: .\" Agency (DARPA) and Air Force Research Laboratory, Air Force
22: .\" Materiel Command, USAF, under agreement number F39502-99-1-0512.
23: .\"
1.1.1.5 ! misho 24: .TH "VISUDO" "@mansectsu@" "August 14, 2013" "Sudo @PACKAGE_VERSION@" "System Manager's Manual"
1.1 misho 25: .nh
1.1.1.3 misho 26: .if n .ad l
1.1 misho 27: .SH "NAME"
1.1.1.3 misho 28: \fBvisudo\fR
29: \- edit the sudoers file
1.1 misho 30: .SH "SYNOPSIS"
1.1.1.3 misho 31: .HP 7n
32: \fBvisudo\fR
33: [\fB\-chqsV\fR]
34: [\fB\-f\fR\ \fIsudoers\fR]
1.1 misho 35: .SH "DESCRIPTION"
1.1.1.3 misho 36: \fBvisudo\fR
37: edits the
38: \fIsudoers\fR
39: file in a safe fashion, analogous to
40: vipw(@mansectsu@).
41: \fBvisudo\fR
42: locks the
43: \fIsudoers\fR
44: file against multiple simultaneous edits, provides basic sanity checks,
45: and checks for parse errors.
46: If the
47: \fIsudoers\fR
48: file is currently being edited you will receive a message to try again later.
1.1 misho 49: .PP
1.1.1.3 misho 50: There is a hard-coded list of one or more editors that
51: \fBvisudo\fR
52: will use set at compile-time that may be overridden via the
53: \fIeditor\fR
54: \fIsudoers\fR
55: \fRDefault\fR
56: variable.
57: This list defaults to
58: \fR@editor@\fR.
59: Normally,
60: \fBvisudo\fR
61: does not honor the
62: \fRVISUAL\fR
63: or
64: \fREDITOR\fR
65: environment variables unless they contain an editor in the aforementioned
66: editors list.
67: However, if
68: \fBvisudo\fR
69: is configured with the
70: \fR--with-env-editor\fR
71: option or the
72: \fIenv_editor\fR
73: \fRDefault\fR
74: variable is set in
75: \fIsudoers\fR,
76: \fBvisudo\fR
77: will use any the editor defines by
78: \fRVISUAL\fR
79: or
80: \fREDITOR\fR.
1.1 misho 81: Note that this can be a security hole since it allows the user to
1.1.1.3 misho 82: execute any program they wish simply by setting
83: \fRVISUAL\fR
84: or
85: \fREDITOR\fR.
1.1 misho 86: .PP
1.1.1.3 misho 87: \fBvisudo\fR
88: parses the
89: \fIsudoers\fR
90: file after the edit and will
91: not save the changes if there is a syntax error.
92: Upon finding an error,
93: \fBvisudo\fR
94: will print a message stating the line number(s)
1.1 misho 95: where the error occurred and the user will receive the
1.1.1.5 ! misho 96: ``What now?''
1.1.1.3 misho 97: prompt.
98: At this point the user may enter
1.1.1.5 ! misho 99: `e'
1.1.1.3 misho 100: to re-edit the
101: \fIsudoers\fR
102: file,
1.1.1.5 ! misho 103: `x'
1.1.1.3 misho 104: to exit without saving the changes, or
1.1.1.5 ! misho 105: `Q'
1.1.1.3 misho 106: to quit and save changes.
107: The
1.1.1.5 ! misho 108: `Q'
1.1.1.3 misho 109: option should be used with extreme care because if
110: \fBvisudo\fR
111: believes there to be a parse error, so will
112: \fBsudo\fR
113: and no one
114: will be able to
115: \fBsudo\fR
116: again until the error is fixed.
117: If
1.1.1.5 ! misho 118: `e'
1.1.1.3 misho 119: is typed to edit the
120: \fIsudoers\fR
121: file after a parse error has been detected, the cursor will be placed on
122: the line where the error occurred (if the editor supports this feature).
123: .PP
124: The options are as follows:
125: .TP 12n
1.1.1.5 ! misho 126: \fB\-c\fR, \fB\--check\fR
1.1.1.3 misho 127: Enable
128: \fIcheck-only\fR
129: mode.
130: The existing
131: \fIsudoers\fR
132: file will be
133: checked for syntax errors, owner and mode.
134: A message will be printed to the standard output describing the status of
135: \fIsudoers\fR
136: unless the
137: \fB\-q\fR
138: option was specified.
139: If the check completes successfully,
140: \fBvisudo\fR
141: will exit with a value of 0.
142: If an error is encountered,
143: \fBvisudo\fR
144: will exit with a value of 1.
145: .TP 12n
1.1.1.5 ! misho 146: \fB\-f\fR \fIsudoers\fR, \fB\--file\fR=\fIsudoers\fR
1.1.1.4 misho 147: Specify an alternate
1.1.1.3 misho 148: \fIsudoers\fR
149: file location.
1.1.1.5 ! misho 150: With this option,
1.1.1.3 misho 151: \fBvisudo\fR
152: will edit (or check) the
153: \fIsudoers\fR
154: file of your choice,
155: instead of the default,
156: \fI@sysconfdir@/sudoers\fR.
157: The lock file used is the specified
158: \fIsudoers\fR
159: file with
1.1.1.5 ! misho 160: ``\.tmp''
1.1.1.3 misho 161: appended to it.
162: In
163: \fIcheck-only\fR
164: mode only, the argument to
165: \fB\-f\fR
166: may be
1.1.1.5 ! misho 167: `-',
1.1.1.3 misho 168: indicating that
169: \fIsudoers\fR
170: will be read from the standard input.
171: .TP 12n
1.1.1.5 ! misho 172: \fB\-h\fR, \fB\--help\fR
! 173: Display a short help message to the standard output and exit.
1.1.1.3 misho 174: .TP 12n
1.1.1.5 ! misho 175: \fB\-q\fR, \fB\--quiet\fR
1.1.1.3 misho 176: Enable
177: \fIquiet\fR
178: mode.
179: In this mode details about syntax errors are not printed.
180: This option is only useful when combined with
181: the
182: \fB\-c\fR
183: option.
184: .TP 12n
1.1.1.5 ! misho 185: \fB\-s\fR, \fB\--strict\fR
1.1.1.3 misho 186: Enable
187: \fIstrict\fR
188: checking of the
189: \fIsudoers\fR
190: file.
191: If an alias is used before it is defined,
192: \fBvisudo\fR
193: will consider this a parse error.
194: Note that it is not possible to differentiate between an
1.1 misho 195: alias and a host name or user name that consists solely of uppercase
1.1.1.3 misho 196: letters, digits, and the underscore
1.1.1.5 ! misho 197: (`_')
1.1.1.3 misho 198: character.
199: .TP 12n
1.1.1.5 ! misho 200: \fB\-V\fR, \fB\--version\fR
! 201: Print the
1.1.1.3 misho 202: \fBvisudo\fR
1.1.1.5 ! misho 203: and
! 204: \fIsudoers\fR
! 205: grammar versions and exit.
1.1 misho 206: .SH "ENVIRONMENT"
207: The following environment variables may be consulted depending on
1.1.1.3 misho 208: the value of the
209: \fIeditor\fR
210: and
211: \fIenv_editor\fR
212: \fIsudoers\fR
213: settings:
214: .TP 17n
215: \fRVISUAL\fR
216: Invoked by
217: \fBvisudo\fR
218: as the editor to use
219: .TP 17n
220: \fREDITOR\fR
221: Used by
222: \fBvisudo\fR
223: if
224: \fRVISUAL\fR
225: is not set
1.1 misho 226: .SH "FILES"
1.1.1.3 misho 227: .TP 26n
228: \fI@sysconfdir@/sudoers\fR
1.1 misho 229: List of who can run what
1.1.1.3 misho 230: .TP 26n
231: \fI@sysconfdir@/sudoers.tmp\fR
1.1 misho 232: Lock file for visudo
233: .SH "DIAGNOSTICS"
1.1.1.3 misho 234: .TP 6n
235: \fRsudoers file busy, try again later.\fR
236: Someone else is currently editing the
237: \fIsudoers\fR
238: file.
239: .TP 6n
240: \fR@sysconfdir@/sudoers.tmp: Permission denied\fR
241: You didn't run
242: \fBvisudo\fR
243: as root.
244: .TP 6n
245: \fRCan't find you in the passwd database\fR
246: Your user ID does not appear in the system passwd file.
247: .TP 6n
248: \fRWarning: {User,Runas,Host,Cmnd}_Alias referenced but not defined\fR
249: Either you are trying to use an undeclared {User,Runas,Host,Cmnd}_Alias
1.1 misho 250: or you have a user or host name listed that consists solely of
1.1.1.3 misho 251: uppercase letters, digits, and the underscore
1.1.1.5 ! misho 252: (`_')
1.1.1.3 misho 253: character.
254: In the latter case, you can ignore the warnings
255: (\fBsudo\fR
256: will not complain)
257: \&.
258: In
259: \fB\-s\fR
260: (strict) mode these are errors, not warnings.
261: .TP 6n
262: \fRWarning: unused {User,Runas,Host,Cmnd}_Alias\fR
1.1 misho 263: The specified {User,Runas,Host,Cmnd}_Alias was defined but never
1.1.1.3 misho 264: used.
265: You may wish to comment out or remove the unused alias.
266: In
267: \fB\-s\fR
268: (strict) mode this is an error, not a warning.
269: .TP 6n
270: \fRWarning: cycle in {User,Runas,Host,Cmnd}_Alias\fR
1.1 misho 271: The specified {User,Runas,Host,Cmnd}_Alias includes a reference to
1.1.1.3 misho 272: itself, either directly or through an alias it includes.
273: This is only a warning by default as
274: \fBsudo\fR
275: will ignore cycles when parsing
276: the
277: \fIsudoers\fR
278: file.
1.1 misho 279: .SH "SEE ALSO"
1.1.1.3 misho 280: vi(1),
281: sudoers(@mansectform@),
282: sudo(@mansectsu@),
283: vipw(@mansectsu@)
284: .SH "AUTHORS"
285: Many people have worked on
286: \fBsudo\fR
287: over the years; this version consists of code written primarily by:
288: .sp
289: .RS 6n
290: Todd C. Miller
291: .RE
1.1 misho 292: .PP
1.1.1.3 misho 293: See the CONTRIBUTORS file in the
294: \fBsudo\fR
295: distribution (http://www.sudo.ws/sudo/contributors.html) for an
296: exhaustive list of people who have contributed to
297: \fBsudo\fR.
1.1 misho 298: .SH "CAVEATS"
1.1.1.3 misho 299: There is no easy way to prevent a user from gaining a root shell if
300: the editor used by
301: \fBvisudo\fR
302: allows shell escapes.
1.1 misho 303: .SH "BUGS"
1.1.1.3 misho 304: If you feel you have found a bug in
305: \fBvisudo\fR,
306: please submit a bug report at http://www.sudo.ws/sudo/bugs/
1.1 misho 307: .SH "SUPPORT"
308: Limited free support is available via the sudo-users mailing list,
1.1.1.3 misho 309: see http://www.sudo.ws/mailman/listinfo/sudo-users to subscribe or
1.1 misho 310: search the archives.
311: .SH "DISCLAIMER"
1.1.1.3 misho 312: \fBvisudo\fR
313: is provided
1.1.1.5 ! misho 314: ``AS IS''
1.1.1.3 misho 315: and any express or implied warranties, including, but not limited
316: to, the implied warranties of merchantability and fitness for a
317: particular purpose are disclaimed.
318: See the LICENSE file distributed with
319: \fBsudo\fR
320: or http://www.sudo.ws/sudo/license.html for complete details.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to visudo.man.in CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / sudo / doc