Steam Boiler / doc / source / man-pages.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

Reading the boiler Man Page

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

  • $ man boiler
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.