Mercurial > public > mercurial-scm > hg-stable

comparison mercurial/help.py @ 7693:e040f9d6b2f3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
consolidated url help into urls help topic and added information about path aliases
author Bill Barry <after.fallout@gmail.com>
date Thu, 22 Jan 2009 11:02:50 -0700
parents b19850c7908a
children 14a42208d8af
comparison
equal deleted inserted replaced
7692:a55de9e2726f 7693:e040f9d6b2f3
329 first starting with a tab character. 329 first starting with a tab character.
330 - urlescape: Any text. Escapes all "special" characters. For example, 330 - urlescape: Any text. Escapes all "special" characters. For example,
331 "foo bar" becomes "foo%20bar". 331 "foo bar" becomes "foo%20bar".
332 - user: Any text. Returns the user portion of an email address. 332 - user: Any text. Returns the user portion of an email address.
333 ''')), 333 ''')),
334
335 (['urls'], _('Url Paths'),
336 _(r'''
337 Valid URLs are of the form:
338
339 local/filesystem/path (or file://local/filesystem/path)
340 http://[user[:pass]@]host[:port]/[path]
341 https://[user[:pass]@]host[:port]/[path]
342 ssh://[user[:pass]@]host[:port]/[path]
343
344 Paths in the local filesystem can either point to Mercurial
345 repositories or to bundle files (as created by 'hg bundle' or
346 'hg incoming --bundle').
347
348 An optional identifier after # indicates a particular branch, tag,
349 or changeset to deal with in the remote repository.
350
351 Some features, such as pushing to http:// and https:// URLs are
352 only possible if the feature is explicitly enabled on the
353 remote Mercurial server.
354
355 Some notes about using SSH with Mercurial:
356 - SSH requires an accessible shell account on the destination machine
357 and a copy of hg in the remote path or specified with as remotecmd.
358 - path is relative to the remote user's home directory by default.
359 Use an extra slash at the start of a path to specify an absolute path:
360 ssh://example.com//tmp/repository
361 - Mercurial doesn't use its own compression via SSH; the right thing
362 to do is to configure it in your ~/.ssh/config, e.g.:
363 Host *.mylocalnetwork.example.com
364 Compression no
365 Host *
366 Compression yes
367 Alternatively specify "ssh -C" as your ssh command in your hgrc or
368 with the --ssh command line option.
369
370 These urls can all be stored in your hgrc with path aliases under the
371 [paths] section like so:
372 [paths]
373 alias1 = URL1
374 alias2 = URL2
375 ...
376
377 You can then use the alias for any command that uses a url (for example
378 'hg pull alias1' would pull from the 'alias1' path).
379
380 Two path aliases are more important because they are used as defaults
381 when you do not provide the url to a command:
382
383 default:
384 When you create a repository with hg clone, the clone command saves
385 the location of the source repository as the 'default' path. This is
386 then used when you omit a path from the push and pull commands.
387
388 default-push:
389 The push command will look for a path named 'default-push', and
390 prefer it over 'default' if both are defined.
391 ''')),
334 ) 392 )