Steam Boiler /

Filename Size Date modified Message
hldsupdatetool
src
35 B
2.5 KB
44 B
34.3 KB
1.1 KB
818 B
4.0 KB
34 B
1.8 KB
2.2 KB
1.5 KB
############
Steam Boiler
############

.. contents::

About
=====

Boiler is a script that wraps the steam program. As an alias for the
the steam command, that any authorized user can access, Boiler provides
convenient extensions and a flexible command-line interface. Install once;
run anywhere. That's how it's supposed to be.

Features
========

1.) Boiler requires only a single installation per host or site. It can
    be easily used from /usr or /usr/local and still maintains the ability
    to accept self-updates, even while owned by root (no SUID required).

2.) No more having to place steam into every server base directory. If
    envoked with an explicit directory option argument, Boiler will
    automatically create symlinks to represent a steam instance where
    usually needed.

3.) The command-line interface is shorter and more flexible. If careful
    to order the arguments, an update command can be as simple as
    ``steam update tf``.

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)

The default ``configure`` uses ``--prefix=/usr/local`` and this works fine.
Run ``./configure``, with some options if you wish. The standard options
are documented in the INSTALL file. The most interesting ones are
the usual ``--prefix=/usr``.

For more configuration details run::

    $ ./configure --help

If there are any errors during configuration, 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 CMD [-game NAME] [-dir PATH] [options]

There are a few command line options. See the manual page or run for details::

    $ steam


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

    $ boiler <cmd> [game] [directory] [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 <cmd> [game] [directory] [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, 2009 (s6v)

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.