Changeset 25011 for trunk/console/scripts/console-config

Timestamp:

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

Author:

jhoblitt

Message:

docs cleanup

File:

• trunk/console/scripts/console-config (modified) (2 diffs)

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