git-multi.1 in git-multi-1.1.0

- old
+ new

@@ -1,15 +1,15 @@
 '\" t
 .\"     Title: git-multi
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 11/01/2018
+.\"      Date: 11/09/2018
 .\"    Manual: Git Manual
 .\"    Source: Git 2.19.1.542.gc4df23f792.dirty
 .\"  Language: English
 .\"
-.TH "GIT\-MULTI" "1" "11/01/2018" "Git 2\&.19\&.1\&.542\&.gc4df23" "Git Manual"
+.TH "GIT\-MULTI" "1" "11/09/2018" "Git 2\&.19\&.1\&.542\&.gc4df23" "Git Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .\" http://bugs.debian.org/507673
@@ -29,31 +29,54 @@
 .\" -----------------------------------------------------------------
 .SH "NAME"
 git-multi \- execute the same git command in multiple repositories
 .SH "VERSION"
 .sp
-This is \fBv1\&.0\&.10\fR of \fIgit multi\fR \&... hooray!
+This is \fBv1\&.1\&.0\fR of \fIgit multi\fR \&... hooray!
 .SH "SYNOPSIS"
 .sp
 There are some options for \fBgit multi\fR itself, in which case it is invoked as follows:
 .sp
 .nf
-\fIgit multi\fR <dash_dash_option> [<option_arguments>]
+\fIgit multi\fR \-\-<option> [<option_arguments>]
 .fi
 .sp
 .sp
 To execute the same git command in multiple repositories, the invocation is as follows:
 .sp
 .nf
 \fIgit multi\fR <git_command> [<git_command_arguments>]
 .fi
 .sp
+.sp
+Both ways of running \fBgit multi\fR take an optional, so\-called "multi repo" argument to limit the operation to the list of repositories in the referenced "multi repo", ie\&. a single GitHub user or a single GitHub organization:
+.sp
+.nf
+\fIgit multi\fR ++<multi_repo> \-\-<option> [<option_arguments>]
+.fi
+.sp
+.sp
+and\&...
+.sp
+.nf
+\fIgit multi\fR ++<multi_repo> <git_command> [<git_command_arguments>]
+.fi
+.sp
 .SH "DESCRIPTION"
 .sp
-Convenient way to execute the same git command in a set of related repos, currently the repositories of a GitHub user, incl\&. the organizations they are a member of; the repo list is determined via a GitHub API v3 call, and cached locally \fI(in binary format)\fR for performance and offline usage\&.
+Convenient way to execute the same git command in a set of related repos, currently the repositories of a GitHub user, incl\&. the organizations they are a member of\&.
+.sp
+The list of repositories is determined via a GitHub API v3 call, and cached locally \fI(in binary format)\fR for performance and offline usage\&.
+.sp
+By default, \fBgit multi\fR operates on all repositories for all configured users and all configured organizations\&. To limit the operation to a single user or a single organization, the optional \fB++<multi_repo>\fR argument can be used\&.
 .SH "OPTIONS"
 .PP
+\-\-version
+.RS 4
+print out this script\(cqs version number
+.RE
+.PP
 \-\-help
 .RS 4
 you\(cqre looking at it: show the man page
 .RE
 .PP
@@ -65,13 +88,13 @@
 \-\-check
 .RS 4
 checks all the required settings and configurations
 .RE
 .PP
-\-\-version
+\-\-count
 .RS 4
-print out this script\(cqs version number
+print out the count of repos (per type)
 .RE
 .PP
 \-\-refresh
 .RS 4
 refresh the list of user & organization repos
@@ -80,15 +103,10 @@
 \-\-json
 .RS 4
 output repository details to JSON
 .RE
 .PP
-\-\-count
-.RS 4
-print out the count of repos (per type)
-.RE
-.PP
 \-\-list
 .RS 4
 print out the names of all repos
 .RE
 .PP
@@ -110,18 +128,20 @@
 \-\-paths
 .RS 4
 print out the full path for each repos
 .RE
 .PP
-\-\-spurious
+\-\-missing
 .RS 4
-list cloned repos whose remote doesn\(cqt match a github\&.com origin
+print out names of repos that haven\(cqt been cloned
 .RE
 .PP
-\-\-missing
+\-\-clone
 .RS 4
-print out names of repos that haven\(cqt been cloned
+clones missing repositories into
+\fB${HOME}/Workarea\fR
+(by default)
 .RE
 .PP
 \-\-stale
 .RS 4
 list repos that have been deleted on github\&.com
@@ -130,14 +150,12 @@
 \-\-excess
 .RS 4
 list repos that don\(cqt exist on github\&.com
 .RE
 .PP
-\-\-clone
+\-\-spurious
 .RS 4
-clones missing repositories into
-\fB${HOME}/Workarea\fR
-(by default)
+list cloned repos whose remote doesn\(cqt match a github\&.com origin
 .RE
 .PP
 \-\-query (args)
 .RS 4
 query GitHub repo metadata for each repository