Changeset 25011 for trunk/console/scripts

Timestamp:

Aug 6, 2009, 1:56:21 PM (17 years ago)

Author:

jhoblitt

Message:

docs cleanup

Location:

trunk/console/scripts

Files:

• console (modified) (3 diffs)
• console-config (modified) (2 diffs)
• console-ipp-defaults (modified) (2 diffs)

trunk/console/scripts/console

@@ -63 +63 @@
 =over 4
 
-=item * --db|-d <db name>
+=item * --user|-u
 
-Name of database (C<namespace>) to write too.
+The C<ssh> username to use when connecting to the console port.
 
-Optional if defined in the F<.nebdiskdrc> file or the appropriate environment
-variable is set.
-
-=item * --user|-u <db username>
-
-Username to authenticate with.
-
-Optional if defined in the F<.nebdiskdrc> file or the appropriate environment
-variable is set.
-
-=item * --pass|-p <db password>
-
-Password to authenticate with.
-
-Optional if defined in the F<.nebdiskdrc> file or the appropriate environment
-variable is set.
-
-=item * --debug
-
-This flag prevents the program from "daemonizing" so output can be sent to
-C<stdout>/C<stderr> and a debugger used on the running process.
-
-=item * --pidfile <filename>
-
-Filename to log the running daemon's PID too.
-
-Optional, if this option is omitted and no value is defined in the
-F<.nebdiskrc> then no pidfile is created.
-
-=item * --stop|-s
-
-Uses the pidfile to kill an already running daemon.
-
-=item * --restart|-r
-
-Uses the pidfile to kill an already running daemon and then starts a new
-instance.
-
-=item * --verbose|-r
+=item * --verbose|-v
 
 Turns on informational/debugging messages to be sent to the
-C<stderr>/C<stdout>.  This option is probably not very usefully unless combined
-with C<--debug>.
-
-=back
-
-=head1 ENVIRONMENT
-
-These environment variables may be used in place of the specified command line
-options.  All command line option will override the corresponding environment
-value.
-
-=over 4
-
-=item * C<NEB_DB>
-
-Equivalent to --db|-d
-
-=item * C<NEB_USER>
-
-Equivalent to --user|-u
-
-=item * C<NEB_PASS>
-
-Equivalent to --pass|-p 
+C<stderr>/C<stdout>.
 
 =back
@@ -137 +76 @@
 =head1 RCFILE
 
-This program will attempt to read an C<rcfile> from F<$HOME/.nebdiskrc> and if
-found will use it's values to override program defaults.  Please not that the
-precedence for values is: command line, rcfile, environment variables.
-
-The format of the C<rcfile> is in L<YAML> format and uses the following values:
-
-    ---
-    db: nebulous
-    dbpass: '@neb@'
-    dbuser: nebulous
-    mounts:
-      - /mnt
-      - /tmp
-      - /usr
-    pidfile: /var/tmp/nebdiskd
-    poll_interval: 5
-
-The values C<db>, C<dbpass>, C<dbuser>, and C<pidfile> have the same semantics
-as their command line and/or environment variable equivalents.
-
-=over 4
-
-=item * C<mounts>
-
-A list of "paths" to C<stat(2)> before mounted volumes are polled.  The propose
-of this option is to attempt to keep "automounted" volumes mounted while this
-program is running.
-
-This value may be omitted or left blank.
-
-=item * C<poll_interval>
-
-The number of seconds to wait between checks for mounted volumes.
-
-This value may be omitted or left blank.  The default value is C<60>s.
-
-=back
+This program will attempt to read an C<rcfile> from F<$HOME/.Consolerc>.
 
 =head1 CREDITS
@@ -209 +112 @@
 =head1 SEE ALSO
 
-L<Config::YAML>
+L<Config::YAML>, L<Console>, L<console-config>, L<console-ipp-defaults>
 
 =cut

trunk/console/scripts/console-config

@@ -152 +152 @@
 =head1 RCFILE
 
-This program will attempt to read an C<rcfile> from F<$HOME/.Consolerc>
-
-The format of the C<rcfile> is in L<YAML> format and uses the following values:
-
-    ---
-    db: nebulous
-    dbpass: '@neb@'
-    dbuser: nebulous
-    mounts:
-      - /mnt
-      - /tmp
-      - /usr
-    pidfile: /var/tmp/nebdiskd
-    poll_interval: 5
-
-The values C<db>, C<dbpass>, C<dbuser>, and C<pidfile> have the same semantics
-as their command line and/or environment variable equivalents.
-
-=over 4
-
-=item * C<mounts>
-
-A list of "paths" to C<stat(2)> before mounted volumes are polled.  The propose
-of this option is to attempt to keep "automounted" volumes mounted while this
-program is running.
-
-This value may be omitted or left blank.
-
-=item * C<poll_interval>
-
-The number of seconds to wait between checks for mounted volumes.
-
-This value may be omitted or left blank.  The default value is C<60>s.
-
-=back
+This program will attempt to read an C<rcfile> from F<$HOME/.Consolerc>.
 
 =head1 CREDITS
@@ -222 +188 @@
 =head1 SEE ALSO
 
-L<Config::YAML>
+L<Config::YAML>, L<Console>, L<console>, L<console-ipp-defaults>
 
 =cut

trunk/console/scripts/console-ipp-defaults

@@ -139 +139 @@
 =over 4
 
-=item * --verbose|-r
+=item * --verbose|-v
 
 Turns on informational/debugging messages to be sent to the
@@ -180 +180 @@
 =head1 SEE ALSO
 
-L<Config::YAML>, L<Console>
+L<Config::YAML>, L<Console>, L<console>, L<console-config>
 
 =cut