aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/scatter.116
-rw-r--r--man/shoal.118
-rw-r--r--man/shock.117
3 files changed, 51 insertions, 0 deletions
diff --git a/man/scatter.1 b/man/scatter.1
new file mode 100644
index 00000000..95addd23
--- /dev/null
+++ b/man/scatter.1
@@ -0,0 +1,16 @@
+.TH SCATTER 1 "May 2014" "Manual page for scatter"
+.SH NAME
+.B scatter
+\- run a command on shoal(1) hosts
+.SH SYNOPSIS
+.B scatter
+.I COMMAND
+.SH DESCRIPTION
+.B scatter
+runs a nominated command on all the hosts returned by shoal(1), and prints the
+hostname, stdout, and stderr for each call.
+.SH SEE ALSO
+shock(1), shoal(1)
+.SH AUTHOR
+Tom Ryder <tom@sanctum.geek.nz>
+
diff --git a/man/shoal.1 b/man/shoal.1
new file mode 100644
index 00000000..2399f974
--- /dev/null
+++ b/man/shoal.1
@@ -0,0 +1,18 @@
+.TH SHOAL 1 "May 2014" "Manual page for shoal"
+.SH NAME
+.B shoal
+\- list the first hostname on each line of an ssh_config(5) file
+.SH SYNOPSIS
+.B shoal
+.I [SSH_CONFIG]
+.SH DESCRIPTION
+.B shoal
+reads an ssh_config(5) file, defaulting to ~/.ssh/config, and returns a
+newline-delimited list of the first of the hostnames on each Host line in the
+file, ignoring all other lines. Suitable for use in batch scripts like
+scatter(1).
+.SH SEE ALSO
+scatter(1), shock(1), ssh(1), ssh_config(5)
+.SH AUTHOR
+Tom Ryder <tom@sanctum.geek.nz>
+
diff --git a/man/shock.1 b/man/shock.1
new file mode 100644
index 00000000..0b64d504
--- /dev/null
+++ b/man/shock.1
@@ -0,0 +1,17 @@
+.TH SHOCK 1 "May 2014" "Manual page for shock"
+.SH NAME
+.B shock
+\- run a command on shoal(1) hosts and print the hostname if successful
+.SH SYNOPSIS
+.B shock
+.I COMMAND
+.SH DESCRIPTION
+.B shock
+runs a nominated command on all the hosts returned by shoal(1), and prints the
+hostname if the command has an exit value of 0. The stdout from the commands is
+discarded.
+.SH SEE ALSO
+scatter(1), shoal(1)
+.SH AUTHOR
+Tom Ryder <tom@sanctum.geek.nz>
+