Pigskin

Program Options


Pigskin Home
 
Pigskin Documentation

This document describes the full set of options available when the Pigskin program is run. Before the options are described, it is necessary to point out a few notes:

  • Pigskin (either client or server) is always run by invoking the pigskin.PigskinDriver class. All options are passed to this class as command line arguments.
  • There are a basic set of options available to all Pigskin clients. But because the Pigskin client is a version-managed application, you must connect to a Pigskin server to see what additional options are required and allowed by that server version. The basic options only allow you to specify how Pigskin will run (as client or server), and connect to a server (if being run as a client). All other options are version-specific. Unless otherwise noted, version-specific options are only meaningful if the program is being run in the client mode.
    • Also, all client versions will accept all options of all previous versions unless otherwise noted.


    General Format of Command Line Arguments

    Command line arguments to Pigskin have a specific format. If this format is not followed, The program may return an error or operate incorrectly. Arguments that are preceded by -- are flags that tell the system to operate in a certain way. Arguments preceded by - are options in which the argument that follows is considered to be the value of the option.


    Basic Command Line Arguments

    Argument Description Allowed Values
    -m Specifies which mode in which to run Pigskin client (default) -- runs the Pigskin client
    server -- runs the Pigskin server
    wrapper -- runs Pigskin client in wrapper mode (version 1.01 Alpha and later)
    -h (required in client mode) Tells a Pigskin client what host the Pigskin server is running on. This option is meaningless when running Pigskin as a server. Any valid hostname
    -p If the mode is server, this argument specifies which port to bind to. If the mode is client, this argument tells the client which port to connect to. 7832 (default)
    Any valid port



    Pigskin Client Version 1.00a Arguments

    Argument Description Allowed Values
    -a (required in client mode) Provides the name of the application to update or deploy Any string that represents a known application on the server
    -d Specifies the directory of the application to be updated or deployed. This directory must already exist. Default is the current working directory. Any valid directory path can be specified.
    -v Specifies where to find and save the Pigskin version file for the application. Default is a file called PIGVER in the application directory. This value must be a path relative to the application directory.
    --multiple If present, the application is saved in the application directory in "multiple version" mode. That is, each downloaded version gets its own subdirectory. N/A
    --app-version If present, Pigskin will output the version of the specified application and then exit. In this case, unnecessary arguments are ignored. N/A


    Pigskin Client Version 1.01a Arguments
    Note that to use the new options in this version, the client must be running all the 1.01 Alpha binaries -- the ClientModule101a object is not sufficient.

    Argument Description Allowed Values
    --module-versions Prints out a list of modules available on the client. Can be used without connecting to a server. N/A
    -module-version Specifies a module version to use for local operations. Can be used without connecting to a server. A string describing a Pigskin module version.
    -wrapper-command Specifies which command to run after updating the application in wrapper mode. This command has only has meaning in wrapper mode. A command to be run on the system which starts the updated application.