From c4752dca439a12c2be162eb98869ef37d7c43767 Mon Sep 17 00:00:00 2001 From: Stephan Wiesand Date: Wed, 12 Mar 2014 10:47:17 +0100 Subject: [PATCH] doc: bos setrestricted -mode 0 does make sense Commit 070230ab76e1df338db3f2a7971111ca976a0c1a added documentation of the mode parameter to bos setrestricted, claiming that the value 0 is useless, and commit eee0bf5871944d919951cc8b7b4908ee909c3b62 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 Reviewed-by: Benjamin Kaduk Reviewed-by: Marc Dionne Reviewed-by: Andrew Deason Reviewed-by: Michael Meffie Reviewed-by: D Brashear (cherry picked from commit da549eea21941681c075796512a27a830259c835) Change-Id: Iea8f252829ba6192176da0ceba464cbc41aad53c Reviewed-on: http://gerrit.openafs.org/10955 Reviewed-by: Andrew Deason Tested-by: Stephan Wiesand Reviewed-by: Stephan Wiesand --- doc/man-pages/pod5/BosConfig.pod | 2 -- doc/man-pages/pod8/bos_setrestricted.pod | 16 ++++++++-------- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/doc/man-pages/pod5/BosConfig.pod b/doc/man-pages/pod5/BosConfig.pod index b991bd3258..e17278901d 100644 --- a/doc/man-pages/pod5/BosConfig.pod +++ b/doc/man-pages/pod5/BosConfig.pod @@ -169,8 +169,6 @@ performs automatic process restarts. =item * The B command to place the BOS Server in restricted mode. -Since there is no command to revert this, setting the C -parameter back to 0 is only possible with an editor. =item * diff --git a/doc/man-pages/pod8/bos_setrestricted.pod b/doc/man-pages/pod8/bos_setrestricted.pod index 82fc886444..1880f4d6ed 100644 --- a/doc/man-pages/pod8/bos_setrestricted.pod +++ b/doc/man-pages/pod8/bos_setrestricted.pod @@ -7,7 +7,7 @@ bos_setrestricted - place a server in restricted mode =for html
-B S<<< B<-server> > >>> S<<< B<-mode> 1 >>> +B S<<< B<-server> > >>> S<<< B<-mode> (0 | 1) >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] [B<-help>] =for html @@ -27,9 +27,9 @@ is denied, and the use of B 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 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> > 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. =item B<-cell> >