Merge pull request #67 from toshi0383/man-page

Add missing man-pages

CHANGELOG.md

@@ -1,5 +1,8 @@
 ## master
 ##### Enhancement
+* Add missing man-pages [#67](https://github.com/toshi384/cmdshelf/pull/67)  
+  [Toshihiro Suzuki](https://github.com/toshi0383)
+
 * Use $PAGER for spawning man-page process if specified [#66](https://github.com/toshi384/cmdshelf/pull/66)  
   [Toshihiro Suzuki](https://github.com/toshi0383)
 

Sources/cmdshelf/Arguments.swift

@@ -11,11 +11,7 @@ struct Alias {
 
 enum SubCommand: String {
 
-    case run, list, remote, blob, cat, update, help
-
-    var possiblyHasManPage: Bool {
-        return [.list].contains(self)
-    }
+    case blob, cat, help, list, remote, run, update
 }
 
 // - MARK: ArgumentParser

Sources/cmdshelf/Commands.swift

@@ -107,11 +107,7 @@ final class HelpCommand: Command {
             return
         }
         let subCommand = try SubCommandArgument().parse(parser)
-        if subCommand.possiblyHasManPage {
-            if spawnPager(cmdString: "man cmdshelf-\(subCommand.rawValue)") != 0 {
-                queuedPrintln(subCommand.helpMessage)
-            }
-        } else {
+        if spawnPager(cmdString: "man cmdshelf-\(subCommand.rawValue)") != 0 {
             queuedPrintln(subCommand.helpMessage)
         }
     }

doc/man/man1/cmdshelf-blob.1

@@ -0,0 +1,15 @@
+.TH "CMDSHELF-BLOB" "1" "February 2018" "cmdshelf 0.9.3" "Cmdshelf Manual"
+.SH "NAME"
+cmdshelf-blob - Manage blobs
+.SH "SYNOPSIS"
+\fBcmdshelf blob\fR <command> [<args>]
+.SH "DESCRIPTION"
+.TP
+The blob subcommand manages blobs.
+.SH "SUB-COMMANDS"
+.SS add <name> <url>
+Add a blob named <name> at <url>. <url> can be a network URL or a local filepath.
+.SS list
+List blobs.
+.SS remove <name>
+Remove the blob named <name>.

doc/man/man1/cmdshelf-cat.1

@@ -0,0 +1,8 @@
+.TH "CMDSHELF-CAT" "1" "February 2018" "cmdshelf 0.9.3" "Cmdshelf Manual"
+.SH "NAME"
+cmdshelf-cat - Concatenate and print command(s).
+.SH "SYNOPSIS"
+\fBcmdshelf cat\fR [[<remoteName>:]<command>]
+.SH "DESCRIPTION"
+.TP
+The cat subcommand reads commands script files sequentially, writing them to the standard output.

doc/man/man1/cmdshelf-list.1

@@ -2,7 +2,7 @@
 .SH "NAME"
 cmdshelf-list - Show all registered commands.
 .SH "SYNOPSIS"
-\fIcmdshelf list\fR [\-\-path]
+\fBcmdshelf list\fR [\-\-path]
 .SH "DESCRIPTION"
 .TP
 The list subcommand lists all commands from remotes and blobs.

doc/man/man1/cmdshelf-remote.1

@@ -0,0 +1,15 @@
+.TH "CMDSHELF-REMOTE" "1" "February 2018" "cmdshelf 0.9.3" "Cmdshelf Manual"
+.SH "NAME"
+cmdshelf-remote - Manage set of tracked repositories
+.SH "SYNOPSIS"
+\fBcmdshelf remote\fR <command> [<args>]
+.SH "DESCRIPTION"
+.TP
+Manage the set of repositories ("remotes").
+.SH "SUB-COMMANDS"
+.SS add <name> <url>
+Adds a remote named <name> for the repository at <url>.
+.SS list
+List tracked remotes.
+.SS remove <name>
+Remove the remote named <name>. This won't remove the cloned local repository. Clean on your own if needed.

doc/man/man1/cmdshelf-run.1

@@ -0,0 +1,13 @@
+.TH "CMDSHELF-RUN" "1" "February 2018" "cmdshelf 0.9.3" "Cmdshelf Manual"
+.SH "NAME"
+cmdshelf-run - Execute command
+.SH "SYNOPSIS"
+\fBcmdshelf run\fR [<remoteName>:]<command> [<args>]
+.SH "DESCRIPTION"
+.TP
+The run subcommand receives command-alias and whitespace separated list of parameters.
+.SH "AVOIDING NAMESPACE CONFLICT"
+.TP
+
+The \fBrun\fR subcommand picks up first command matches the <command>. If you have same command names from different remotes, add <\fBremoteName\fR>: prefix to to be explicit.
+    e.g. cmdshelf run myRemote:echo-sd hello

doc/man/man1/cmdshelf-update.1

@@ -0,0 +1,8 @@
+.TH "CMDSHELF-UPDATE" "1" "February 2018" "cmdshelf 0.9.3" "Cmdshelf Manual"
+.SH "NAME"
+cmdshelf-update - Update cloned local repositories.
+.SH "SYNOPSIS"
+\fBcmdshelf update\fR
+.SH "DESCRIPTION"
+.TP
+The \fBupdate\fR subcommand updates each cloned repositories.

doc/man/man1/cmdshelf.1

@@ -13,7 +13,7 @@ to see more detailed manual page for each sub-command.
 .SS blob
 Manage blob commands.
 .SS cat
-Concatenate and print sourcecodes of commands.
+Concatenate and print command(s).
 .SS help
 Show help message.
 .SS list