Add ssh command to list groups. Change-Id: Iaae73ec644e4f1ca631e8be1d90f7334ae5bd8c7 Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
diff --git a/Documentation/cmd-index.txt b/Documentation/cmd-index.txt index a6296b4..c3b165d 100644 --- a/Documentation/cmd-index.txt +++ b/Documentation/cmd-index.txt
@@ -54,6 +54,9 @@ 'gerrit approve':: 'Deprecated alias for `gerrit review`.' +link:cmd-ls-groups.html[gerrit ls-groups]:: + List groups visible to the caller. + link:cmd-ls-projects.html[gerrit ls-projects]:: List projects visible to the caller.
diff --git a/Documentation/cmd-ls-groups.txt b/Documentation/cmd-ls-groups.txt new file mode 100644 index 0000000..842abfd --- /dev/null +++ b/Documentation/cmd-ls-groups.txt
@@ -0,0 +1,44 @@ +gerrit ls-groups +================ + +NAME +---- +gerrit ls-groups - List groups visible to caller + +SYNOPSIS +-------- +[verse] +'ssh' -p <port> <host> 'gerrit ls-groups' + +DESCRIPTION +----------- +Displays the list of group names, one per line, that are visible to +the account of the calling user. + +If the caller is a member of the privileged 'Administrators' group, +all groups are listed. + +ACCESS +------ +Any user who has configured an SSH key. + +SCRIPTING +--------- +This command is intended to be used in scripts. + +EXAMPLES +-------- + +List visible groups: +===== + $ ssh -p 29418 review.example.com gerrit ls-groups + Administrators + Anonymous Users + MyProject_Committers + Project Owners + Registered Users +===== + +GERRIT +------ +Part of link:index.html[Gerrit Code Review]