Permalink
Browse files

documented hub, fixed doc generator

  • Loading branch information...
1 parent 7960eba commit 680e4dbb4e22f9cb6ea9f2a33d725af0a7279151 @substack committed Apr 12, 2012
Showing with 23 additions and 1 deletion.
  1. +1 −1 doc/commands
  2. +2 −0 doc/generate.sh
  3. +20 −0 doc/hub.markdown
View
@@ -4,7 +4,7 @@ The commands are:
deploy Push code to drones.
drone Connect to a hub as a worker.
exec Run commands on drones.
- hub Create a hub for drones to listen to.
+ hub Create a hub for drones to connect.
monitor Show events and process output system-wide.
ps List the running processes on the drones.
remote Manage the set of remote hubs.
View
@@ -1,4 +1,6 @@
#!/bin/bash
+mkdir -p man1
+
for file in doc/*.markdown; do
./node_modules/.bin/ronn --roff "$file" \
> man1/$(echo "$file" | sed -e 's/\.markdown$/.1/; s/^doc\///')
View
@@ -0,0 +1,20 @@
+fleet-hub(1) -- Create a hub for drones to connect.
+===================================================
+
+## SYNOPSIS
+
+ fleet hub [<options>]
+
+## DESCRIPTION
+
+This command will create and update a file called `fleet.json` in your git
@Raynos

Raynos Jul 17, 2012

Liar. This is fleet remote description

+project root so that you don't need to type `--hub` and `--secret` all the time.
+
+## OPTIONS
+
+* --port - port to listen on
+* --secret - optional plaintext passphrase
+
+## EXAMPLE
+
+ fleet hub --port=7000 --secret=beepboop

0 comments on commit 680e4db

Please sign in to comment.