|
|
||||||||
|
Nameplconfig - the Pipeline Configuration Tool Synopsisplconfig [options] Description
This program is used by system administrators to generate a Pipeline configuration profile and license key for their site. See the Global Options section for details about the site specific parameters which can be configured.
Information OptionsThe following options provide information about plconfig(1) and then immediately exit: --help Global
Options
The following options must be supplied if plconfig(1) is run in batch
mode. They may also be supplied when using the default
graphical configuration wizard to override the default values
provided during the interactive configuration process.
Batch mode is useful in combination with --reconfig to override a few
settings from a previous configuration without needing to
display a user interface.
--batch Run in batch mode. No graphical UI will be displayed and the following minimal set of options must be supplied along with any additional non-required options. --limited=yyyy-mm-dd --perpetual Specifies the time period the Pipeline license will remain valid. An evaluation license is valid for 30-days. A limited license is valid until the the given expiration data (yyyy-mm-dd). A perpetual license is valid forever. One and only one of these options must be given. --root-dir=dir The path to the directory (dir) under which the top-level directory of the Pipeline installation will reside. This directory should reside on a network accessible file system such that all machines which will run Pipeline related programs can access the directory as (dir). The top-level directory of the Pipeline installation will have a name matching the Pipeline distribution.--server-host=host
The default host name of
the machine (host)
where Pipeline server daemons will be run. If
all server daemons will be run on a single host, then only
this option is required to specify the location for the
plmaster(1),
plfilemgr(1),
plqueuemgr(1) and
plpluginmgr(1) deamons. To configure daemons to run
on other server hosts, use the --master-host, --file-host, --queue-host and --plugin-host options to
override the server specified by this option for the
respective daemons.
Note that a host ID for
this host must be generate using plid(1) and placed in the
host IDs file passed to the --host-ids option.
Specifies the name of the file (filename) containing the host IDs
for the Pipeline server hosts specified by the --master-host, --queue-host and --file-host options. This
host ID file is generated by running plid(1)
on each of the server hosts. The file can either be
constructed manually by appending the output from each
invocation of plid(1) or automatically by
using the --append option to plid(1).
Non-Required Options
The following set of options are not required but may be used
to customize the configuration parameters for your site which
would otherwise be auto-detected or given default
values.
--reconfig=plconfig/settings.glue Reuses the configuration settings from a previous invocation of plconfig(1) to initialize the settings for a new configuration. Any options specifed after this option will override the settings from the previous configuration. --pipeline-user=user-name --pipeline-group=group-name The names of the user and group used to run Pipeline daemon processes. This user will also have special permission to perform Pipeline administrative operations. If not specified, both the pipeline user and group will default to (pipeline). --master-host=host
The host name of the machine
(host) which will run
the Pipeline master manager daemon
plmaster(1). This daemon should run on a
host which can access the root node directory (see
--node-dir) on a local file system. The
master manager daemon is responsible for managing all Pipeline
node operations including dispatching jobs. For optimal
performance, the host which runs this daemon should be
dedicated and have a fast network connection to the host
running the Pipeline file management
plfilemgr(1)
daemon (see --file-host).
Note that a host ID for this host must be generate using plid(1) and placed in the host IDs file passed to the --host-ids option. If not specified, the master host will default to the host specified by the --server-host option. --master-port=num
The number of the network port (num) listened to by the Pipeline
master manager daemon
plmaster(1).
If not specified, the port number will default to (53135). --master-heap-size=bytes[K|M|G]
Sets the maximum heap size of the Java VM running the Pipeline
master manager daemon
plmaster(1) to (bytes). For ideal
performance, this size should be as large as possible without
causing the host running
plmaster(1) to swap. This option
directly sets the -Xmx
and indirectly specifies the
-Xms command line options to the Java VM which runs
plmaster(1).
If not specified, the deault heap size is (512M). --node-dir=dir
The absolute path to the root directory under which the
persistent copies of Pipeline nodes are stored. This
directory should reside on a local file system on the host
which will run
plmaster(1) (see --master-host).
If not specified, the node directory will default to (/usr/share/pipeline).
The host name of the machine (host) which will run the Pipeline
file manager daemon
plfilemgr(1). For optimal performance, this
daemon should be run on the same host which acts as the network
file server where production data files will reside (see
--prod-dir). If local
file acess is not possible or desireable, the
plfilemgr(1) daemon should be run on a dedicated
host which has the fastest possible network access to the
production directories.
Note that a host ID for this host must be generate using plid(1) and placed in the host IDs file passed to the --host-ids option. If not specified, the file host will default to the host specified by the --server-host option. --file-port=numThe number of the network port
(num) listened to by the
Pipeline file manager daemon
plfilemgr(1).
If not specified, the port number will default to (53136).--file-heap-size=bytes[K|M|G]
Sets the maximum heap size of the Java VM running the Pipeline
file manager daemon
plfilemgr(1) to (bytes). For ideal
performance, this size should be as large as possible without
causing the host running
plfilemgr(1) to swap. This option
directly sets the -Xmx
and indirectly specifies the
-Xms command line options to the Java VM which runs
plfilemgr(1).
If not specified, the deault heap size is (512M). --prod-dir=dirThe absolute
path to the root directory under which all production data files
will reside. In other words, the location where artists
will save their work. This root production directory should
reside on a network accessible file system such that all machines
which will run Pipeline related programs can access the directory
as (dir).
For optimal performance this directory should reside on the
same host which runs the
plfilemgr(1) daemon (see --file-host) although this is
not required.
If not specified, the production directory will default to (/base/prod).--short-symlinksWhether the value of a symbolic link (target) is
limited to 255 characters by the underlying file system where the production directory resides. Notably, the CVFS file system has this limitation. Most file systems however do not have any limitation to the length of the value of symbolic links aside from the normal file name length limitations.
Due to the widespread use of symbolic links within the Pipeline repository and working areas, a 255 character limit will impose limits on the length of node names so that all of the proper symbolic links can be created by Pipeline during node check-in/out operations. When this option is used, Pipeline will refuse to register nodes with names long enough to potentially cause problems during revision control operations.If not specified, then there will be no limitations to the length of symbolic link values and therefore no limits on node name length.
--queue-host=host The host name of the machine (host) which will run the Pipeline queue manager daemon plqueuemgr(1). This daemon assigns jobs from the queue to the hosts running the job execution pljobmgr(1) daemons. It also provides information about the status of these jobs to both the Pipeline master server plmaster(1) and plui(1) client programs. Note that a host ID for this host must be generate using plid(1) and placed in the host IDs file passed to the --host-ids option. If not specified, the file host will default to the host specified by the --server-host option.
--queue-port=num
The number of the network
port (num) listened
to by the Pipeline queue manager daemonplqueuemgr(1).
If not specified, the port number will default to (53139). --queue-heap-size=bytes[K|M|G]
Sets the maximum heap size of the Java VM running the Pipeline
queue manager daemon
plqueuemgr(1) to (bytes). For ideal
performance, this size should be as large as possible without
causing the host running
plqueuemgr(1) to swap. This option
directly sets the
-Xmx and indirectly specifies the
-Xms command line options to the Java VM which runs
plqueuemgr(1).
If not specified, the deault heap size is (512M). --job-port=num The number of the network port (num) listened to by the Pipeline job execution pljobmgr(1) daemons. Each host which executes jobs on behalf of the Pipeline job queue will run this daemon. If not specified, the port number will default to (53140). --queue-dir=dir
The absolute path to the root directory under which all queue
related data files will reside. This directory should
reside on a local file system on the host which will run the
Pipeline queue manager daemon
plqueuemgr(1) (see --queue-host). If not specified, the node directory will default to (/usr/share/pipeline).
--plugin-host=host
The host name of the machine (host) which will run the Pipeline plugin manager daemon plpluginmgr(1). This daemon is responsible for loading plugin classes and providing loaded plugins to the other Pipeline programs. Note that a host ID for this host must be generate using plid(1) and placed in the host IDs file passed to the --host-ids option. If not specified, the file host will default to to the host specified by the --server-host option. --plugin-port=num
The number of the network port (num) listened to by the Pipeline
plugin server daemon
plpluginmgr(1). This daemon is responsible
for loading plugin classes and providing loaded plugins to
the other Pipeline programs.
If not specified, the port number will default to (53141). --plugin-dir=dir
The absolute path to the root directory under which a list of
installed plugins will be saved. This directory should
reside on a local file system on the host which will run the
Pipeline plugin manager daemon
plpluginmgr(1). If not specified, the node directory will default to (/usr/share/pipeline/plugins).
--legacy-plugins
For sites which have previously installed a version Pipeline
before the 2.0.0 release, this option adds the plugins
required by these older Pipeline releases. Sites which
have only installed Pipeline 2.0.0 or later releases should
not use this option.
--local-vendor=vendor-name
Specifies the default vendor (vendor-name) of all locally created plugins. Plugins are identified by their name, version ID and vendor. The vendor is a short name for the creating entity of the plugin. All of the standard plugins shipped with Pipeline have a vendor of "Temerity". If studios create their own plugins, they should use a different vendor name to avoid name conflicts. Without using a special override command-line option, the tool used to install plugins (plpluginmgr) will reject plugins not created by the default vendor. This helps to avoid mistakes where plugin developers copy the source code from a Temerity (or other vendor) plugin and forget to change the vendor. --home-dir=dir
The absolute path to the parent directory of all user home
directories. If not specified, this location is derived
from the environment under which plconfig(1) is run or (/home) if
the location cannot be determined from the environment. The absolute path to the directory (dir) used to write various temporary files generated by Pipeline programs. For optimal performance, this directory should reside on a local file system. If not specified, the temporary directory will default to (/usr/tmp). --unix-java-home=dir
The path to the root directory of the local Java Runtime Environment (JRE) installed on the Linux artist workstations. You can use this option to set a different JRE to be used for Pipeline client programs than is used to run the back-end server daemons.
If not specified, the JRE home directory defaults to the version of Java used to run this configuration tool. --local-vendor-javadoc-dir=dir
The path to the root directory where the documentation generated by javadoc for locally created Pipeline plugins and standalone utils is located. Providing this will allow users to easily access the documentation for locally created plugins from Pipeline's user interface.
If not specified, the default directory is the (root-install-directory/pipeline-latest/share/docs/local-javadocs) subdirectory of where Pipeline is installed. --local-java-lib=dir
An optional JAR file containing common Java class shared by a large number of locally created plugins and/or standalone utils. Any JARs provided using this option will be added to the Java classpath for all Pipeline programs. This is typically used for relatively large 3rd party libraries for things such as XML parsing or SQL database connections which would otherwise need to be embedded in many different plugin JARs. Since these libraries be dynamically updated (like plugins can), they are not suitable for anything which might need to modified without a Pipeline shutdown. This feature is only an optimization to reduce plugin size and memory footprint but is not required in order to use 3rd party Java libraries with Pipeline.
Mac OS X OptionsThese options specify the paths to use from Mac OS X hosts to access the corresponding network file system directories as specified for Linux hosts using the non-mac versions of these options.--mac-support Include a support for Mac OS X client programs. If this option is specified, you must also supply the Mac OS X specific paths to the root install directory (--mac-root-dir) and the root production directory (--mac-prod-dir). --mac-root-dir=dir
The path to the directory (dir) under which the top-level
directory of the Pipeline installation resides as accessed from
Mac OS X systems. For example, if the path given to
--root-dir was (/base/apps),
then the Mac path might be something like
(/Network/Servers/myserver/base/apps). This path will
vary depending on the details of how NFS volumes are mounted at
your site.
There is no default value and must be specified if --mac-support is given. --mac-prod-dir=dir
The absolute path to the root directory under which all
production data files will reside as accessed from Mac OS X
systems. For example, if the path given to --prod-dir was
(/base/prod) , then the Mac path might be something like
(/Network/Servers/myserver/base/prod). This path will
vary depending on the details of how NFS volumes are mounted at
your site.
There is no default value and must be specified if --mac-support is given.
--mac-home-dir=dir
The absolute path to the parent directory of all user home
directories as accessed from Mac OS X systems.
If not specified, this location defaults to (/Users).
The absolute path to the directory (dir) used to write various
temporary files generated by Pipeline programs on Mac OS X
systems. For optimal performance, this directory should
reside on a local file system.
If not specified, the temporary directory will default to
(/var/tmp).
--mac-local-vendor-javadoc-dir=dir
The Mac OS X path to the root directory where the documentation generated by javadoc for locally created Pipeline plugins and standalone utils is located. Providing this will allow users to easily access the documentation for locally created plugins from Pipeline's user interface.
If not specified, the default directory is the (root-install-directory/pipeline-latest/share/docs/local-javadocs) subdirectory of where Pipeline is installed. --mac-local-java-lib=dir
The Mac OS X path to an optional JAR file containing common Java class shared by a large number of locally created plugins and/or standalone utils. Any JARs provided using this option will be added to the Java classpath for all Pipeline programs. This is typically used for relatively large 3rd party libraries for things such as XML parsing or SQL database connections which would otherwise need to be embedded in many different plugin JARs. Since these libraries be dynamically updated (like plugins can), they are not suitable for anything which might need to modified without a Pipeline shutdown. This feature is only an optimization to reduce plugin size and memory footprint but is not required in order to use 3rd party Java libraries with Pipeline.
Windows XP Options
These options specify the paths to use from Windows XP hosts to
access the corresponding network file system directories as
specified for Linux hosts using the non-win versions of these
options. The location of the Java Runtime
Environment on the Windows XP hosts must also be specified. Note that the backslash character (\) used to delimit Windows file system paths is an escape character in UNIX shells. For this reason, all Windows directory paths passed to the following options should be specified using the forward slash (/) in place of the back slash. This means that in order to specify the native Windows path (C:\foo\bar) you will need to type (C:/foo/bar). Similarly, a native UNC path such as (\\server\share\foo\bar) will need to be specified as (//server/share/foo/bar). Also, if specifying a directory path which contains spaces, make sure you quote the entire path argument. --win-support Include a support for Windows XP client programs. If this option is specified, you must also supply the Windows specific paths to the root install directory (--win-root-dir), the root production directory (--win-prod-dir) and the Java Runtime location (--win-java-home). --win-root-dir=dir
The path to the directory (dir) under which the top-level
directory of the Pipeline installation resides as accessed from
Windows XP systems. For example, if the path given to
--root-dir was (/base/apps),
then the Windows path might be something like (Z:/base/apps) or
(//myserver/base/apps). This path will vary depending on
the details of how network file system volumes are accessed at
your site.
There is no default value and must be specified if --win-support is given. --win-prod-dir=dir
The absolute path to the root directory under which all
production data files will reside as accessed from Windows XP
systems. For example, if the path given to --prod-dir was
(/base/prod) , then the Windows path might be something like
(Z:/base/prod) or (//myserver/base/prod). This path will
vary depending on the details of how network file system
volumes are accessed at your site.
There is no default value and must be specified if --win-support is given.
--win-user-profile-dir=dir
--win-user-profile-no-username
The location of directory containing the Windows user profile
hive. Unless the --win-user-profile-no-username option
is used, this path needs to have the specific user name
appended to it in order to specify the actual directory where
the user's profile lives. Depending on site
configuration, the user profile directory may be either local
or on a network share. In either case, it should
contain at least the following well known Windows user
directories:
Application Data Desktop Favorites My Documents Start Menu Some site configurations may use a home share (UNC path) which does not contain the user's name, but is set by Windows to point to the specific users profile directory on the network file server. In cases like this, we recommend using a UNC path like (//myserver/homes) to avoid problems some application have with drive letter mappings in this context and use the --win-user-profile-no-username option. If not specified, the user profile location defaults to (C:/Documents and Settings) which will require an appended username.
--win-app-data-dir=dir --win-app-data-no-username In most cases the Windows "Application Data" directory is located simply under the user profile directory and need not be specified. However, some sites may wish to store this application specific data on a network share unrelated to the user profile. In cases like this, the path (dir) specified with --win-app-data-dir will specify alternative directory containing the "Applicata Data" directory for users. The specified directory may be configured at the site to automatically already point to a current user specific share or require that the username be appended to the specified path. Unless the --win-app-data-no-username option is specified, the specific username will need to be appended to the path specified by --win-app-data-dir in order to construct the actual directory path. If not specified, the application data directory defaults to the same as the user profile directory. --win-temp-dir=dir
The absolute path to the directory (dir) used to write various
temporary files generated by Pipeline programs on Windows XP
systems. For optimal performance, this directory should
reside on a local file system.
If not specified, the temporary directory will default to
(C:/WINDOWS/Temp).
--win-java-home=dir
The path to the root directory of the local Java Runtime
Environment installed on the Windows XP host. For
consitancy, the version of the JRE installed on the Windows
XP hosts should match the version used by Linux hosts and
used to run plconfig(1) itself. Since
the JRE will be installed in a much different location on
Windows XP hosts, it needs to be supplied in order for the
Pipeline client launcher scripts to function properly.
If not specified, the JRE home directory defaults to (C:/Program Files/Java/jdk1.6.0_18/jre). --win-local-vendor-javadoc-dir=dir
The Windows path to the root directory where the documentation generated by javadoc for locally created Pipeline plugins and standalone utils is located. Providing this will allow users to easily access the documentation for locally created plugins from Pipeline's user interface.
If not specified, the default directory is the (root-install-directory/pipeline-latest/share/docs/local-javadocs) subdirectory of where Pipeline is installed. --win-local-java-lib=dir
The Windows path to an optional JAR file containing common Java class shared by a large number of locally created plugins and/or standalone utils. Any JARs provided using this option will be added to the Java classpath for all Pipeline programs. This is typically used for relatively large 3rd party libraries for things such as XML parsing or SQL database connections which would otherwise need to be embedded in many different plugin JARs. Since these libraries be dynamically updated (like plugins can), they are not suitable for anything which might need to modified without a Pipeline shutdown. This feature is only an optimization to reduce plugin size and memory footprint but is not required in order to use 3rd party Java libraries with Pipeline.
See Also
Pipeline Programs
plid(1)
FilesAuthor
Created by Jim Callahan
of Temerity Software, Inc.
Copyright
Copyright
(c) 2002-2008 Temerity Software, Inc.
|
|||
|
|
|
||
|
|
|
||
|
|
|||