Permalink
Browse files

Updated man pages

  • Loading branch information...
1 parent 34565ff commit 1d43e11cf47b1c0c4c6d2142331e3ecb05413686 @jfloff jfloff committed Aug 30, 2012
Showing with 107 additions and 4 deletions.
  1. +1 −1 Readme.md
  2. +28 −1 man/powder.1
  3. +39 −1 man/powder.1.html
  4. +39 −1 man/powder.1.ronn
View
@@ -78,7 +78,7 @@ powder manages [pow](http://pow.cx/)
# then the first listed domain will be opened.
$ powder open --browser Safari
- => Opens the pow link in a specific browser (Safari in this case)
+ => Opens the pow link in a specific browser (in this case, Safari)
# Also aliased as -b
$ powder open -b 'Google Chrome'
View
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "POWDER" "1" "November 2011" "" ""
+.TH "POWDER" "1" "August 2012" "" ""
.
.SH "NAME"
\fBpowder\fR \- manage Pow Rack server
@@ -63,6 +63,9 @@ powder will attempt to read \.powder, which names a default symlink for the curr
=> Create \.powder, contents bacon
.
.P
+\fB$ powder default\fR => Link the current dir to ~/\.pow/default # Serve this directory for all unhandled domains
+.
+.P
For both forms of link, if the current directory doesn\'t look like an app that can be powed it will offer to download a basic \fBconfig\.ru\fR for Rails 2
.
.SS "Unlinking applications"
@@ -134,6 +137,15 @@ For both forms of link, if the current directory doesn\'t look like an app that
.br
# then the first listed domain will be opened\.
.
+.P
+\fB$ powder open \-\-browser Safari\fR => Opens the pow link in a specific browser (in this case, Safari) # Also aliased as \-b
+.
+.P
+\fB$ powder open \-b \'Google Chrome\'\fR => Opens the pow link with browsers with more than one word
+.
+.P
+# Should also works with all the other \'open\' options: \fB$ powder open bacon \-b Safari\fR \fB$ powder open \-\-xip \-b Firefox\fR \fB$ powder \-o \-x \-b \'Google Chrome\'\fR
+.
.SS "Managing application restarts"
\fB$ powder restart\fR
.
@@ -176,6 +188,18 @@ For both forms of link, if the current directory doesn\'t look like an app that
.br
# ~/Library/Logs/Pow/apps/#{app\-directory}\.log
.
+.SS "Working with Environment Variables"
+\fB$ powder env\fR => Displays your current custom pow environment variables # Pow reads environment varialbles from \.powenv
+.
+.P
+\fB$ powder env_reset\fR => Deletes your \.powevn, removing all custom environment variables\.
+.
+.P
+\fB$ powder env BACON chunky\fR => Pass an arbitrary environment variable to pow, eg, ENV["BACON"] = "chunky" # Remove an ENV by passing in no value, eg: powder env BACON # If you already have a \.gitignore, the newly created \.powenv will also be ignored automatically\.
+.
+.P
+\fB$ powder [production|development|test]\fR => Run your Rails app as Production # aliased as powder [prod|dev] # This is a wrapper for powder env RAILS_ENV \.\.\.
+.
.SS "Installing and uninstalling Pow"
\fB$ powder install\fR
.
@@ -215,5 +239,8 @@ For both forms of link, if the current directory doesn\'t look like an app that
.br
=> Disable Pow
.
+.P
+\fB$ powder debug\fR => Opens a debug shell with your application environment
+.
.SH "AUTHOR"
Built by rodreegez \fIhttps://github\.com/Rodreegez\fR and philnash \fIhttps://github\.com/philnash\fR\.
View
@@ -111,6 +111,10 @@ <h3 id="Linking-applications-in-Pow">Linking applications in Pow</h3>
=> Link the current dir to ~/.pow/bacon<br />
=> Create .powder, contents bacon</p>
+<p> <code>$ powder default</code>
+ => Link the current dir to ~/.pow/default
+ # Serve this directory for all unhandled domains</p>
+
<p>For both forms of link, if the current directory doesn't
look like an app that can be powed it will offer to download
a basic <strong>config.ru</strong> for Rails 2</p>
@@ -153,6 +157,18 @@ <h3 id="Working-with-applications">Working with applications</h3>
# if you have set up alternative top level domains in .powconfig,<br />
# then the first listed domain will be opened.</p>
+<p> <code>$ powder open --browser Safari</code>
+ => Opens the pow link in a specific browser (in this case, Safari)
+ # Also aliased as -b</p>
+
+<p> <code>$ powder open -b 'Google Chrome'</code>
+ => Opens the pow link with browsers with more than one word</p>
+
+<p> # Should also works with all the other 'open' options:
+ <code>$ powder open bacon -b Safari</code>
+ <code>$ powder open --xip -b Firefox</code>
+ <code>$ powder -o -x -b 'Google Chrome'</code></p>
+
<h3 id="Managing-application-restarts">Managing application restarts</h3>
<p> <code>$ powder restart</code><br />
@@ -176,6 +192,25 @@ <h3 id="Working-with-logs">Working with logs</h3>
# Not the application log, but the pow log, available at<br />
# ~/Library/Logs/Pow/apps/#{app-directory}.log</p>
+<h3 id="Working-with-Environment-Variables">Working with Environment Variables</h3>
+
+<p> <code>$ powder env</code>
+ => Displays your current custom pow environment variables
+ # Pow reads environment varialbles from .powenv</p>
+
+<p> <code>$ powder env_reset</code>
+ => Deletes your .powevn, removing all custom environment variables.</p>
+
+<p> <code>$ powder env BACON chunky</code>
+ => Pass an arbitrary environment variable to pow, eg, ENV["BACON"] = "chunky"
+ # Remove an ENV by passing in no value, eg: powder env BACON
+ # If you already have a .gitignore, the newly created .powenv will also be ignored automatically.</p>
+
+<p> <code>$ powder [production|development|test]</code>
+ => Run your Rails app as Production
+ # aliased as powder [prod|dev]
+ # This is a wrapper for powder env RAILS_ENV ...</p>
+
<h3 id="Installing-and-uninstalling-Pow">Installing and uninstalling Pow</h3>
<p> <code>$ powder install</code><br />
@@ -198,14 +233,17 @@ <h3 id="Enabling-and-Disabling-Pow">Enabling and Disabling Pow</h3>
<p> <code>$ powder down</code><br />
=> Disable Pow</p>
+<p> <code>$ powder debug</code>
+ => Opens a debug shell with your application environment</p>
+
<h2 id="AUTHOR">AUTHOR</h2>
<p>Built by <a href="https://github.com/Rodreegez">rodreegez</a> and <a href="https://github.com/philnash">philnash</a>.</p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
- <li class='tc'>November 2011</li>
+ <li class='tc'>August 2012</li>
<li class='tr'>powder(1)</li>
</ol>
View
@@ -38,7 +38,11 @@ powder will attempt to read .powder, which names a default symlink for the curre
`$ powder link [bacon] --force`
=> Remove the current pow symlink, and .powder
=> Link the current dir to ~/.pow/bacon
- => Create .powder, contents bacon
+ => Create .powder, contents bacon
+
+ `$ powder default`
+ => Link the current dir to ~/.pow/default
+ # Serve this directory for all unhandled domains
For both forms of link, if the current directory doesn't
look like an app that can be powed it will offer to download
@@ -82,6 +86,18 @@ a basic **config.ru** for Rails 2
# if you have set up alternative top level domains in .powconfig,
# then the first listed domain will be opened.
+ `$ powder open --browser Safari`
+ => Opens the pow link in a specific browser (in this case, Safari)
+ # Also aliased as -b
+
+ `$ powder open -b 'Google Chrome'`
+ => Opens the pow link with browsers with more than one word
+
+ # Should also works with all the other 'open' options:
+ `$ powder open bacon -b Safari`
+ `$ powder open --xip -b Firefox`
+ `$ powder -o -x -b 'Google Chrome'`
+
### Managing application restarts
`$ powder restart`
@@ -105,6 +121,25 @@ a basic **config.ru** for Rails 2
# Not the application log, but the pow log, available at
# ~/Library/Logs/Pow/apps/#{app-directory}.log
+### Working with Environment Variables
+
+ `$ powder env`
+ => Displays your current custom pow environment variables
+ # Pow reads environment varialbles from .powenv
+
+ `$ powder env_reset`
+ => Deletes your .powevn, removing all custom environment variables.
+
+ `$ powder env BACON chunky`
+ => Pass an arbitrary environment variable to pow, eg, ENV["BACON"] = "chunky"
+ # Remove an ENV by passing in no value, eg: powder env BACON
+ # If you already have a .gitignore, the newly created .powenv will also be ignored automatically.
+
+ `$ powder [production|development|test]`
+ => Run your Rails app as Production
+ # aliased as powder [prod|dev]
+ # This is a wrapper for powder env RAILS_ENV ...
+
### Installing and uninstalling Pow
`$ powder install`
@@ -127,6 +162,9 @@ a basic **config.ru** for Rails 2
`$ powder down`
=> Disable Pow
+ `$ powder debug`
+ => Opens a debug shell with your application environment
+
## AUTHOR
Built by [rodreegez](https://github.com/Rodreegez) and [philnash](https://github.com/philnash).

0 comments on commit 1d43e11

Please sign in to comment.