Source

Steam Boiler / doc / source / using-steam-boiler.rst

Erik Southworth 0cb5343 



Erik Southworth 74a73f9 
Erik Southworth 0cb5343 

























































Erik Southworth 74a73f9 


Erik Southworth 78d7014 
Erik Southworth 0cb5343 

Erik Southworth 78d7014 
Erik Southworth 0cb5343 


Erik Southworth 74a73f9 

Erik Southworth 0cb5343 


Erik Southworth 74a73f9 
Erik Southworth 0cb5343 

















Erik Southworth 74a73f9 


Erik Southworth 78d7014 
Erik Southworth 74a73f9 


Erik Southworth 0cb5343 






Erik Southworth 74a73f9 
Erik Southworth 0cb5343 




















Erik Southworth 71485a2 

Erik Southworth 0cb5343 

Erik Southworth 78d7014 
Erik Southworth 0cb5343 












Erik Southworth 78d7014 
Erik Southworth 0cb5343 















Erik Southworth 78d7014 
Erik Southworth 0cb5343 





































Erik Southworth 78d7014 
Erik Southworth 0cb5343 











Erik Southworth 74a73f9 
Erik Southworth 0cb5343 










Erik Southworth 74a73f9 
Erik Southworth 0cb5343 

















Erik Southworth 74a73f9 

Erik Southworth 0cb5343 


Erik Southworth 74a73f9 
Erik Southworth 0cb5343 



Erik Southworth 74a73f9 



Erik Southworth 0cb5343 

Erik Southworth 74a73f9 
Erik Southworth 0cb5343 
Erik Southworth 74a73f9 


Erik Southworth 78d7014 
Erik Southworth 0cb5343 

Erik Southworth 74a73f9 


Erik Southworth 0cb5343 



Erik Southworth 78d7014 
Erik Southworth 0cb5343 



Erik Southworth 71485a2 






































Erik Southworth 0cb5343 

.. -*- reStructuredText -*-

    This is part of the Linux Source DS Reference Manual.
        Copyright (c) 2010,2012 Erik Southworth <erik.southworth@gmail.com>
    See the file COPYING.rst for copying conditions.

.. include:: includes/links.rst

######################
Howto Use Steam-Boiler
######################

:info: Download steam-boiler_ to install steam and boiler.
:author: Erik Southworth
:version: |version|
:revision: |today|
:description: Linux Reference Manual

Command-line Syntax
===================

The basic command-line syntax is of the following form and conforms to POSIX guidelines.

.. code-block:: none

  steam <command> [game] [dir] [options]

.. hint::

    Arguments surrounded by '<>' denote a required option (i.e. ``<command>``).
    Those surrounded by '[]' denote optional arguments (i.e. ``[dir]``).

Using **steam** requires understanding the command-line options. There
are several ways to discover this. One is the command's built-in usage
guide called `help`. Another way to learn the options is by reading the
manual pages.

Using the --help option
=======================

To start using **steam** just ask for help. This is one of the ``[options]``

    * $ steam --help

.. code-block:: none

    [~]$ steam --help
    Half-Life Dedicated Server Update Tool (Steam Boiler)

    Usage:
      steam <command> [game] [dir] [options]

    Main operation mode:
      -c, --command=CMD, CMD
              update <game>     install or update dedicated server
              version           display installed versions
              list              show available games

      -g, --game=NAME, NAME     name of game (use --command=list to see available games)
      -d, --dir=PATH, PATH      path to install directory (default=last-run-path)

    Options:
      -a, --verify_all          verifies all files are up to date (over-write control)
      -r, --retry               retry every 30sec if Steam Network is busy
      -s, --nobootstrapupdate   do not check for updates to the update tool
      -i, --interactive, console  drop into the Steam Console Client (c) Valve Corporation

    Example:
      steam update css /home/user/gameserver

      (Use --verbose to get a full option listing)


To get the full help output use the --verbose option.

    * $ steam --help --verbose


.. code-block:: none

    [~]$ steam --help --verbose
    Half-Life Dedicated Server Update Tool (Steam Boiler)

    Usage:
      steam <command> [game] [dir] [options]

    Main operation mode:
      -c, --command=CMD, CMD
              update <game>     install or update dedicated server
              version           display installed versions
              list              show available games

      -g, --game=NAME, NAME     name of game (use --command=list to see available games)
      -d, --dir=PATH, PATH      path to install directory (default=last-run-path)

    Options:
      -a, --verify_all          verifies all files are up to date (over-write control)
      -r, --retry               retry every 30sec if Steam Network is busy
      -s, --nobootstrapupdate   do not check for updates to the update tool
      -i, --interactive, console  drop into the Steam Console Client (c) Valve Corporation
      -u, --username=USERNAME   steam account username (only needed to access limited content)
      -p, --password=PASSWORD   steam account password (only needed to access limited content)
      -t, --remember_password   remember password (if a username is supplied)
      -h, --help, help          display usage guide
      -V, --version             display version and copyright information
      -w, --wipe, wipe [PATH]   remove blob files (ClientRegistry, InstallRecord from PATH)
      -b, --beta=NAME           name of beta update
      -i, --info                beta help information
      -m, --manual              output manual text
      -v, --verbose             verbose operation
      -n, --noionice            disable ionice operation

    Mandatory or optional arguments to long options are also mandatory or
    optional for any corresponding short options.

    Report bugs to: <http://bitbucket.org/superstition/steam-boiler/issues/>
    Steam Boiler home page: <http://bitbucket.org/superstition/steam-boiler/wiki/>

.. tip::

    Options are proceeded by the ``-`` delimiter character (i.e. ``steam
    -help``). **Steam-Boiler** also recognizes options proceeded by the
    ``--`` delimiter character (i.e. ``steam --help``) and positional
    arguments for some options (i.e. ``steam help``). Positional
    arguments omit the delimiter character. The ordering of options
    using the delimiter character ``-`` or ``--`` is unimportant but
    positional arguments must be given in the order of the usage syntax
    for **Steam-Boiler** to understand them.

    Option-arguments are denoted in all-capital lettering and are
    considered variables to be specified by the user. Option-arguments
    with the ``=`` prefix are considered required. (i.e. ``--dir=PATH``
    would be used as ``--dir=/home/user/gameserver`` or ``--dir
    /home/user/gameserver``)

The original help text is also available but is not so clearly read. Just
use the **steam** command with NO options.

    * $ steam

.. code-block:: none

    [~]$ steam
    Use: steam -command <command> [parameters] [flags]

    Commands:

     update: Install or update HLDS

       parameters:
          -game <game>            -   Game name (use '-command list' to see available games)
          -dir <installdir>       -   HLDS Install dir
          (if dir not specified, will use value from last run of tool)

       flags:
          -verify_all             -   Verify all HLDS files are up to date
          -retry                  -   Automatically retry every 30 seconds if the Steam Network is busy
          -remember_password      -   Remember password (if a username is supplied)

       For example: steam -command update -game cstrike -dir /hlds

     version: View installed versions

     list: View available games

    Optional parameters for all commands:

          -nobootstrapupdate      -   Do not check for updates to the update tool

.. note::

    The original steam command does not understand any options using
    other than the ``-`` delimiter character (i.e. ``-command list``).

Using the --command option
==========================

.. code-block:: none

    Usage:
      steam <command> [game] [dir] [options]

From the 'help' usage guide it's clear that the first command-line
argument must be a command. This is a required argument even though
it's still considered a command-line option. There are three available
commands to choose from. ``update``, ``version`` & ``list``. These are
the 'command' option-arguments and it is required to choose one. The
``update`` option-argument requires a ``game`` be specified as well.

.. code-block:: none

    -c, --command=CMD, CMD
              update <game>     install or update dedicated server
              version           display installed versions
              list              show available games

Using the --command list option-argument
========================================

The ``list`` option-argument is used to show available games that can be installed.

    * $ steam --command list

.. code-block:: none

    [~]$ steam --command list
    Checking bootstrapper version ...
    ** 'game' options for Source DS Install:

        "Counter-Strike Source"
        "ageofchivalry"
        "alienswarm"
        "cssbeta"
        "diprip"
        "dods"
        "dystopia"
        "episode1"
        "esmod"
        "garrysmod"
        "garrysmodbeta"
        "hl2mp"
        "insurgency"
        "l4d_full"
        "left4dead"
        "left4dead2"
        "left4dead2_demo"
        "orangebox"
        "pvkii"
        "smashball"
        "synergy"
        "tf"
        "tf_beta"
        "zps"

    ** 'game' options for HL1 DS Install:

        "cstrike"
        "cstrike_beta"
        "czero"
        "dmc"
        "dod"
        "gearbox"
        "ricochet"
        "tfc"
        "valve"

    ** 'game' options for Third-Party game servers:

        "ageofchivalry"
        "aliensvspredator"
        "americasarmy3"
        "brink"
        "darkesthour"
        "darkmessiah"
        "defencealliance2"
        "dinodday"
        "diprip"
        "dystopia"
        "esmod"
        "garrysmod"
        "garrysmodbeta"
        "hauntedhellsreach"
        "homefront"
        "homefrontjpn"
        "insurgency"
        "killingfloor"
        "killingfloor_beta"
        "marenostrum"
        "modernwarfare3"
        "mondaynightcombat"
        "naturalselection2"
        "nexuiz"
        "pvkii"
        "redorchestra"
        "redorchestra2"
        "redorchestra_beta"
        "serioussam3"
        "serioussamhdse"
        "ship"
        "sin"
        "smashball"
        "sniperelitev2"
        "synergy"
        "tshb"
        "zps"

Using the --interactive option
==============================

The ``--interactive`` option is used to drop into the Steam Console Client (c) Valve Corporation.

    * $ steam --interactive

        or

    * $ steam console

.. code-block:: none

    [~]$ steam console
    [  0%] Checking for available updates...
    [  0%] Download complete.
    [----] Verifying installation...
    Steam Console Client (c) Valve Corporation
    -- type 'quit' to exit --
    Loading Steam3...OK.
    Loading Steam2...OK.

    Steam>help

    Help topics - type "help <topic>" for more information:

                   login : Logging in to Steam
                 scripts : Executing a sequence of commands via a script file
             commandline : Executing commands directly via the OS command line
                 convars : Options and settings that affect this program session
               app_build : Building Steam application content (only for licensed Steam application developers)
              app_update : Installing/updating a Steam application on the local filesystem (EG dedicated servers)


    You can also type "find <string>" to see a list of all commands and convars that contain or reference <string>.


    Steam>

More to Come ...
================