summaryrefslogtreecommitdiffstats
path: root/config-db/slxconfig-demuxer
diff options
context:
space:
mode:
authorOliver Tappe2007-04-01 22:50:33 +0200
committerOliver Tappe2007-04-01 22:50:33 +0200
commit8494cb1443e430081662c8b10e0c18170bf78208 (patch)
treede7486fd52cc412b15380f26d5d2386c8b39bd1e /config-db/slxconfig-demuxer
parent* improved POD formatting (diff)
downloadcore-8494cb1443e430081662c8b10e0c18170bf78208.tar.gz
core-8494cb1443e430081662c8b10e0c18170bf78208.tar.xz
core-8494cb1443e430081662c8b10e0c18170bf78208.zip
* more POD consolidation
git-svn-id: http://svn.openslx.org/svn/openslx/trunk@850 95ad53e4-c205-0410-b2fa-d234c58c8868
Diffstat (limited to 'config-db/slxconfig-demuxer')
-rwxr-xr-xconfig-db/slxconfig-demuxer61
1 files changed, 32 insertions, 29 deletions
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=<string> specifies the type of DHCP-server
(ISC,...)
--dry-run avoids writing anything, for testing
-OpenSLX Options:
+=head3 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
@@ -483,7 +485,8 @@ OpenSLX 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
--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=<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).
@@ -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.