Source

Steam Boiler / doc / source / man-pages.rst

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 78d7014 
Erik Southworth 0cb5343 
Erik Southworth 78d7014 
Erik Southworth 0cb5343 


















Erik Southworth 74a73f9 


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 74a73f9 
Erik Southworth 0cb5343 






















Erik Southworth 74a73f9 


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 78d7014 
.. -*- reStructuredText -*-

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

.. include:: includes/links.rst

#######################
HowTo Read Manual Pages
#######################

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

Linux Manual Pages
==================

Linux stores it's online documentation in the form of short
concise manuals, so-called 'man pages'. They typically give just
enough information to be used as reference but do not go into great
detail. **Steam-Boiler** installs two such manuals, one for **steam**
and one for **boiler**. These manuals can be accessed using reader
utilities such as ``man`` or the superior ``pinfo``. HTML versions are
also available in the /doc directory included with the **Steam-Boiler**
distribution package and on the internet at http:srcds.info.

Reading the steam Man Page
--------------------------

Here is an example of using the ``man`` command to display the **steam** man page.

    * $ man steam

.. code-block:: none

    [~]$ man steam

    steam(6)                             Linux Reference Manual                             steam(6)

    NAME
           steam - Half-Life Dedicated Server Update Tool

    SYNOPSIS
           steam -command CMD [ -game NAME ] [ -dir PATH ] [ options ]

    DESCRIPTION
           The  steam  program  is  an  application that will update an existing Half-Life Dedicated
           Server installation to the latest version or  will  download  the  latest  version  (from
           scratch) if an existing version is not found.

    OPTIONS
           -command CMD

                  update <-game NAME>
                         Install or update dedicated server.

                  version
                         View installed versions.

                  list   View available games.

           -game NAME
                  Name  of  game  to request from content servers.  Use -command list to determine a
                  valid option-argument.

           -dir PATH
                  Path to installation directory. Game content is installed in  the  directory  tree
                  rooted at the PATH given as an option-argument. If no argument is given, the value
                  stored from the last-run-path is used.

                  The current directory PATH may be specified using the shell’s (dot) operator as an
                  option-argument: (e.g., -dir .)

                  HLDS and SRCDS engine games must be installed to separate directories.

                  Multiple  copies  of the server can be installed by specifying a different PATH in
                  subsequent invocations, but to save time/bandwidth downloading files, it’s  better
                  to copy an existing install.

                  Even  better,  than  copying a whole directory tree, is to use the --symbolic-link
                  (-s) option of the GNU cp utility, (e.g., cp  -s  SOURCE  DEST).  This  creates  a
                  shadow  directory  with  symbolic  links instead of duplicating files. We can then
                  safely replace individual symbolic links with copies of the actual files  we  wish
                  to  modify.  This also makes it easy to determine which modifications belong to us
                  and require backup.

           -verify_all
                  Verifies all files are up to date (over-write control).   This  option  may  cause
                  content  files  which  have been edited to be returned to original format. Caution
                  should be used to ensure proper backup of any files which have been edited, other‐
                  wise those modifications may be lost.

           -retry Automatically retry every 30 seconds if the Steam Network is busy.

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

           -username USERNAME
                  Steam account username (only needed to access limited content)

           -password PASSWORD
                  Steam account password (only needed to access limited content)

           -password PASSWORD
                  Steam account password (only needed to access limited content)

           -remember_password
                  Remember password (if a username is supplied)

    EXAMPLE
           View listing of available games:

               $ steam -command list

           Install or update Counter-Strike Source located in user $HOME/gameserver directory:

               $ steam -command update -game ’counter-strike source’ -dir ~/gameserver

    FILES
           These are automatically generated as output. In the event of errors or corruption, remove
           them from the system.

           $HOME/Steam/ClientRegistry.blob
                  Steam client configuration data

           PATH/InstallRecord.blob
                  Game content installation record

    AUTHOR
           Manual written by Erik Southworth; referenced from usage and README file.

    COPYRIGHT
           Copyright (c) Valve Corporation, 2006
                  This is non-free software: see the LICENSE file included  with  the  software  for
                  copying conditions.

           Copyright (c) Erik Southworth, 2009, 2012
                  This is free documentation: copying and distribution of this manual, with or with‐
                  out modification, are permitted in any medium without royalty provided  the  copy‐
                  right notice and this notice are preserved.

    SEE ALSO
           boiler(6) cp(1)

           About Steam
                  http://store.steampowered.com/about/

           Steampowered Forums
                  http://store.steampowered.com/forums/

           Mailing Lists
                  http://list.valvesoftware.com/mailman/listinfo

    Steam Boiler 49.1                           21 April 2012                                 steam(6)

Reading the boiler Man Page
---------------------------

Here is an example of using the ``man`` command to display the **boiler** man page.

    * $ man boiler

.. code-block:: none

    [~]$ man boiler

    boiler(6)                            Linux Reference Manual                            boiler(6)

    NAME
           boiler - steam program wrapper

    SYNOPSIS
           boiler < command > [ game ] [ dir ] [ options ]

    DESCRIPTION
           The  boiler  script  is a wrapper for the steam program and as an alias for the the steam
           program, provides convenient extensions and gives users access to the steam program  from
           a single, central installation.

           The  boiler  program  will  install  a copy of the steam program to the user configuation
           directory $HOME/Steam, as required, then, execute and pass option arguments to the  steam
           program.

           To  enable automatic server updates; as when using the -autoupdate option of the hlds_run
           or srcds_run (run-script); boiler will create the steam symbolic link, in  the  directory
           local to the run-script.

    OPTIONS
           These are alternative extensions to steam(6):

           -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)

           -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

    EXAMPLE
           View listing of available games:

               $ steam list

           Install or update Counter-Strike Source located in user $HOME/gameserver directory:

               $ steam update css ~/gameserver

    FILES
           $HOME/Steam/last-run-path
                  The last directory path that was processed.

    AUTHOR
           Written by Erik Southworth

    REPORTING BUGS
           http://bitbucket.org/superstition/steam-boiler/issues/

    COPYRIGHT
           Copyright (c) Erik Southworth, 2009,2010,2011,2012
                  This  is  free  software:  see  the source for copying conditions. You are free to
                  change and redistribute it. There is NO WARRANTY, to the extent permitted by  law.
                  This is free documentation: copying and distribution of this manual, with or with‐
                  out modification, are permitted in any medium without royalty provided  the  copy‐
                  right notice and this notice are preserved.

    SEE ALSO
           steam(6)

    Steam Boiler 49.1                           04 August 2012                               boiler(6)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.