patch to document showtrans and fsysopts

[James A Morrison]

2002-02-11     James A. Morrison <ja2morri@student.math.uwaterloo.ca>

         * hurd.texi (Translators): Document the options for showtrans and
         fsystops.

Index: hurd.texi
===================================================================
RCS file: /cvsroot/hurd/hurd/doc/hurd.texi,v
retrieving revision 1.20
diff -u -r1.20 hurd.texi
--- hurd.texi   12 Mar 2001 00:43:50 -0000      1.20
+++ hurd.texi   9 Feb 2002 22:34:29 -0000
@@ -2136,14 +2221,101 @@
 @end table
 
 
-FIXME: finish
+@c FIXME: finish
+@c JM: I think I finished this
 @node Invoking showtrans
 @subsection Invoking @code{showtrans}
+
+The @code{showtrans} program allows you to the passive translator(s) on a file
+or directory.  
+
+The @code{showtrans} program has the following synopsis:
+
+@example
+showtrans [@var{option}]@dots{} @var{file}@dots{}
+@end example
+
+@code{showtrans} accepts the following options:
+
+@table @code
+@item -p
+@itemx --prefix
+Always display @var{filename}: before translators
+
+@item -P
+@itemx --no-prefix
+Never display @var{filename}: before translators
+@item -s
+@itemx --silent
+No output; useful when checking error status
+@item -t
+@itemx --translated
+Only display files that have translators
+
+@item -?
+@itemx --help
+Give a helpful list of options
+
+@item --usage
+Give a short usage message
+
+@item -V
+@itemx --version
+Print program version
+
+@end table
 @node Invoking mount
 @subsection Invoking @code{mount}
 @node Invoking fsysopts
 @subsection Invoking @code{fsysopts}
 
+The @code{fsysopts} program allows you to get or set command line options for 
+running translator @var{filesys}.
+
+The @code{fsysopts} program has the following synopsis:
+
+@example
+fsysopts [@var{option}@dots{}] @var{filesys} [@var{fs_option}@dots{}]
+@end example
+
+@code{fsysopts} accepts the following options:
+
+@table @code
+
+@item -L
+@itemx --dereference
+If @var{filesys} is a symbolic link, follow it
+
+@item -R
+@itemx --recursive
+Pass these options to any child translators
+
+@item -?
+@itemx --help
+Gives a help list
+
+@item --usage
+Give a short usage message
+
+@item -V
+@itemx --version
+Print program version
+
+@end table
+The legal values for @var{fs_option} depends on @var{filesys}, but some 
+common ones are:
+
+@table @code
+
+@item --readonly
+@item --writable
+@item --remount
+@item --sync[=@var{interval}]
+@item --nosync
+
+@end table
+
+If no options are supplied, @var{filesys}'s existing options are printed
 
 @node Trivfs Library
 @section Trivfs Library