mercurial/help/hg-ssh.8.txt
author Martin von Zweigbergk <martinvonz@google.com>
Wed, 19 Dec 2018 09:20:32 -0800
changeset 41019 fcc0a7ac9ebd
parent 30244 4e934804cafe
permissions -rw-r--r--
help: show "[no-]" only for default-on Flags As Anton (av6) pointed out, the "[no-]" is confusing for action flags like `hg bookmark --delete`. We could come up with a way of indicating which flags are action flags (e.g. use None for the default value instead of False). However, it's probably also unlikely that users will want to negate even non-action flags like --hidden. One of the more common flags where the "[no-]" prefix would be useful is `hg evolve --update`. The reason it's helpful there is that it defaults to on. So I think we can simply include "[no-]" only for flags that are on by default (and thus require the user to add the "[no-]" for the option to have any effect). Note that there are use cases for negating flags that already off by default. For example, you may have an alias for `hg log -G --hidden -T foo` and now want to pass "--no-hidden" to that alias. However, I think that users who want that are likely to be advanced enough that they've already learnt about the "no-" prefix by seeing it somewhere else. Differential Revision: https://phab.mercurial-scm.org/D5454
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29090
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
     1
========
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
     2
 hg-ssh
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
     3
========
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
     4
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
     5
----------------------------------------
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
     6
restricted ssh login shell for Mercurial
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
     7
----------------------------------------
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
     8
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
     9
:Author:         Thomas Arendsen Hein <thomas@intevation.de>
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    10
:Organization:   Mercurial
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    11
:Manual section: 8
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    12
:Manual group:   Mercurial Manual
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    13
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    14
.. contents::
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    15
   :backlinks: top
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    16
   :class: htmlonly
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    17
   :depth: 1
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    18
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    19
Synopsis
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    20
""""""""
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    21
**hg-ssh** repositories...
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    22
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    23
Description
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    24
"""""""""""
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    25
**hg-ssh** is a wrapper for ssh access to a limited set of mercurial repos.
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    26
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    27
To be used in ~/.ssh/authorized_keys with the "command" option, see sshd(8):
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    28
command="hg-ssh path/to/repo1 /path/to/repo2 ~/repo3 ~user/repo4" ssh-dss ...
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    29
(probably together with these other useful options:
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    30
no-port-forwarding,no-X11-forwarding,no-agent-forwarding)
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    31
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    32
This allows pull/push over ssh from/to the repositories given as arguments.
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    33
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    34
If all your repositories are subdirectories of a common directory, you can
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    35
allow shorter paths with:
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    36
command="cd path/to/my/repositories && hg-ssh repo1 subdir/repo2"
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    37
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    38
You can use pattern matching of your normal shell, e.g.:
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    39
command="cd repos && hg-ssh user/thomas/* projects/{mercurial,foo}"
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    40
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    41
You can also add a --read-only flag to allow read-only access to a key, e.g.:
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    42
command="hg-ssh --read-only repos/\*"
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    43
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    44
Bugs
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    45
""""
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    46
Probably lots, please post them to the mailing list (see Resources_
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    47
below) when you find them.
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    48
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    49
See Also
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    50
""""""""
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    51
|hg(1)|_
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    52
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    53
Author
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    54
""""""
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    55
Written by Matt Mackall <mpm@selenic.com>
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    56
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    57
Resources
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    58
"""""""""
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    59
Main Web Site: https://mercurial-scm.org/
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    60
30244
4e934804cafe help: replace selenic.com by mercurial-scm.org in man pages
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 29090
diff changeset
    61
Source code repository: https://www.mercurial-scm.org/repo/hg
29090
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    62
30244
4e934804cafe help: replace selenic.com by mercurial-scm.org in man pages
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 29090
diff changeset
    63
Mailing list: https://www.mercurial-scm.org/mailman/listinfo/mercurial/
29090
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    64
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    65
Copying
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    66
"""""""
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    67
Copyright (C) 2005-2016 Matt Mackall.
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    68
Free use of this software is granted under the terms of the GNU General
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    69
Public License version 2 or any later version.
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    70
7b52cb384c38 hg-ssh: copy doc string to man page
Sean Farley <sean@farley.io>
parents:
diff changeset
    71
.. include:: common.txt