doc/hgrc.5.txt
changeset 9835 6a07e74370d7
parent 9830 ab1625ccf3a9
child 10102 1720d70cd6d4
child 10209 c9194a7d7d3e
equal deleted inserted replaced
9834:655ac26ad63e 9835:6a07e74370d7
   144 Authentication credentials for HTTP authentication. Each line has
   144 Authentication credentials for HTTP authentication. Each line has
   145 the following format::
   145 the following format::
   146 
   146 
   147     <name>.<argument> = <value>
   147     <name>.<argument> = <value>
   148 
   148 
   149 where <name> is used to group arguments into authentication entries.
   149 where ``<name>`` is used to group arguments into authentication
   150 Example::
   150 entries. Example::
   151 
   151 
   152     foo.prefix = hg.intevation.org/mercurial
   152     foo.prefix = hg.intevation.org/mercurial
   153     foo.username = foo
   153     foo.username = foo
   154     foo.password = bar
   154     foo.password = bar
   155     foo.schemes = http https
   155     foo.schemes = http https
   201 Filter patterns are globs by default, rooted at the repository root.
   201 Filter patterns are globs by default, rooted at the repository root.
   202 For example, to match any file ending in ``.txt`` in the root
   202 For example, to match any file ending in ``.txt`` in the root
   203 directory only, use the pattern ``*.txt``. To match any file ending
   203 directory only, use the pattern ``*.txt``. To match any file ending
   204 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
   204 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
   205 
   205 
   206 The filter command can start with a specifier, either "pipe:" or
   206 The filter command can start with a specifier, either ``pipe:`` or
   207 "tempfile:". If no specifier is given, "pipe:" is used by default.
   207 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
   208 
   208 
   209 A "pipe:" command must accept data on stdin and return the transformed
   209 A ``pipe:`` command must accept data on stdin and return the transformed
   210 data on stdout.
   210 data on stdout.
   211 
   211 
   212 Pipe example::
   212 Pipe example::
   213 
   213 
   214   [encode]
   214   [encode]
   219   [decode]
   219   [decode]
   220   # recompress gzip files when writing them to the working dir (we
   220   # recompress gzip files when writing them to the working dir (we
   221   # can safely omit "pipe:", because it's the default)
   221   # can safely omit "pipe:", because it's the default)
   222   *.gz = gzip
   222   *.gz = gzip
   223 
   223 
   224 A "tempfile:" command is a template. The string INFILE is replaced
   224 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
   225 with the name of a temporary file that contains the data to be
   225 with the name of a temporary file that contains the data to be
   226 filtered by the command. The string OUTFILE is replaced with the name
   226 filtered by the command. The string ``OUTFILE`` is replaced with the name
   227 of an empty temporary file, where the filtered data must be written by
   227 of an empty temporary file, where the filtered data must be written by
   228 the command.
   228 the command.
   229 
   229 
   230 .. note:: The tempfile mechanism is recommended for Windows systems,
   230 .. note:: The tempfile mechanism is recommended for Windows systems,
   231    where the standard shell I/O redirection operators often have
   231    where the standard shell I/O redirection operators often have
   254 ``defaults``
   254 ``defaults``
   255 """"""""""""
   255 """"""""""""
   256 
   256 
   257 (defaults are deprecated. Don't use them. Use aliases instead)
   257 (defaults are deprecated. Don't use them. Use aliases instead)
   258 
   258 
   259 Use the [defaults] section to define command defaults, i.e. the
   259 Use the ``[defaults]`` section to define command defaults, i.e. the
   260 default options/arguments to pass to the specified commands.
   260 default options/arguments to pass to the specified commands.
   261 
   261 
   262 The following example makes ``hg log`` run in verbose mode, and ``hg
   262 The following example makes ``hg log`` run in verbose mode, and ``hg
   263 status`` show only the modified files, by default::
   263 status`` show only the modified files, by default::
   264 
   264 
   304     email addresses.
   304     email addresses.
   305 ``bcc``
   305 ``bcc``
   306     Optional. Comma-separated list of blind carbon copy recipients'
   306     Optional. Comma-separated list of blind carbon copy recipients'
   307     email addresses. Cannot be set interactively.
   307     email addresses. Cannot be set interactively.
   308 ``method``
   308 ``method``
   309     Optional. Method to use to send email messages. If value is "smtp"
   309     Optional. Method to use to send email messages. If value is ``smtp``
   310     (default), use SMTP (see the SMTP_ section for configuration).
   310     (default), use SMTP (see the SMTP_ section for configuration).
   311     Otherwise, use as name of program to run that acts like sendmail
   311     Otherwise, use as name of program to run that acts like sendmail
   312     (takes "-f" option for sender, list of recipients on command line,
   312     (takes ``-f`` option for sender, list of recipients on command line,
   313     message on stdin). Normally, setting this to "sendmail" or
   313     message on stdin). Normally, setting this to ``sendmail`` or
   314     "/usr/sbin/sendmail" is enough to use sendmail to send messages.
   314     ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
   315 ``charsets``
   315 ``charsets``
   316     Optional. Comma-separated list of character sets considered
   316     Optional. Comma-separated list of character sets considered
   317     convenient for recipients. Addresses, headers, and parts not
   317     convenient for recipients. Addresses, headers, and parts not
   318     containing patches of outgoing messages will be encoded in the
   318     containing patches of outgoing messages will be encoded in the
   319     first character set to which conversion from local encoding
   319     first character set to which conversion from local encoding
   588   hookname = python:modulename.submodule.callable
   588   hookname = python:modulename.submodule.callable
   589   hookname = python:/path/to/python/module.py:callable
   589   hookname = python:/path/to/python/module.py:callable
   590 
   590 
   591 Python hooks are run within the Mercurial process. Each hook is
   591 Python hooks are run within the Mercurial process. Each hook is
   592 called with at least three keyword arguments: a ui object (keyword
   592 called with at least three keyword arguments: a ui object (keyword
   593 "ui"), a repository object (keyword "repo"), and a "hooktype"
   593 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
   594 keyword that tells what kind of hook is used. Arguments listed as
   594 keyword that tells what kind of hook is used. Arguments listed as
   595 environment variables above are passed as keyword arguments, with no
   595 environment variables above are passed as keyword arguments, with no
   596 ``HG_`` prefix, and names in lower case.
   596 ``HG_`` prefix, and names in lower case.
   597 
   597 
   598 If a Python hook returns a "true" value or raises an exception, this
   598 If a Python hook returns a "true" value or raises an exception, this