Source

Steam Boiler /

Filename Size Date modified Message
doc
man
src
util
105 B
552 B
55 B
34.3 KB
2.2 KB
9.5 KB
3.3 KB
751 B
3.7 KB
725 B
362 B
44.1 KB
7.0 KB
6.2 KB
############
Steam Boiler
############

.. contents::

About
=====

Boiler is a script that wraps the steam program. It is intended to be an
alias for the steam command that any authorized user can access. Install
once; run anywhere. That's how it's supposed to be.

Features
========

Boiler provides the steam command to any authorized user. As an alias for the
the steam command, Boiler provides convenient extensions and a flexible command-line
interface. For example, all of the following represent the equivalent command::

    $ steam version
    $ steam -c version
    $ steam -c=version
    $ steam -com version
    $ steam -command version
    $ steam -command=version
    $ steam --command version
    $ steam --command=version

Requirements
============

A GNU/Linux system or compatible is needed.

There is nothing to compile, so no compilers are needed.

Boiler
    Requires:
        * HldsUpdateTool(Steam)
        * coreutils
        * util-linux

HldsUpdateTool(Steam)
    Requires:
        - abi: ELF32(SysV x86)
        - soname: ELF32/libc.so.6(SysV x86)
        - soname: ELF32/libdl.so.2(SysV x86)
        - soname: ELF32/libm.so.6(SysV x86)
        - soname: ELF32/libpthread.so.0(SysV x86)
    * uncompress(gzip)
    * tar

Installation
============

Installing is done by the following three commands::
    
    $ ./configure
    $ make
    # make install (as root)

For more configuration details run::
    
    $ ./configure --help

If there are any errors during compilation, check your build environment
and try to find the error, otherwise file a bug-report on the issue tracker
or contact one of the authors.

These files will be installed.

    * ${bindir}/boiler
    * ${bindir}/steam -> ${bindir}/boiler (symlink)
    * ${pkgdatadir}/hldsupdatetool
    * ${mandir}/man1/steam.1
    * ${mandir}/man1/boiler.1

Usage
=====

To run ``steam`` just type on a console::

    $ steam -command COMMAND [ -game NAME [ -dir PATH ] ] [ options ]

There are a few command line options. See the manual page or run for details::
    
    $ steam --help
    
Or look into the documention in the doc/ directory. 


Otherwise to run ``boiler`` just type on a console::

    $ boiler COMMAND [ --game NAME [ --dir PATH ] ] [ options ]

There are a few command line options. See the manual page or run for details::
    
    $ boiler --help
    
Or look into the documention in the doc/ directory. 


Mostly, ``boiler`` is intended to be an alias for the ``steam`` command so, the preferred
usage would be as follows::

    $ steam COMMAND [ --game NAME [ --dir PATH ] ] [ options ]
    
And so on...You get the idea.

License
=======

Boiler is distributed under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 3 of the License,
or (at your option) any later version. A copy of the license can be found in
the file COPYING included with the source code of the program. If not, see
<http://www.gnu.org/licenses/>.

The HldsUpdateTool(Steam) application (found in the subdirectory
hldsupdatetool/) has its own license, which can be found in the file LICENSE
included with the program.

Ideas, questions, patches and bug reports
=========================================

Home page:
    http://bitbucket.org/superstition/steam-boiler/wiki/

Primary distribution point:
    http://bitbucket.org/superstition/steam-boiler/downloads/

Ideas, questions, patches and bug reports:
    http://bitbucket.org/superstition/steam-boiler/issues/

If you add something, or fix a bug, please send a patch (in 'diff -u'
format) to the issue tracker or one of the authors listed below.

------------ -----   -----       ----       ---       --         -
Erik Southworth <erik(dot)southworth(at)gmail(dot)com>