Used B<> instead of C<> when highlighting options and parameters in
POD documentation. Not only do they look nicer emboldened, but it's also what's suggested in perlpod.
This commit is contained in:
parent
112da861ca
commit
fd671cec3d
16 changed files with 179 additions and 179 deletions
|
|
@ -129,47 +129,47 @@ already marked out.
|
|||
|
||||
=over
|
||||
|
||||
=item C<--configFile config.conf>
|
||||
=item B<--configFile config.conf>
|
||||
|
||||
The WebGUI config file to use. Only the file name needs to be specified,
|
||||
since it will be looked up inside WebGUI's configuration directory.
|
||||
This parameter is required.
|
||||
|
||||
=item C<--currentStatus status>
|
||||
=item B<--currentStatus status>
|
||||
|
||||
Check users in the IOB having B<status> status. If left unspecified,
|
||||
it will default to C<In>.
|
||||
|
||||
=item C<--newStatus status>
|
||||
=item B<--newStatus status>
|
||||
|
||||
Change users status in the IOB to B<status> status. If left unspecified,
|
||||
it will default to C<Out>.
|
||||
|
||||
=item C<--userMessage msg>
|
||||
=item B<--userMessage msg>
|
||||
|
||||
Text of the message to be sent to the user after changing the status.
|
||||
If left unspecified it will default to
|
||||
|
||||
You were logged out of the In/Out Board automatically.
|
||||
|
||||
=item C<--userMessageFile pathname>
|
||||
=item B<--userMessageFile pathname>
|
||||
|
||||
Pathname to a file whose contents will be sent to the user after changing
|
||||
the status. Using this option overrides whatever messages is set
|
||||
with C<--userMessage> (see above).
|
||||
with B<--userMessage> (see above).
|
||||
|
||||
=item C<--whatsHappening text>
|
||||
=item B<--whatsHappening text>
|
||||
|
||||
The message attached to the InOut Board when changing status. If left
|
||||
unspecified it defaults to
|
||||
|
||||
Automatically signed out.
|
||||
|
||||
=item C<--quiet>
|
||||
=item B<--quiet>
|
||||
|
||||
Disable all output unless there's an error.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -148,47 +148,47 @@ utility.
|
|||
|
||||
=over
|
||||
|
||||
=item C<--configFile config.conf>
|
||||
=item B<--configFile config.conf>
|
||||
|
||||
The WebGUI config file to use. Only the file name needs to be specified,
|
||||
since it will be looked up inside WebGUI's configuration directory.
|
||||
This parameter is required.
|
||||
|
||||
=item C<--assetId id>
|
||||
=item B<--assetId id>
|
||||
|
||||
Calculate disk usage starting from WebGUI's Asset identified by C<id>.
|
||||
Calculate disk usage starting from WebGUI's Asset identified by B<id>.
|
||||
If this parameter is not supplied, calculations will start from
|
||||
WebGUI's default page as defined in the Site settings.
|
||||
|
||||
=item C<--assetUrl url>
|
||||
=item B<--assetUrl url>
|
||||
|
||||
Calculate disk usage starting from the particular URL given by C<url>,
|
||||
which must be relative to the server (e.g. C</home> instead of
|
||||
C<http://your.server/home>). If this parameter is not supplied, calculations
|
||||
Calculate disk usage starting from the particular URL given by B<url>,
|
||||
which must be relative to the server (e.g. B</home> instead of
|
||||
B<http://your.server/home>). If this parameter is not supplied, calculations
|
||||
will start from WebGUI's default page as defined in the Site settings.
|
||||
|
||||
=item C<--blockSize bytes>
|
||||
=item B<--blockSize bytes>
|
||||
|
||||
Use C<bytes> as scaling factor to change the units in which disk space
|
||||
will be reported. If this parameter is not supplied, it defaults to C<1>,
|
||||
Use B<bytes> as scaling factor to change the units in which disk space
|
||||
will be reported. If this parameter is not supplied, it defaults to B<1>,
|
||||
hence the results will be expressed in bytes. If you want to have kb,
|
||||
use C<--blockSize 1024>.
|
||||
use B<--blockSize 1024>.
|
||||
|
||||
=item C<--norecurse>
|
||||
=item B<--norecurse>
|
||||
|
||||
Prevent recursive calculation of disk space. This effectively computes
|
||||
the used disk space for the starting Asset only, without including
|
||||
its descendants.
|
||||
|
||||
=item C<--quiet>
|
||||
=item B<--quiet>
|
||||
|
||||
Just display the total amount of disk space as a raw value.
|
||||
|
||||
=item C<--summary>
|
||||
=item B<--summary>
|
||||
|
||||
Just display the total amount of disk space in a human readable format.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -343,84 +343,84 @@ attached to a specified parent Asset, helping bulk uploads of content.
|
|||
This utility is designed to be run as a superuser on Linux systems,
|
||||
since it needs to be able to put files into WebGUI's data directories
|
||||
and change ownership of files. If you want to run this utility without
|
||||
superuser privileges, use the C<--override> option described below.
|
||||
superuser privileges, use the B<--override> option described below.
|
||||
|
||||
=over
|
||||
|
||||
=item C<--configFile config.conf>
|
||||
=item B<--configFile config.conf>
|
||||
|
||||
The WebGUI config file to use. Only the file name needs to be specified,
|
||||
since it will be looked up inside WebGUI's configuration directory.
|
||||
This parameter is required.
|
||||
|
||||
=item C<--pathToFiles path>
|
||||
=item B<--pathToFiles path>
|
||||
|
||||
Path to a folder containing the files to import. This parameter is required.
|
||||
|
||||
=item C<--parentAssetId id>
|
||||
=item B<--parentAssetId id>
|
||||
|
||||
Attach the imported files to the Asset C<id> in WebGUI's Asset Manager.
|
||||
Attach the imported files to the Asset B<id> in WebGUI's Asset Manager.
|
||||
This parameter is required.
|
||||
|
||||
=item C<--groupToEdit id>
|
||||
=item B<--groupToEdit id>
|
||||
|
||||
Make members of WebGUI's group identified by C<id> be able to edit
|
||||
Make members of WebGUI's group identified by B<id> be able to edit
|
||||
the uploaded files. If left unspecified, it defaults to Group ID 4,
|
||||
(Content Managers).
|
||||
|
||||
=item C<--groupToView id>
|
||||
=item B<--groupToView id>
|
||||
|
||||
Make members of WebGUI's group identified by C<id> be able to view
|
||||
Make members of WebGUI's group identified by B<id> be able to view
|
||||
the uploaded files. If left unspecified, it defaults to Group ID 7,
|
||||
(Everybody).
|
||||
|
||||
=item C<--owner id>
|
||||
=item B<--owner id>
|
||||
|
||||
Make WebGUI's user identified by C<id> own the uploaded files. If
|
||||
Make WebGUI's user identified by B<id> own the uploaded files. If
|
||||
left unspecified, it defaults to User ID 3 (Admin).
|
||||
|
||||
=item C<--webUser username>
|
||||
=item B<--webUser username>
|
||||
|
||||
The system user that your web server runs as. If left unspecified
|
||||
it will default to C<www-data>.
|
||||
it will default to B<www-data>.
|
||||
|
||||
=item C<--override>
|
||||
=item B<--override>
|
||||
|
||||
This flag will allow you to run this utility without being the super user,
|
||||
but note that it may not work as intended.
|
||||
|
||||
=item C<--skipOlderThan interval>
|
||||
=item B<--skipOlderThan interval>
|
||||
|
||||
Skip files older than C<interval> seconds. If left unspecified, it
|
||||
Skip files older than B<interval> seconds. If left unspecified, it
|
||||
will default to skip no files.
|
||||
|
||||
=item C<--findByExt patterns>
|
||||
=item B<--findByExt patterns>
|
||||
|
||||
Import only those files with matching file extensions. C<patterns>
|
||||
Import only those files with matching file extensions. B<patterns>
|
||||
is a list of comma-separated extensions to match. If left unspecified,
|
||||
it will default to import all files.
|
||||
|
||||
=item C<--recursive>
|
||||
=item B<--recursive>
|
||||
|
||||
Import files recursively. If left unspecified, only files in the
|
||||
folder will be imported, without following subfolders.
|
||||
|
||||
=item C<--overwrite>
|
||||
=item B<--overwrite>
|
||||
|
||||
Overwrite any matching file URL with the new file rather than
|
||||
creating a new Asset for the file. Instantiate the existing asset
|
||||
and replace the file.
|
||||
|
||||
=item C<--ignoreExtInName>
|
||||
=item B<--ignoreExtInName>
|
||||
|
||||
Do not include the filename extension in the Title and menuTitle
|
||||
database fields.
|
||||
|
||||
=item C<--quiet>
|
||||
=item B<--quiet>
|
||||
|
||||
Disable all output unless there's an error.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -106,39 +106,39 @@ the generated content.
|
|||
|
||||
=over
|
||||
|
||||
=item C<--configFile config.conf>
|
||||
=item B<--configFile config.conf>
|
||||
|
||||
The WebGUI config file to use. Only the file name needs to be specified,
|
||||
since it will be looked up inside WebGUI's configuration directory.
|
||||
This parameter is required.
|
||||
|
||||
=item C<--assetId id>
|
||||
=item B<--assetId id>
|
||||
|
||||
Generate content for WebGUI's Asset identified by C<id>. Either this
|
||||
parameter or C<--url> must be supplied.
|
||||
Generate content for WebGUI's Asset identified by B<id>. Either this
|
||||
parameter or B<--url> must be supplied.
|
||||
|
||||
=item C<--url url>
|
||||
=item B<--url url>
|
||||
|
||||
Generate content for WebGUI's Asset located at C<url>, which must be
|
||||
relative to the server (e.g. C</home> instead of C<http://your.server/home>).
|
||||
Either this parameter or C<--assetID> must be supplied.
|
||||
Generate content for WebGUI's Asset located at B<url>, which must be
|
||||
relative to the server (e.g. B</home> instead of B<http://your.server/home>).
|
||||
Either this parameter or B<--assetID> must be supplied.
|
||||
|
||||
=item C<--styleId id>
|
||||
=item B<--styleId id>
|
||||
|
||||
Use the WebGUI style specified by the AssetID C<id>. If left unspecified,
|
||||
Use the WebGUI style specified by the AssetID B<id>. If left unspecified,
|
||||
it defaults to using the Asset's default style.
|
||||
|
||||
=item C<--toFile pathname>
|
||||
=item B<--toFile pathname>
|
||||
|
||||
Send generated content to the specified filename. If left unspecified,
|
||||
content is sent to standard output.
|
||||
|
||||
=item C<--userId id>
|
||||
=item B<--userId id>
|
||||
|
||||
Set a specific WebGUI user to act as content viewer. If left unspecified,
|
||||
defaults to C<1> (Visitor).
|
||||
defaults to B<1> (Visitor).
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -57,27 +57,27 @@ maintenanceMode --help
|
|||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
This utility script will set or unset WebGUI's C<specialState>
|
||||
This utility script will set or unset WebGUI's B<specialState>
|
||||
setting to signal the beginning or end of Maintenance Mode.
|
||||
|
||||
=over
|
||||
|
||||
=item C<--configFile config.conf>
|
||||
=item B<--configFile config.conf>
|
||||
|
||||
The WebGUI config file to use. Only the file name needs to be specified,
|
||||
since it will be looked up inside WebGUI's configuration directory.
|
||||
This parameter is required.
|
||||
|
||||
=item C<--start>
|
||||
=item B<--start>
|
||||
|
||||
Set C<specialState> to signal the beginning of maintenance mode.
|
||||
Set B<specialState> to signal the beginning of maintenance mode.
|
||||
This is the default behaviour.
|
||||
|
||||
=item C<--stop>
|
||||
=item B<--stop>
|
||||
|
||||
Unset C<specialState> to signal the end of maintenance mode.
|
||||
Unset B<specialState> to signal the end of maintenance mode.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -110,28 +110,28 @@ migrateCollabToGallery --help
|
|||
=head1 DESCRIPTION
|
||||
|
||||
This WebGUI utility script migrates a collaboration system's threads
|
||||
into gallery albums. It uses C<WebGUI::Utility::Gallery> for its major
|
||||
into gallery albums. It uses B<WebGUI::Utility::Gallery> for its major
|
||||
features.
|
||||
|
||||
=over
|
||||
|
||||
=item C<--configFile config.conf>
|
||||
=item B<--configFile config.conf>
|
||||
|
||||
The WebGUI config file to use. Only the file name needs to be specified,
|
||||
since it will be looked up inside WebGUI's configuration directory.
|
||||
This parameter is required.
|
||||
|
||||
=item C<collab>
|
||||
=item B<collab>
|
||||
|
||||
A WebGUI's Collaboration System URL or Asset ID. If an URL is given,
|
||||
it must be an absolute URL beginning with a slash.
|
||||
|
||||
=item C<gallery>
|
||||
=item B<gallery>
|
||||
|
||||
A WebGUI's Gallery URL or Asset ID. If an URL is given, it must be
|
||||
an absolute URL beginning with a slash.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -133,6 +133,6 @@ The WebGUI config file to use.
|
|||
=head1 DESCRIPTION
|
||||
|
||||
This script migrates a Folder into a gallery album. It
|
||||
uses C<WebGUI::Utility::Gallery> for its major features.
|
||||
uses B<WebGUI::Utility::Gallery> for its major features.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -55,13 +55,13 @@ removes it.
|
|||
|
||||
=over
|
||||
|
||||
=item C<--configFile config.conf>
|
||||
=item B<--configFile config.conf>
|
||||
|
||||
The WebGUI config file to use. Only the file name needs to be specified,
|
||||
since it will be looked up inside WebGUI's configuration directory.
|
||||
This parameter is required.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -154,17 +154,17 @@ out of order in your navigation.
|
|||
|
||||
=over
|
||||
|
||||
=item C<--configFile config.conf>
|
||||
=item B<--configFile config.conf>
|
||||
|
||||
The WebGUI config file to use. Only the file name needs to be specified,
|
||||
since it will be looked up inside WebGUI's configuration directory.
|
||||
This parameter is required.
|
||||
|
||||
=item C<--quiet>
|
||||
=item B<--quiet>
|
||||
|
||||
Disable all output unless there's an error.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -159,40 +159,40 @@ build the index only for new content, and perform searches.
|
|||
|
||||
=over
|
||||
|
||||
=item C<--configFile config.conf>
|
||||
=item B<--configFile config.conf>
|
||||
|
||||
The WebGUI config file to use. Only the file name needs to be specified,
|
||||
since it will be looked up inside WebGUI's configuration directory.
|
||||
This parameter is required.
|
||||
|
||||
=item C<--indexsite>
|
||||
=item B<--indexsite>
|
||||
|
||||
Reindexes the entire site specified in the config file. This process
|
||||
may take a while (even hours) depending on the amount of content the
|
||||
site has. Server performance will suffer somewhat during the
|
||||
indexing process. This option requires a C<--configFile> to be
|
||||
indexing process. This option requires a B<--configFile> to be
|
||||
specified.
|
||||
|
||||
=item C<--updatesite>
|
||||
=item B<--updatesite>
|
||||
|
||||
Indexes content that has not be indexed for the site specified in
|
||||
the config file, keeping the indexes for already indexed content
|
||||
intact. This is useful if the C<--indexsite> had to be stopped
|
||||
partway through. This option requires a C<--configFile> to be
|
||||
intact. This is useful if the B<--indexsite> had to be stopped
|
||||
partway through. This option requires a B<--configFile> to be
|
||||
specified.
|
||||
|
||||
=item C<--search text>
|
||||
=item B<--search text>
|
||||
|
||||
Searches the site specified in the config file for a given keyword or
|
||||
phrase, returning the results. This option requires a C<--configFile>
|
||||
phrase, returning the results. This option requires a B<--configFile>
|
||||
to be specified.
|
||||
|
||||
=item C<--indexall>
|
||||
=item B<--indexall>
|
||||
|
||||
Reindexes B<all> the sites. Note that this can take many hours and
|
||||
will affect performance of the server during the indexing process.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -151,32 +151,32 @@ S.P.E.C.T.R.E. is the Supervisor of Perplexing Event-handling
|
|||
Contraptions for Triggering Relentless Executions. It triggers
|
||||
WebGUI's workflow and scheduling functions.
|
||||
|
||||
Spectre's configuration file, C<spectre.conf>, is located under
|
||||
Spectre's configuration file, B<spectre.conf>, is located under
|
||||
the WebGUI filesystem hierarchy.
|
||||
|
||||
=over
|
||||
|
||||
=item C<--daemon>
|
||||
=item B<--daemon>
|
||||
|
||||
Starts the Spectre server forking as a background daemon. This
|
||||
can be done by hand, but it is usually handled by a startup
|
||||
script.
|
||||
|
||||
=item C<--run>
|
||||
=item B<--run>
|
||||
|
||||
Starts Spectre in the foreground without forking as a daemon.
|
||||
|
||||
=item C<--debug>
|
||||
=item B<--debug>
|
||||
|
||||
If this option is specified at startup either in C<--daemon>
|
||||
or C<--run> mode, Spectre will provide verbose debug to standard
|
||||
If this option is specified at startup either in B<--daemon>
|
||||
or B<--run> mode, Spectre will provide verbose debug to standard
|
||||
output so that you can see exactly what it's doing.
|
||||
|
||||
=item C<--shutdown>
|
||||
=item B<--shutdown>
|
||||
|
||||
Stops the running Spectre server.
|
||||
|
||||
=item C<--ping>
|
||||
=item B<--ping>
|
||||
|
||||
Pings Spectre to see if it is alive. If Spectre is alive, you'll get
|
||||
confirmation with a message like
|
||||
|
|
@ -188,16 +188,16 @@ If Spectre doesn't seem to be alive, you'll get a message like
|
|||
Spectre is not responding.
|
||||
Unable to connect to <IP-address>:<Port>
|
||||
|
||||
where C<IP-address> is the IP address and C<Port> is the port number
|
||||
where B<IP-address> is the IP address and B<Port> is the port number
|
||||
where Spectre should be listening for connections on according to
|
||||
C<spectre.conf>.
|
||||
B<spectre.conf>.
|
||||
|
||||
=item C<--status>
|
||||
=item B<--status>
|
||||
|
||||
Shows a summary of Spectre's internal status. The summary contains
|
||||
a tally of suspended, waiting and running WebGUI Workflows.
|
||||
|
||||
=item C<--test>
|
||||
=item B<--test>
|
||||
|
||||
Tests whether Spectre can connect to WebGUI. Both Spectre
|
||||
and the Apache server running WebGUI must be running for this
|
||||
|
|
@ -205,7 +205,7 @@ option to work. It will test the connection between every site
|
|||
and Spectre, by looking for configuration files in WebGUI's
|
||||
configuration directory, showing success or failure in each case.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -82,8 +82,8 @@ testCodebase - Test WebGUI's code base.
|
|||
=head1 DESCRIPTION
|
||||
|
||||
This WebGUI utility script tests all of WebGUI's installed code base
|
||||
using a particular confiuration file. It uses C<prove> to run all
|
||||
the WebGUI supplied test routines, located in the C<t> subdirectory
|
||||
using a particular confiuration file. It uses B<prove> to run all
|
||||
the WebGUI supplied test routines, located in the B<t> subdirectory
|
||||
of the WebGUI root.
|
||||
|
||||
You should B<NOT> use a production config file for testing, since some
|
||||
|
|
@ -91,32 +91,32 @@ of the test may be destructive.
|
|||
|
||||
=over
|
||||
|
||||
=item C<--configFile config.conf>
|
||||
=item B<--configFile config.conf>
|
||||
|
||||
The WebGUI config file to use. Only the file name needs to be specified,
|
||||
since it will be looked up inside WebGUI's configuration directory. Be
|
||||
aware that some of the tests may be destructive. This parameter is required.
|
||||
|
||||
=item C<--coverage>
|
||||
=item B<--coverage>
|
||||
|
||||
Turns on additional L<Devel::Cover> based coverage tests. Note that
|
||||
this can take a long time to run.
|
||||
|
||||
=item C<--noLongTests>
|
||||
=item B<--noLongTests>
|
||||
|
||||
Prevent long tests from being run
|
||||
|
||||
=item C<--perlBase path>
|
||||
=item B<--perlBase path>
|
||||
|
||||
Specify a path to an alternative Perl installation you wish to use for the
|
||||
tests. If left unspecified, it defaults to the Perl installation in the
|
||||
current PATH.
|
||||
|
||||
=item C<--verbose>
|
||||
=item B<--verbose>
|
||||
|
||||
Turns on additional information during tests.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -409,12 +409,12 @@ L<http://update.webgui.org>, and compare with the currently installed one.
|
|||
|
||||
=over
|
||||
|
||||
=item C<--simpleReport>
|
||||
=item B<--simpleReport>
|
||||
|
||||
Prints the status report to standard output, but does not attempt
|
||||
to upgrade any outdated or missing Perl modules.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -143,22 +143,22 @@ for image transformations.
|
|||
|
||||
=over
|
||||
|
||||
=item C<--path path>
|
||||
=item B<--path path>
|
||||
|
||||
Specifies the absolute C<path> to WebGUI's uploads directory.
|
||||
Specifies the absolute B<path> to WebGUI's uploads directory.
|
||||
This parameter is required.
|
||||
|
||||
=item C<--size thumbSize>
|
||||
=item B<--size thumbSize>
|
||||
|
||||
Specify the size in pixels of the largest dimension of the thumbanils.
|
||||
If left unspecified, it defaults to 50 pixels.
|
||||
|
||||
=item C<--missing>
|
||||
=item B<--missing>
|
||||
|
||||
Use this option to create thumbnails only for those images that are
|
||||
missing thumbnails.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -384,7 +384,7 @@ WebGUI libraries and programs.
|
|||
This utility is designed to be run as a superuser on Linux systems,
|
||||
since it needs to be able to access several system directories
|
||||
and change ownership of files. If you want to run this utility without
|
||||
superuser privileges, use the C<--override> option described below.
|
||||
superuser privileges, use the B<--override> option described below.
|
||||
|
||||
=head1 WARNING
|
||||
|
||||
|
|
@ -400,60 +400,60 @@ upgrade.
|
|||
|
||||
=over
|
||||
|
||||
=item C<--doit>
|
||||
=item B<--doit>
|
||||
|
||||
You B<MUST> include this flag in the command line or the script
|
||||
will refuse to run. This is to force you to read this documentation
|
||||
at least once and be sure that you B<REALLY> want to perform the
|
||||
upgrade.
|
||||
|
||||
=item C<--backupDir path>
|
||||
=item B<--backupDir path>
|
||||
|
||||
Specify a path where database backups should be created during the
|
||||
upgrade procedure. If left unspecified, it defaults to C</var/backups>.
|
||||
upgrade procedure. If left unspecified, it defaults to B</var/backups>.
|
||||
|
||||
=item C<--history>
|
||||
=item B<--history>
|
||||
|
||||
Displays the upgrade history for each of your sites. Running with this
|
||||
flag will B<NOT> perform the upgrade.
|
||||
|
||||
=item C<--mysql pathname>
|
||||
=item B<--mysql pathname>
|
||||
|
||||
The full pathname to your mysql client executable. If left unspecified,
|
||||
it defaults to C</usr/bin/mysql>.
|
||||
it defaults to B</usr/bin/mysql>.
|
||||
|
||||
=item C<--mysqldump pathname>
|
||||
=item B<--mysqldump pathname>
|
||||
|
||||
The full pathname to your mysqldump executable. If left unspecified,
|
||||
it defaults to C</usr/bin/mysqldump>.
|
||||
it defaults to B</usr/bin/mysqldump>.
|
||||
|
||||
=item C<--override>
|
||||
=item B<--override>
|
||||
|
||||
This flag will allow you to run this utility without being the super user,
|
||||
but note that it may not work as intended.
|
||||
|
||||
=item C<--skipBackup>
|
||||
=item B<--skipBackup>
|
||||
|
||||
Use this if you B<DO NOT> want database backups to be performed
|
||||
during the upgrade procedure.
|
||||
|
||||
=item C<--skipDelete>
|
||||
=item B<--skipDelete>
|
||||
|
||||
The upgrade procedure normally deletes WebGUI's cache and temporary files
|
||||
created as part of the upgrade. This cleanup is very important during
|
||||
large upgrades, but can make the procedure quite slow. This option
|
||||
skips the deletion of these files.
|
||||
|
||||
=item C<--skipMaintenance>
|
||||
=item B<--skipMaintenance>
|
||||
|
||||
The upgrade procedure normally puts up a simple maintenance page on all
|
||||
the sites while running, but this option will skip that step.
|
||||
|
||||
=item C<--quiet>
|
||||
=item B<--quiet>
|
||||
|
||||
Disable all output unless there's an error.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
|
|
@ -272,11 +272,11 @@ overriding values from the file.
|
|||
This utility is designed to be run as a superuser on Linux systems,
|
||||
since it needs to be able to put files into WebGUI's data directories
|
||||
and change ownership of files. If you want to run this utility without
|
||||
superuser privileges, use the C<--override> option described below.
|
||||
superuser privileges, use the B<--override> option described below.
|
||||
|
||||
The user information is given in a simple TAB-delimited text file,
|
||||
that describes both the field names and field data for each user. You
|
||||
can change de actual delimiter with the C<--delimiter> option (see below).
|
||||
can change de actual delimiter with the B<--delimiter> option (see below).
|
||||
|
||||
The first line of the file contains the field names whose values are
|
||||
going to be loaded. From then on, all non-blank lines in the file must have
|
||||
|
|
@ -285,28 +285,28 @@ names are:
|
|||
|
||||
=over
|
||||
|
||||
=item C<username>
|
||||
=item C<password>
|
||||
=item C<authMethod>
|
||||
=item C<status>
|
||||
=item C<ldapUrl>
|
||||
=item C<connectDN>
|
||||
=item C<groups>
|
||||
=item C<expireOffset>
|
||||
=item B<username>
|
||||
=item B<password>
|
||||
=item B<authMethod>
|
||||
=item B<status>
|
||||
=item B<ldapUrl>
|
||||
=item B<connectDN>
|
||||
=item B<groups>
|
||||
=item B<expireOffset>
|
||||
=item Any valid User Profile field name available in WebGUI's database,
|
||||
e.g. C<firstName>, C<lastName>, C<mail>, etc.
|
||||
e.g. B<firstName>, B<lastName>, B<mail>, etc.
|
||||
|
||||
=back
|
||||
|
||||
If you use the field C<groups>, each following line should contain a comma
|
||||
If you use the field B<groups>, each following line should contain a comma
|
||||
separated list of WebGUI Group Ids; note that this could be a problem
|
||||
if you chose to use comma as a delimiter for fields.
|
||||
|
||||
If no username is specified it will default to C<firstName.lastName>. If
|
||||
no C<username> is specified, nor C<firstName> and C<lastName>, then the
|
||||
If no username is specified it will default to B<firstName.lastName>. If
|
||||
no B<username> is specified, nor B<firstName> and B<lastName>, then the
|
||||
user will B<not> be loaded.
|
||||
|
||||
If you specify the C<userId> field for import on any record, that C<userId>
|
||||
If you specify the B<userId> field for import on any record, that B<userId>
|
||||
will be used instead of generating a new one automatically. If you do this,
|
||||
be careful not to insert duplicates!
|
||||
|
||||
|
|
@ -314,106 +314,106 @@ If you use an invalid field name, its values will be ignored.
|
|||
|
||||
=over
|
||||
|
||||
=item C<--configFile config.conf>
|
||||
=item B<--configFile config.conf>
|
||||
|
||||
The WebGUI config file to use. Only the file name needs to be specified,
|
||||
since it will be looked up inside WebGUI's configuration directory.
|
||||
This parameter is required.
|
||||
|
||||
=item C<--usersFile pathname>
|
||||
=item B<--usersFile pathname>
|
||||
|
||||
Pathname to the file containing users information for bulk loading.
|
||||
|
||||
=item C<--authMethod method>
|
||||
=item B<--authMethod method>
|
||||
|
||||
Specify the default authentication method to set for each loaded user.
|
||||
It can be overridden in the import file for specific users.
|
||||
If left unspecified, it defaults to C<WebGUI>.
|
||||
If left unspecified, it defaults to B<WebGUI>.
|
||||
|
||||
=item C<--canChangePass>
|
||||
=item B<--canChangePass>
|
||||
|
||||
Set loaded users to be able to change their passwords. If left
|
||||
unspecified, loaded users will B<NOT> be able to change their
|
||||
passwords until and administrator grants them the privilege.
|
||||
|
||||
=item C<--delimiter string>
|
||||
=item B<--delimiter string>
|
||||
|
||||
Specify the string delimiting fields in the import file. If left
|
||||
unspecified, it defaults to a single TAB (ASCII 9).
|
||||
|
||||
=item C<--expireOffset integer>
|
||||
=item B<--expireOffset integer>
|
||||
|
||||
Specify the default amount of time before the loaded user will be
|
||||
expired from the groups they are added to. The units are specified
|
||||
by C<--expireUnits> (see below). It can be overridden in the import
|
||||
by B<--expireUnits> (see below). It can be overridden in the import
|
||||
file for specific users. If left unspecified, it defaults to the
|
||||
expire offset set in the group definition within WebGUI.
|
||||
|
||||
=item C<--expireUnits unidades>
|
||||
=item B<--expireUnits unidades>
|
||||
|
||||
Specify the units for C<--expireOffset> (see above). Valid values
|
||||
are C<seconds>, C<minutes>, C<hours>, C<days>, C<weeks>, C<months>,
|
||||
C<years>, C<epoch>, or C<fixed>. If set to C<epoch> the system will
|
||||
Specify the units for B<--expireOffset> (see above). Valid values
|
||||
are B<seconds>, B<minutes>, B<hours>, B<days>, B<weeks>, B<months>,
|
||||
B<years>, B<epoch>, or B<fixed>. If set to B<epoch> the system will
|
||||
assume that the expire offset should be taken as an epoch date
|
||||
(absolute number of seconds since January 1, 1970) rather than an
|
||||
interval. If set to C<fixed> the system will assume that the
|
||||
C<--expireOffset> is a fixed date. If left unspecified, it defaults
|
||||
to C<seconds>.
|
||||
interval. If set to B<fixed> the system will assume that the
|
||||
B<--expireOffset> is a fixed date. If left unspecified, it defaults
|
||||
to B<seconds>.
|
||||
|
||||
=item C<--groups groupid,...>
|
||||
=item B<--groups groupid,...>
|
||||
|
||||
Specify a comma separated list of WebGUI Group Ids that each loaded
|
||||
user will be set to. It can be overridden in the import file for
|
||||
specific users.
|
||||
|
||||
=item C<--ldapUrl uri>
|
||||
=item B<--ldapUrl uri>
|
||||
|
||||
Specify the URI used to connect to the LDAP server for authentication.
|
||||
The URI must conform to what L<Net::LDAP> uses for connecting.
|
||||
It can be overridden in the import file for specific users.
|
||||
|
||||
=item C<--password string>
|
||||
=item C<--identifier string>
|
||||
=item B<--password string>
|
||||
=item B<--identifier string>
|
||||
|
||||
Specify the default password to use for loaded users. It can (and should)
|
||||
be overriden in the import file for specific users. If left unspecified,
|
||||
it defaults to C<123qwe>.
|
||||
it defaults to B<123qwe>.
|
||||
|
||||
=item C<--status status>
|
||||
=item B<--status status>
|
||||
|
||||
Specify the default account status for loaded users. Valid values are
|
||||
C<Active> and C<Deactivated>. If left unspecified, it defaults to
|
||||
C<Active>.
|
||||
B<Active> and B<Deactivated>. If left unspecified, it defaults to
|
||||
B<Active>.
|
||||
|
||||
=item C<--update>
|
||||
=item B<--update>
|
||||
|
||||
Search WebGUI's database for each user listed in the import file, and
|
||||
update its information using the provided fields. Users in the import
|
||||
file that are B<not> found in the database are B<ignored>. See
|
||||
C<--updateAdd> below if you want to add the extra users.
|
||||
B<--updateAdd> below if you want to add the extra users.
|
||||
|
||||
=item C<--updateAdd>
|
||||
=item B<--updateAdd>
|
||||
|
||||
Search WebGUI's database for each user listed in the import file, and
|
||||
update its information using the provided fields. Users in the import
|
||||
file that are B<not> found in the database are B<added>. See
|
||||
C<--update> above if you do not want to add the extra users.
|
||||
B<--update> above if you do not want to add the extra users.
|
||||
|
||||
=item C<--replaceGroups>
|
||||
=item B<--replaceGroups>
|
||||
|
||||
If the user being updated with C<--update> or C<--updateAdd> already
|
||||
If the user being updated with B<--update> or B<--updateAdd> already
|
||||
belongs to some other groups, remove the user from them.
|
||||
|
||||
=item C<--override>
|
||||
=item B<--override>
|
||||
|
||||
This flag will allow you to run this utility without being the super user,
|
||||
but note that it may not work as intended.
|
||||
|
||||
=item C<--quiet>
|
||||
=item B<--quiet>
|
||||
|
||||
Disable all output unless there's an error.
|
||||
|
||||
=item C<--help>
|
||||
=item B<--help>
|
||||
|
||||
Shows this documentation, then exits.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue