Mercurial > hg
changeset 29090:7b52cb384c38 stable
hg-ssh: copy doc string to man page
This corrects a warning from lintian that we're shipping an executable without
a man page. Since there is a doc string in the text, let's use that for the man
page.
| author | Sean Farley <sean@farley.io> |
|---|---|
| date | Fri, 06 May 2016 23:03:41 -0700 |
| parents | 222b8170d69e |
| children | 5573b0f8dc28 |
| files | doc/gendoc.py mercurial/help/hg-ssh.8.txt tests/test-install.t |
| diffstat | 3 files changed, 73 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/gendoc.py Fri May 06 17:53:06 2016 -0500 +++ b/doc/gendoc.py Fri May 06 23:03:41 2016 -0700 @@ -136,6 +136,7 @@ extrahelptable = [ (["common"], '', loaddoc('common')), (["hg.1"], '', loaddoc('hg.1')), + (["hg-ssh.8"], '', loaddoc('hg-ssh.8')), (["hgignore.5"], '', loaddoc('hgignore.5')), (["hgrc.5"], '', loaddoc('hgrc.5')), (["hgignore.5.gendoc"], '', loaddoc('hgignore')),
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/help/hg-ssh.8.txt Fri May 06 23:03:41 2016 -0700 @@ -0,0 +1,71 @@ +======== + hg-ssh +======== + +---------------------------------------- +restricted ssh login shell for Mercurial +---------------------------------------- + +:Author: Thomas Arendsen Hein <thomas@intevation.de> +:Organization: Mercurial +:Manual section: 8 +:Manual group: Mercurial Manual + +.. contents:: + :backlinks: top + :class: htmlonly + :depth: 1 + +Synopsis +"""""""" +**hg-ssh** repositories... + +Description +""""""""""" +**hg-ssh** is a wrapper for ssh access to a limited set of mercurial repos. + +To be used in ~/.ssh/authorized_keys with the "command" option, see sshd(8): +command="hg-ssh path/to/repo1 /path/to/repo2 ~/repo3 ~user/repo4" ssh-dss ... +(probably together with these other useful options: +no-port-forwarding,no-X11-forwarding,no-agent-forwarding) + +This allows pull/push over ssh from/to the repositories given as arguments. + +If all your repositories are subdirectories of a common directory, you can +allow shorter paths with: +command="cd path/to/my/repositories && hg-ssh repo1 subdir/repo2" + +You can use pattern matching of your normal shell, e.g.: +command="cd repos && hg-ssh user/thomas/* projects/{mercurial,foo}" + +You can also add a --read-only flag to allow read-only access to a key, e.g.: +command="hg-ssh --read-only repos/\*" + +Bugs +"""" +Probably lots, please post them to the mailing list (see Resources_ +below) when you find them. + +See Also +"""""""" +|hg(1)|_ + +Author +"""""" +Written by Matt Mackall <mpm@selenic.com> + +Resources +""""""""" +Main Web Site: https://mercurial-scm.org/ + +Source code repository: http://selenic.com/hg + +Mailing list: http://selenic.com/mailman/listinfo/mercurial + +Copying +""""""" +Copyright (C) 2005-2016 Matt Mackall. +Free use of this software is granted under the terms of the GNU General +Public License version 2 or any later version. + +.. include:: common.txt