Skip to content
Browse files

update manifest

  • Loading branch information...
1 parent 2f13e31 commit e3819666a4f0dc9870303be3e2c98d39e384d2cd @copiousfreetime committed
Showing with 28 additions and 295 deletions.
  1. +2 −1 Manifest.txt
  2. +2 −22 man/stickler-passenger-config.1
  3. +9 −99 man/stickler-server.1
  4. +15 −173 man/stickler.1
View
3 Manifest.txt
@@ -2,7 +2,7 @@ CONTRIBUTING.md
HISTORY.md
LICENSE
Manifest.txt
-README.rdoc
+README.md
Rakefile
bin/stickler
bin/stickler-passenger-config
@@ -83,4 +83,5 @@ spec/spec.opts
spec/spec_helper.rb
spec/spec_lite_spec.rb
tasks/default.rake
+tasks/man.rake
tasks/this.rb
View
24 man/stickler-passenger-config.1
@@ -19,30 +19,10 @@ stickler\-passenger\-config \- output a Phusion Passenger config for stickler
\fInginx\fR: Output an Nginx config\.
.
.SH "OPTIONS"
-\fI\-h, \-\-help\fR:
-.
-.IP "" 4
-.
-.nf
-
-Show the help message
-.
-.fi
-.
-.IP "" 0
+\fI\-h, \-\-help\fR: Show the help message
.
.P
-\fI\-v, \-\-version\fR:
-.
-.IP "" 4
-.
-.nf
-
-Output the version\.
-.
-.fi
-.
-.IP "" 0
+\fI\-v, \-\-version\fR: Output the version\.
.
.SH "EXAMPLES"
Output a passenger config for use with apache\.
View
108 man/stickler-server.1
@@ -13,121 +13,31 @@ stickler\-server \- start and stop the stickler server process
stickler\-server is the daemon process that houses the repositories of proprietary gems and/or mirrors of third party gems\.
.
.SH "COMMANDS"
-\fIstart\fR:
-.
-.IP "" 4
-.
-.nf
-
-Start the stickler server process
-.
-.fi
-.
-.IP "" 0
+\fIstart\fR: Start the stickler server process
.
.P
-\fIstop\fR:
-.
-.IP "" 4
-.
-.nf
-
-Stop the stickler server process
-.
-.fi
-.
-.IP "" 0
+\fIstop\fR: Stop the stickler server process
.
.SH "OPTIONS"
-\fI\-d, \-\-daemonize\fR:
-.
-.IP "" 4
-.
-.nf
-
-Daemonize the server
-.
-.fi
-.
-.IP "" 0
+\fI\-d, \-\-daemonize\fR: Daemonize the server
.
.P
-\fI\-\-help\fR:
-.
-.IP "" 4
-.
-.nf
-
-Show the help message
-.
-.fi
-.
-.IP "" 0
+\fI\-\-help\fR: Show the help message
.
.P
-\fI\-h, \-\-host\fR=\'HOST\':
-.
-.IP "" 4
-.
-.nf
-
-The host address to bind to (default: 0\.0\.0\.0)
-.
-.fi
-.
-.IP "" 0
+\fI\-h, \-\-host\fR=\'HOST\': The host address to bind to (default: 0\.0\.0\.0)
.
.P
-\fI\-o, \-\-port\fR=\'PORT\':
-.
-.IP "" 4
-.
-.nf
-
-The port to bind to (default: 6789)
-.
-.fi
-.
-.IP "" 0
+\fI\-o, \-\-port\fR=\'PORT\': The port to bind to (default: 6789)
.
.P
-\fI\-p, \-\-pid\fR=\'PID_FILE\':
-.
-.IP "" 4
-.
-.nf
-
-Path to wriate a pid file to after daemonizing
-.
-.fi
-.
-.IP "" 0
+\fI\-p, \-\-pid\fR=\'PID_FILE\': Path to wriate a pid file to after daemonizing
.
.P
-\fI\-s, \-\-server\fR=\'SERVER\':
-.
-.IP "" 4
-.
-.nf
-
-The rack handler to use: thin, mongrel, webrick, etc\.
-.
-.fi
-.
-.IP "" 0
+\fI\-s, \-\-server\fR=\'SERVER\': The rack handler to use: thin, mongrel, webrick, etc\.
.
.P
-\fI\-v, \-\-version\fR:
-.
-.IP "" 4
-.
-.nf
-
-Output the version\.
-.
-.fi
-.
-.IP "" 0
+\fI\-v, \-\-version\fR: Output the version\.
.
.SH "EXAMPLES"
Start the server, daemonized, using /var/lib/stickler as the root directory of all the repositories\.
View
188 man/stickler.1
@@ -16,210 +16,52 @@ Stickler is a tool to organize and maintain an internal gem repository of propri
The stickler(1) command interacts with an instance of stickler\-server(1) to control the publishing and mirroring of ruby gems\.
.
.SH "COMMANDS"
-\fIpush\fR:
-.
-.IP "" 4
-.
-.nf
-
-Push one or more gems to a gemserver\. This works the same as `gem push`
-although there is no authorization mechanism\.
-.
-.fi
-.
-.IP "" 0
+\fIpush\fR: Push one or more gems to a gemserver\. This works the same as \fBgem push\fR although there is no authorization mechanism\.
.
.P
-\fIyank\fR:
-.
-.IP "" 4
-.
-.nf
-
-Remove a gem from the gemserver\'s index\. It will still be available from
-direct download\. This works the same as `gem yank`\.
-.
-.fi
-.
-.IP "" 0
+\fIyank\fR: Remove a gem from the gemserver\'s index\. It will still be available from direct download\. This works the same as \fBgem yank\fR\.
.
.P
-\fImirror\fR:
-.
-.IP "" 4
-.
-.nf
-
-Pull a specific version of a gem from an upstream gem server and
-store it in a stickler\-server(1)\.
-.
-.fi
-.
-.IP "" 0
+\fImirror\fR: Pull a specific version of a gem from an upstream gem server and store it in a stickler\-server(1)\.
.
.P
-\fIconfig\fR:
-.
-.IP "" 4
-.
-.nf
-
-Access or update the stickler client configuration\.
-.
-.fi
-.
-.IP "" 0
+\fIconfig\fR: Access or update the stickler client configuration\.
.
.P
-\fIlist\fR:
-.
-.IP "" 4
-.
-.nf
-
-List all the gems in the remote repository\.
-.
-.fi
-.
-.IP "" 0
+\fIlist\fR: List all the gems in the remote repository\.
.
.P
-\fIunyank\fR:
-.
-.IP "" 4
-.
-.nf
-
-Put a gem that was _yanked_ back into the gemserver index\. This reverses a
-`yank`\.
-.
-.fi
-.
-.IP "" 0
+\fIunyank\fR: Put a gem that was \fIyanked\fR back into the gemserver index\. This reverses a \fByank\fR\.
.
.SH "OPTIONS"
These are the options for all commands\. Not all options apply to all commands\.
.
.P
-\fI\-a, \-\-add\fR:
-.
-.IP "" 4
-.
-.nf
-
-Add the `\-\-server` or `\-\-upstream` items to the config file when using the
-`config` command\.
-.
-.fi
-.
-.IP "" 0
+\fI\-a, \-\-add\fR: Add the \fB\-\-server\fR or \fB\-\-upstream\fR items to the config file when using the \fBconfig\fR command\.
.
.P
-\fI\-d, \-\-debug\fR:
-.
-.IP "" 4
-.
-.nf
-
-Output debug information
-.
-.fi
-.
-.IP "" 0
+\fI\-d, \-\-debug\fR: Output debug information
.
.P
-\fI\-g, \-\-gem\-version\fR=\'VERSION\':
-.
-.IP "" 4
-.
-.nf
-
-The version of the gem to yank from `\-\-server` or to mirror from
-`\-\-upstream`\.
-.
-.fi
-.
-.IP "" 0
+\fI\-g, \-\-gem\-version\fR=\'VERSION\': The version of the gem to yank from \fB\-\-server\fR or to mirror from \fB\-\-upstream\fR\.
.
.P
-\fI\-h, \-\-help\fR:
-.
-.IP "" 4
-.
-.nf
-
-Show the help message
-.
-.fi
-.
-.IP "" 0
+\fI\-h, \-\-help\fR: Show the help message
.
.P
-\fI\-l, \-\-list\fR:
-.
-.IP "" 4
-.
-.nf
-
-Display the current configuration when using the `config` command\.
-.
-.fi
-.
-.IP "" 0
+\fI\-l, \-\-list\fR: Display the current configuration when using the \fBconfig\fR command\.
.
.P
-\fI\-p, \-\-platform\fR=\'PLATFORM\':
-.
-.IP "" 4
-.
-.nf
-
-The platform of the gem to yank from `\-\-server` or to mirror from
-`\-\-upstream` (e\.g\. ruby, java, mswin32)
-.
-.fi
-.
-.IP "" 0
+\fI\-p, \-\-platform\fR=\'PLATFORM\': The platform of the gem to yank from \fB\-\-server\fR or to mirror from \fB\-\-upstream\fR (e\.g\. ruby, java, mswin32)
.
.P
-\fI\-s, \-\-server\fR=\'SERVER\':
-.
-.IP "" 4
-.
-.nf
-
-The gem server or stickler\-server(1) URL\. This is used by all the commands\.
-.
-.fi
-.
-.IP "" 0
+\fI\-s, \-\-server\fR=\'SERVER\': The gem server or stickler\-server(1) URL\. This is used by all the commands\.
.
.P
-\fI\-u, \-\-upstream\fR=\'SERVER\':
-.
-.IP "" 4
-.
-.nf
-
-The upstream server from which to mirror a gem when using the `mirror`
-command\.
-.
-.fi
-.
-.IP "" 0
+\fI\-u, \-\-upstream\fR=\'SERVER\': The upstream server from which to mirror a gem when using the \fBmirror\fR command\.
.
.P
-\fI\-v, \-\-version\fR:
-.
-.IP "" 4
-.
-.nf
-
-Output the version\.
-.
-.fi
-.
-.IP "" 0
+\fI\-v, \-\-version\fR: Output the version\.
.
.SH "CONFIGURATION"
Stickler uses the \fB\.gem/stickler\fR file to hold its configuration\. It is a yaml file and Currently there are two options\. These are altered using the \fBstickler config\fR command\.

0 comments on commit e381966

Please sign in to comment.
Something went wrong with that request. Please try again.