From 8494cb1443e430081662c8b10e0c18170bf78208 Mon Sep 17 00:00:00 2001 From: Oliver Tappe Date: Sun, 1 Apr 2007 20:50:33 +0000 Subject: * more POD consolidation git-svn-id: http://svn.openslx.org/svn/openslx/trunk@850 95ad53e4-c205-0410-b2fa-d234c58c8868 --- config-db/slxconfig-demuxer | 61 ++++++++++++++++++++++++--------------------- 1 file changed, 32 insertions(+), 29 deletions(-) (limited to 'config-db/slxconfig-demuxer') diff --git a/config-db/slxconfig-demuxer b/config-db/slxconfig-demuxer index bb84d674..87ca1fc6 100755 --- a/config-db/slxconfig-demuxer +++ b/config-db/slxconfig-demuxer @@ -458,12 +458,14 @@ slxconfig-demuxer - OpenSLX configuration demultiplexer slxconfig-demuxer [options] -Script Options: +=head3 Script Options + --dhpc-type= specifies the type of DHCP-server (ISC,...) --dry-run avoids writing anything, for testing -OpenSLX Options: +=head3 OpenSLX Options + --base-path= basic path to project files --bin-path= path to binaries and scripts --config-path= path to configuration files @@ -483,7 +485,8 @@ OpenSLX Options: --tftpboot-path= path to root of tftp-server --verbose-level= level of logging verbosity (0-3) -General Options: +=head3 General Options + --help brief help message --man full documentation --version show version @@ -492,14 +495,14 @@ General Options: =head3 Script Options -=over 4 +=over 8 -=item B<--dhcp-type> +=item B<< --dhcp-type >> Specifies the type of DHCP-export that shall be used. Currently, only 'ISC' is supported. -=item B<--dry-run> +=item B<< --dry-run >> Runs the script but avoids writing anything. This is useful for testing, as you can learn from the logging output what would have been done. @@ -508,116 +511,116 @@ you can learn from the logging output what would have been done. =head3 OpenSLX Options -=over 4 +=over 8 -=item B<--base-path=> +=item B<< --base-path= >> Sets basic path to project files. Default is $SLX_BASE_PATH (usually F). -=item B<--bin-path=> +=item B<< --bin-path= >> Sets path to binaries and scripts. Default is $SLX_BASE_PATH/bin (usually F). -=item B<--config-path=> +=item B<< --config-path= >> Sets path to configuration files. Default is $SLX_CONFIG_PATH (usually F). -=item B<--db-basepath=> +=item B<< --db-basepath= >> Sets basic path to openslx database. Default is $SLX_DB_PATH (usually F). -=item B<--db-datadir=> +=item B<< --db-datadir= >> 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=> +=item B<< --db-name= >> Gives the name of the database to connect to. Default is $SLX_DB_NAME (usually C). -=item B<--db-spec=> +=item B<< --db-spec= >> 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=> +=item B<< --db-type= >> Sets the type of database to connect to (CSV, SQLite, mysql, ...). Default $SLX_DB_TYPE (usually C). -=item B<--export-path=> +=item B<< --export-path= >> 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. -=item B<--locale=> +=item B<< --locale= >> Sets the locale to use for translations. Defaults to the system's standard locale. -=item B<--logfile=> +=item B<< --logfile= >> Specifies a file where logging output will be written to. Default is to log to STDERR. -=item B<--private-path=> +=item B<< --private-path= >> Sets path to private data, where the config-db, vendor_oses and configurational extensions will be stored. Default is $SLX_PRIVATE_PATH (usually F. -=item B<--public-path=> +=item B<< --public-path= >> Sets path to public (client-accesible) data. Default is $SLX_PUBLIC_PATH (usually F. -=item B<--share-path=> +=item B<< --share-path= >> Sets path to sharable data, where distro-specs and functionality templates will be stored. Default is $SLX_SHARE_PATH (usually F. -=item B<--stage1-path=> +=item B<< --stage1-path= >> Sets path to stage1 systems, where distributor-systems will be installed. Default is $SLX_STAGE1_PATH (usually F. -=item B<--temp-path=> +=item B<< --temp-path= >> Sets path to temporary data. Default is $SLX_TEMP_PATH (usually F. -=item B<--tftpboot-path=> +=item B<< --tftpboot-path= >> Sets path to root of tftp-server from which clients will access their files. Default is $SLX_TFTPBOOT_PATH (usually F. -=item B<--verbose-level=> +=item B<< --verbose-level= >> Sets the level of logging verbosity (0-3). @@ -627,17 +630,17 @@ 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<--version> +=item B<< --version >> Prints the version and exits. -- cgit v1.2.3-55-g7522