* more POD consolidation

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

1 files changed, 103 insertions, 76 deletions

diff --git a/config-db/slxconfig b/config-db/slxconfig
index e23552b3..bea096fd 100755
--- a/config-db/slxconfig
+++ b/config-db/slxconfig
@@ -547,7 +547,7 @@ and you can create clients for that system, too.
 
 slxconfig [options] <action> <key-value-pairs>
 
-=head2 OpenSLX Options
+=head3 OpenSLX Options
 
     --base-path=<string>       basic path to project files
     --bin-path=<string>        path to binaries and scripts
@@ -568,61 +568,59 @@ slxconfig [options] <action> <key-value-pairs>
     --tftpboot-path=<string>   path to root of tftp-server
     --verbose-level=<int>      level of logging verbosity (0-3)
 
-=head2 General Options
+=head3 General Options
 
     --help                     brief help message
     --man                      show full documentation
     --verbose                  be more verbose
     --version                  show version
 
-=head2 Actions
+=head3 Actions
 
-=over 4
+=over 8
 
-add-client name=<client-name> mac=<MAC> [<key>=<value> ...]
+=item B<<     add-client name=<client-name> mac=<MAC> [<key>=<value> ...] >>
 
-    adds a new client to the config-DB
+adds a new client to the config-DB
 
-add-system name=<system-name> [export=<export-name>] \
-           [<key>=<value> ...]
+=item B<<     add-system name=<system-name> [export=<export-name>] \ >>
 
-    adds a new system to the config-DB
+=item B<<                <key>=<value> ...] >>
 
-change-client name=<client-name> [<key>=<value> ...]
+adds a new system to the config-DB
 
-    changes the data of an existing system in the config-DB
+=item B<<     change-client name=<client-name> [<key>=<value> ...] >>
 
-change-system name=<system-name> [<key>=<value> ...]
+changes the data of an existing system in the config-DB
 
-    changes the data of an exiisting system in the config-DB
+=item B<<     change-system name=<system-name> [<key>=<value> ...] >>
 
-list-clients [<key>=<value> ...]
+changes the data of an exiisting system in the config-DB
 
-    lists all clients in config-DB (optionally matching given
-    criteria)
+=item B<<     list-clients [<key>=<value> ...] >>
 
-list-exports [<key>=<value> ...]
+lists all clients in config-DB (optionally matching given criteria)
 
-    lists all exports in config-DB (optionally matching given
-    criteria)
+=item B<<     list-exports [<key>=<value> ...] >>
 
-list-systems [<key>=<value> ...]
+lists all exports in config-DB (optionally matching given criteria)
 
-    lists all systems in config-DB (optionally matching given
-    criteria)
+=item B<<     list-systems [<key>=<value> ...] >>
 
-list-vendoroses [<key>=<value> ...]
+lists all systems in config-DB (optionally matching given
+criteria)
 
-    lists all vendor-OSes in config-DB (optionally matching given
-    criteria)
+=item B<<     list-vendoroses [<key>=<value> ...] >>
 
-remove-client name=<client-name>
+lists all vendor-OSes in config-DB (optionally matching given criteria)
 
-    removes a client from the config-DB
+=item B<<     remove-client name=<client-name> >>
 
-remove-system name=<system-name>
+removes a client from the config-DB
 
-    removes a system from the config-DB
+=item B<<     remove-system name=<system-name> >>
+
+removes a system from the config-DB
 
 =back
 
@@ -630,116 +628,116 @@ remove-system name=<system-name>
 
 =head3 OpenSLX Options
 
-=over 4
+=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<--stage1-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>>
+=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).
 
@@ -749,21 +747,21 @@ Default is $SLX_VERBOSE_LEVEL (usually 0, no logging).
 
 =head3 General Options
 
-=over 4
+=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<--verbose>
+=item B<<     --verbose >>
 
 Prints more information during execution of any action.
 
-=item B<--version>
+=item B<<     --version >>
 
 Prints the version and exits.
 
@@ -773,100 +771,129 @@ Prints the version and exits.
 
 =head3 Listing existing Clients / Exports / Systems / Vendor-OSes
 
-=item B<slxconfig list-client>
+=over 8
+
+=item B<<     slxconfig list-client >>
 
-=item B<slxconfig list-export>
+=item B<<     slxconfig list-export >>
 
-=item B<slxconfig list-system>
+=item B<<     slxconfig list-system >>
 
-=item B<slxconfig list-vendoros>
+=item B<<     slxconfig list-vendoros >>
 
 lists all existing instances of the respective DB-objects.
 
-=item B<slxconfig list-client id=3>
+=item B<<     slxconfig list-client id=3 >>
 
 lists the client with id=3
 
-=item B<slxconfig list-export type=nfs>
+=item B<<     slxconfig list-export type=nfs >>
 
-lists the client with id=3
+lists the exports of type 'nfs'
+
+=back
 
 =head3 Adding a new System to an exported Vendor-OS
 
-=item B<slxconfig add-system name=debian-4.0>
+=over 8
+
+=item B<<     slxconfig add-system name=debian-4.0 >>
 
 adds a new system named 'debian-4.0' to the config-DB that will
 use the export of the same name. No client will be associated
 with this system, yet.
 
-=item B<slxconfig add-system name=suse-10.1 export-name=suse-10.1-kde \
-                         clients=PC131,PC132,PC133 label="Linux Desktop">
+=item B<<     slxconfig add-system name=suse-10.1 export-name=suse-10.1-kde \ >>
+
+=item B<<                          clients=PC131,PC132,PC133 \ >>
+
+=item B<<                          label="Linux Desktop" >>
 
 adds a new system name 'suse-10.1' to the config-DB that will
 use the export named 'suse-10.1-kde'. The system will be labeled
 'Linux Desktop' and the clients 'PC131, 'PC132' and 'PC133' are
 associated with this system (so they can boot it).
 
+=back
+
 =head3 Adding a new Client
 
-=item B<slxconfig add-client name=vmware-1 mac=01:02:03:04:05:06>
+=over 8
+
+=item B<<     slxconfig add-client name=vmware-1 mac=01:02:03:04:05:06 >>
 
 adds a new client named 'vmware-1', being identified by the MAC
 '01:02:03:04:05:06' to the config-DB. No system will be
 associated with this client, yet (so it can't boot anything).
 
-=item B<slxconfig add-client name=vmware-1 mac=01:02:03:04:05:06
-						systems=suse-10.1,debian-4.0 \
-						attr_start_x=no>
+=item B<<     slxconfig add-client name=vmware-1 mac=01:02:03:04:05:06 \ >>
+
+=item B<<                          systems=suse-10.1,debian-4.0 \ >>
+
+=item B<<                          attr_start_x=no >>
 
 adds a new client named 'vmware-1', being identified by the MAC
 '01:02:03:04:05:06' to the config-DB. The systems 'suse-10.1' &
 'Debian-4.0' will be associated with this client (so it will
 offer these systems for booting).
 
-During boot, the X-subsystem will not be started by this client
+During boot, the X-server will not be started by this client
 (so the systems will stay in console mode).
 
+=back
+
 =head3 Changing a System
 
-=item B<slxconfig change-system name=suse-10.1 attr_start_xdmcp=gnome>
+=over 8
+
+=item B<<     slxconfig change-system name=suse-10.1 attr_start_xdmcp=gnome >>
 
 will change the system named 'suse-10.1' such that it will use
 the GNOME session manager.
 
-=item B<slxconfig change-system name=suse-10.1 add-clients=vmware-1>
+=item B<<     slxconfig change-system name=suse-10.1 add-clients=vmware-1 >>
 
 will associate the client 'vmware-1' with the system named
 'suse-10.1'.
 
-=item B<slxconfig change-system name=suse-10.1 remove-clients=vmware-1>
+=item B<<     slxconfig change-system name=suse-10.1 remove-clients=vmware-1 >>
 
 will remove the client 'vmware-1' from the system named
 'suse-10.1'.
 
+=back
+
 =head3 Changing a Client
 
-=item B<slxconfig change-client name=PC131 attr_start_snmp=yes>
+=over 8
+
+=item B<<     slxconfig change-client name=PC131 attr_start_snmp=yes >>
 
 will change the client named 'PC131' such that it will start
 the SNMP daemon on all systems that it boots.
 
-=item B<slxconfig change-client name=PC131 add-systems=Debian-4.0>
+=item B<<     slxconfig change-client name=PC131 add-systems=Debian-4.0 >>
 
 will associate the system 'Debian-4.0' with the client named
 'PC131'.
 
-=item B<slxconfig change-client name=PC131 remove-systems=Debian-4.0>
+=item B<<     slxconfig change-client name=PC131 remove-systems=Debian-4.0 >>
 
 will remove the system 'Debian-4.0' from the client named
 'PC131'.
 
+=back
+
 =head3 Removing a System / Client
 
-=item B<< slxconfig remove-system name=<system-name> >>
+=over 8
 
-=item B<< slxconfig remove-client name=<client-name> >>
+=item B<<     slxconfig remove-system name=<system-name> >>
+
+=item B<<     slxconfig remove-client name=<client-name> >>
 
 removes the system/client with the given name.
 
+=back
+
 =cut
\ No newline at end of file