gitolite/doc/report-output.mkd

# output of the "info" and "expand" commands

Running "ssh git@server info" or "ssh git@server expand" gives you certain
output.  This doclet describes the output; you're welcome to help me make it
clearer :)

There are 3 columns of permissions (create, read, and write) in the output,
although the first column is often blank.

Here is the output of the 2 commands (info and expand):

### the "info" command

Usage:

    ssh git@server info [optional_pattern [list of users]]

The "info" command shows you all the repos (and repo patterns) in the config
file that you have been given any kind of access to.  If you supply an
optional pattern the output will be limited to repos matching that pattern.
If you're an admin you can append a list of users to see their permissions
instead of your own; in this mode the pattern is mandatory, even if you just
use `.` to cheat.  (Side note: if you installed using easy-install that would
probably be `ssh gitolite info`, by the way).

The meaning of C, R, and W are self-explanatory, but they might sometimes be
prefixed by a symbol.  For example, `@R` means that `@all` users have
beengiven this access, and `#R` means that this user is a "superuser" (think
root's shell prompt) and so has access to `@all` repos.

### the "expand" command

Usage:

    ssh git@server expand [optional_pattern]

The "expand" command trawls through all the repositories on the server,
limiting to repos matching the pattern you provide (default is all repos
found).

For each repo found, it searches for it in the config -- either the actual
repo entry (when the repo is not a wildcard repo), or an entry for the
wildcard that matches it -- and reports permissions.  It also takes into
account extra permissions enabled by the `setperms` command (see
doc/4-wildcard-repositories.mkd).  It shows you the "creator" of the repo as
an additional column, defaulting to `<gitolite>` if it was not a wildcard
repo.