doc: bos setrestricted -mode 0 does make sense

Commit 070230ab76 added documentation of
the mode parameter to bos setrestricted, claiming that the value 0 is
useless, and commit eee0bf5871 added
documentation of the restrictmode entry in BosConfig, claiming that it
can only be set back to 0 with an editor. Both claims are wrong, since
bos setrestricted -mode 0 will do exactly that (if it succeeds, which
it only can if the server is running in unrestricted mode, which can
be achieved by sending it the FPE signal). Fix the man pages
accordingly.

Reviewed-on: http://gerrit.openafs.org/10885
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Reviewed-by: Marc Dionne <marc.c.dionne@gmail.com>
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
Reviewed-by: D Brashear <shadow@your-file-system.com>
(cherry picked from commit da549eea21)

Change-Id: Iea8f252829ba6192176da0ceba464cbc41aad53c
Reviewed-on: http://gerrit.openafs.org/10955
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Tested-by: Stephan Wiesand <stephan.wiesand@desy.de>
Reviewed-by: Stephan Wiesand <stephan.wiesand@desy.de>
This commit is contained in:
Stephan Wiesand 2014-03-12 10:47:17 +01:00
parent d138114092
commit c4752dca43
2 changed files with 8 additions and 10 deletions

View File

@ -169,8 +169,6 @@ performs automatic process restarts.
=item *
The B<bos setrestricted> command to place the BOS Server in restricted mode.
Since there is no command to revert this, setting the C<restrictmode>
parameter back to 0 is only possible with an editor.
=item *

View File

@ -7,7 +7,7 @@ bos_setrestricted - place a server in restricted mode
=for html
<div class="synopsis">
B<bos setrestricted> S<<< B<-server> <I<machine name>> >>> S<<< B<-mode> 1 >>>
B<bos setrestricted> S<<< B<-server> <I<machine name>> >>> S<<< B<-mode> (0 | 1) >>>
S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
=for html
@ -27,9 +27,9 @@ is denied, and the use of B<bos getlog> is limited.
Once a server has been placed in restricted mode, it may not be opened up
again using a remote command. That is, B<bos setrestricted> has no method
of setting an unrestricted mode. Once a server is restricted, it can only
be opened up again by sending it a SIGFPE, which must be done as root on
the local machine.
of placing the server in unrestricted mode. Once a server is restricted,
it can only be opened up again by sending it a SIGFPE, which must be done
as root on the local machine.
=head1 OPTIONS
@ -42,10 +42,10 @@ Indicates the server machine to restrict.
=item B<-mode> <I<mode>>
Indicates whether to turn restricted mode off or on. Pass a 1 to turn
restricted mode on, and pass a 0 to turn restricted mode off. However, since
you cannot turn off restricted mode remotely on a server where restricted mode
is already on, trying to turn off restricted mode will always either fail, or
do nothing. So the only option that makes sense here is 1.
restricted mode on, and pass a 0 to turn restricted mode off. The latter
will only work if the server is already running in unrestricted mode, and
thus won't do anything immediately, but can be used to change the
corresponding entry in L<BosConfig(5)>.
=item B<-cell> <I<cell name>>