rebuilding man page

This commit is contained in:
David Dollar
2011-03-08 12:18:11 -05:00
parent 6e4224a0e7
commit 0b4cff586c
+29 -4
View File
@@ -66,9 +66,11 @@
<a href="#EXPORTING">EXPORTING</a> <a href="#EXPORTING">EXPORTING</a>
<a href="#OPTIONS">OPTIONS</a> <a href="#OPTIONS">OPTIONS</a>
<a href="#EXPORT-FORMATS">EXPORT FORMATS</a> <a href="#EXPORT-FORMATS">EXPORT FORMATS</a>
<a href="#JSON-EXPORT">JSON EXPORT</a>
<a href="#INITTAB-EXPORT">INITTAB EXPORT</a> <a href="#INITTAB-EXPORT">INITTAB EXPORT</a>
<a href="#UPSTART-EXPORT">UPSTART EXPORT</a> <a href="#UPSTART-EXPORT">UPSTART EXPORT</a>
<a href="#PROCFILE">PROCFILE</a> <a href="#PROCFILE">PROCFILE</a>
<a href="#DEFAULT-OPTIONS">DEFAULT OPTIONS</a>
<a href="#EXAMPLES">EXAMPLES</a> <a href="#EXAMPLES">EXAMPLES</a>
<a href="#COPYRIGHT">COPYRIGHT</a> <a href="#COPYRIGHT">COPYRIGHT</a>
</div> </div>
@@ -155,11 +157,19 @@ application.</dd>
<p>foreman currently supports the following output formats:</p> <p>foreman currently supports the following output formats:</p>
<ul> <ul>
<li><p>json</p></li>
<li><p>inittab</p></li> <li><p>inittab</p></li>
<li><p>upstart</p></li> <li><p>upstart</p></li>
</ul> </ul>
<h2 id="JSON-EXPORT">JSON EXPORT</h2>
<p>Will export your processes as JSON:</p>
<pre><code>{ "web": { "command": "bundle exec thin start" } }
</code></pre>
<h2 id="INITTAB-EXPORT">INITTAB EXPORT</h2> <h2 id="INITTAB-EXPORT">INITTAB EXPORT</h2>
<p>Will export a chunk of inittab-compatible configuration:</p> <p>Will export a chunk of inittab-compatible configuration:</p>
@@ -186,8 +196,23 @@ will be structured to make the following commands valid:</p>
<p>A Procfile should contain both a name for the process and the command used <p>A Procfile should contain both a name for the process and the command used
to run it.</p> to run it.</p>
<pre><code>web: bundle exec thin start <pre><code>web: bundle exec thin start
job: bundle exec rake jobs:work job: bundle exec rake jobs:work
</code></pre>
<p>You can validate your Procfile format using the <code>check</code> command</p>
<pre><code>$ foreman check
</code></pre>
<h2 id="DEFAULT-OPTIONS">DEFAULT OPTIONS</h2>
<p>If a <code>.foreman</code> file exists in the current directory, default options will
be read from it. This file should be in YAML format with the long option
name as keys. Example:</p>
<pre><code>concurrency: alpha=0
port: 15000
</code></pre> </code></pre>
<h2 id="EXAMPLES">EXAMPLES</h2> <h2 id="EXAMPLES">EXAMPLES</h2>
@@ -213,8 +238,8 @@ job: bundle exec rake jobs:work
<ol class='man-decor man-foot man foot'> <ol class='man-decor man-foot man foot'>
<li class='tl'>Foreman 0.10.0</li> <li class='tl'>Foreman 0.11.1</li>
<li class='tc'>December 2010</li> <li class='tc'>March 2011</li>
<li class='tr'>foreman(1)</li> <li class='tr'>foreman(1)</li>
</ol> </ol>