* even more work on consolidating the PODs. Hopefully, I'm finished now...

git-svn-id: http://svn.openslx.org/svn/openslx/trunk@858 95ad53e4-c205-0410-b2fa-d234c58c8868

1 files changed, 58 insertions, 44 deletions

diff --git a/config-db/slxsettings b/config-db/slxsettings
index 0189123e..4a57307c 100755
--- a/config-db/slxsettings
+++ b/config-db/slxsettings
@@ -157,13 +157,10 @@ slxsettings - OpenSLX-script to show & change local settings
 
 =head1 SYNOPSIS
 
-slxsettings [options]
+slxsettings [options] [action ...]
 
-  Script Options:
-      --quiet                    do not print anything
-      --remove=<string>          remove given key from settings
+=head3 OpenSLX Options
 
-  OpenSLX Options:
       --base-path=<string>       basic path to project files
       --bin-path=<string>        path to binaries and scripts
       --config-path=<string>     path to configuration files
@@ -182,137 +179,152 @@ slxsettings [options]
       --tftpboot-path=<string>   path to root of tftp-server
       --verbose-level=<int>      level of logging verbosity (0-3)
 
-  General Options:
+=head3 General Options
+
       --help                     brief help message
       --man                      full documentation
+      --quiet                    do not print anything
       --verbose                  show more information
       --version                  show version
 
-=head1 OPTIONS
-
-=head3 Script Options
+=head3 Actions
 
 =over 8
 
-=item B<--quiet>
+=item B<<     <openslx-option>=<value> >>
 
-Runs the script without printing anything.
+sets the specified openslx-option (without the leading '--') to the given value
 
-=item B<--remove=<string>>
+=item B<<     remove=<openslx-option> >>
 
-Removes given key from settings (apply more than once to remove several keys).
+removes given openslx-option (sets it to an empty string)
 
-=item B<--verbose>
-
-Prints the resulting settings after changes have been applied.
 =back
 
+=head1 DESCRIPTION
+
+B<slxsettings> can be used to show or change the local settings for OpenSLX.
+
+Any cmdline-argument passed to this script will change the local OpenSLX
+settings file (usually /etc/opt/openslx/settings.local).
+
+If you invoke the script without any arguments, it will print the current
+settings and exit.
+
+=head1 OPTIONS
+
 =head3 OpenSLX Options
 
 =over 8
 
-=item B<--base-path=<string>>
+=item B<<     --base-path=<string> >>
 
 Sets basic path to project files.
 
 Default is $SLX_BASE_PATH (usually F</opt/openslx>).
 
-=item B<--bin-path=<string>>
+=item B<<     --bin-path=<string> >>
 
 Sets path to binaries and scripts.
 
 Default is $SLX_BASE_PATH/bin (usually F</opt/openslx/bin>).
 
-=item B<--config-path=<string>>
+=item B<<     --config-path=<string> >>
 
 Sets path to configuration files.
 
 Default is $SLX_CONFIG_PATH (usually F</etc/opt/openslx>).
 
-=item B<--db-basepath=<string>>
+=item B<<     --db-basepath=<string> >>
 
 Sets basic path to openslx database.
 
 Default is $SLX_DB_PATH (usually F</var/opt/openslx/db>).
 
-=item B<--db-datadir=<string>>
+=item B<<     --db-datadir=<string> >>
 
 Sets data folder created under db-basepath.
 
 Default is $SLX_DB_DATADIR (usually empty as it depends on db-type
 whether or not such a directory is required at all).
 
-=item B<--db-name=<string>>
+=item B<<     --db-name=<string> >>
 
 Gives the name of the database to connect to.
 
 Default is $SLX_DB_NAME (usually C<openslx>).
 
-=item B<--db-spec=<string>>
+=item B<<     --db-spec=<string> >>
 
 Gives the full DBI-specification of database to connect to. Content depends
 on the db-type.
 
 Default is $SLX_DB_SPEC (usually empty as it will be built automatically).
 
-=item B<--db-type=<string>>
+=item B<<     --db-type=<string> >>
 
 Sets the type of database to connect to (CSV, SQLite, mysql, ...).
 
 Default $SLX_DB_TYPE (usually C<CSV>).
 
-=item B<--export-path=<string>>
+=item B<<     --export-path=<string> >>
 
 Sets path to root of all exported filesystems. For each type of export (NFS,
 NBD, ...) a separate folder will be created in here.
 
 Default is $SLX_EXPORT_PATH (usually F</srv/openslx/export>.
 
-=item B<--locale=<string>>
+=item B<<     --locale=<string> >>
 
 Sets the locale to use for translations.
 
 Defaults to the system's standard locale.
 
-=item B<--logfile=<string>>
+=item B<<     --logfile=<string> >>
 
 Specifies a file where logging output will be written to.
 
 Default is to log to STDERR.
 
-=item B<--private-path=<string>>
+=item B<<     --private-path=<string> >>
 
 Sets path to private data, where the config-db, vendor_oses and configurational
 extensions will be stored.
 
 Default is $SLX_PRIVATE_PATH (usually F</var/opt/openslx>.
 
-=item B<--public-path=<string>>
+=item B<<     --public-path=<string> >>
 
 Sets path to public (client-accesible) data.
 
 Default is $SLX_PUBLIC_PATH (usually F</srv/openslx>.
 
-=item B<--share-path=<string>>
+=item B<<     --share-path=<string> >>
 
 Sets path to sharable data, where distro-specs and functionality templates
 will be stored.
 
 Default is $SLX_SHARE_PATH (usually F</opt/openslx/share>.
 
-=item B<--temp-path=<string>>
+=item B<<     --stage1-path=<string> >>
+
+Sets path to stage1 systems, where distributor-systems will be installed.
+
+Default is $SLX_STAGE1_PATH (usually F</var/opt/openslx/stage1>.
+
+=item B<<     --temp-path=<string> >>
 
 Sets path to temporary data.
 
 Default is $SLX_TEMP_PATH (usually F</tmp>.
 
-=item B<--tftpboot-path=<string>>
+=item B<<     --tftpboot-path=<string> >>
 
 Sets path to root of tftp-server from which clients will access their files.
 
 Default is $SLX_TFTPBOOT_PATH (usually F</srv/openslx/tftpboot>.
 
-=item B<--verbose-level=<int>>
+=item B<<     --verbose-level=<int> >>
 
 Sets the level of logging verbosity (0-3).
 
@@ -324,26 +336,28 @@ Default is $SLX_VERBOSE_LEVEL (usually 0, no logging).
 
 =over 8
 
-=item B<--help>
+=item B<    --help>
 
 Prints a brief help message and exits.
 
-=item B<--man>
+=item B<    --man>
 
 Prints the manual page and exits.
 
-=item B<--version>
+=item B<    --quiet>
 
-Prints the version and exits.
+Runs the script without printing anything.
 
-=back
+=item B<    --verbose>
 
-=head1 DESCRIPTION
+Prints the resulting settings after changes have been applied.
 
-B<slxsetup.pl> can be used to show or change the local settings for OpenSLX.
+=item B<    --version>
 
-Any cmdline-argument passed to this script will change the local OpenSLX
-settings file (usually /etc/opt/openslx/settings.local).
+Prints the version and exits.
 
-If you invoke the script without any arguments, it will print the current
-settings and exit.
+=back
+
+=head1 SEE ALSO
+
+slxos-setup, slxos-export, slxconfig, slxconfig-demuxer
\ No newline at end of file