Fossil SCM
Improved documentation for cloning, including mentioning the use of %40 for "@" characters in the userid.
Commit
b5354f19f21a3457ee63f809745406240602218e
Parent
1e723a12d3ded6d…
2 files changed
+9
-5
+16
-11
+9
-5
| --- src/clone.c | ||
| +++ src/clone.c | ||
| @@ -80,16 +80,16 @@ | ||
| 80 | 80 | |
| 81 | 81 | |
| 82 | 82 | /* |
| 83 | 83 | ** COMMAND: clone |
| 84 | 84 | ** |
| 85 | -** Usage: %fossil clone ?OPTIONS? URL FILENAME | |
| 85 | +** Usage: %fossil clone ?OPTIONS? URI FILENAME | |
| 86 | 86 | ** |
| 87 | -** Make a clone of a repository specified by URL in the local | |
| 87 | +** Make a clone of a repository specified by URI in the local | |
| 88 | 88 | ** file named FILENAME. |
| 89 | 89 | ** |
| 90 | -** URL must be in one of the following form: ([...] mean optional) | |
| 90 | +** URI may be one of the following form: ([...] mean optional) | |
| 91 | 91 | ** HTTP/HTTPS protocol: |
| 92 | 92 | ** http[s]://[userid[:password]@]host[:port][/path] |
| 93 | 93 | ** |
| 94 | 94 | ** SSH protocol: |
| 95 | 95 | ** ssh://[userid[:password]@]host[:port]/path/to/repo.fossil\\ |
| @@ -96,20 +96,24 @@ | ||
| 96 | 96 | ** [?fossil=path/to/fossil.exe] |
| 97 | 97 | ** |
| 98 | 98 | ** Filesystem: |
| 99 | 99 | ** [file://]path/to/repo.fossil |
| 100 | 100 | ** |
| 101 | -** Note: For ssh and filesystem, path must have an extra leading | |
| 101 | +** Note 1: For ssh and filesystem, path must have an extra leading | |
| 102 | 102 | ** '/' to use an absolute path. |
| 103 | +** | |
| 104 | +** Note 2: Use %HH escapes for special characters in the userid and | |
| 105 | +** password. For example "%40" in place of "@", "%2f" in place | |
| 106 | +** of "/", and "%3a" in place of ":". | |
| 103 | 107 | ** |
| 104 | 108 | ** By default, your current login name is used to create the default |
| 105 | 109 | ** admin user. This can be overridden using the -A|--admin-user |
| 106 | 110 | ** parameter. |
| 107 | 111 | ** |
| 108 | 112 | ** Options: |
| 109 | 113 | ** --admin-user|-A USERNAME Make USERNAME the administrator |
| 110 | -** --once Don't remember the URL. | |
| 114 | +** --once Don't remember the URI. | |
| 111 | 115 | ** --private Also clone private branches |
| 112 | 116 | ** --ssl-identity FILENAME Use the SSL identity if requested by the server |
| 113 | 117 | ** --ssh-command|-c SSH Use SSH as the "ssh" command |
| 114 | 118 | ** --httpauth|-B USER:PASS Add HTTP Basic Authorization to requests |
| 115 | 119 | ** --verbose Show more statistics in output |
| 116 | 120 |
| --- src/clone.c | |
| +++ src/clone.c | |
| @@ -80,16 +80,16 @@ | |
| 80 | |
| 81 | |
| 82 | /* |
| 83 | ** COMMAND: clone |
| 84 | ** |
| 85 | ** Usage: %fossil clone ?OPTIONS? URL FILENAME |
| 86 | ** |
| 87 | ** Make a clone of a repository specified by URL in the local |
| 88 | ** file named FILENAME. |
| 89 | ** |
| 90 | ** URL must be in one of the following form: ([...] mean optional) |
| 91 | ** HTTP/HTTPS protocol: |
| 92 | ** http[s]://[userid[:password]@]host[:port][/path] |
| 93 | ** |
| 94 | ** SSH protocol: |
| 95 | ** ssh://[userid[:password]@]host[:port]/path/to/repo.fossil\\ |
| @@ -96,20 +96,24 @@ | |
| 96 | ** [?fossil=path/to/fossil.exe] |
| 97 | ** |
| 98 | ** Filesystem: |
| 99 | ** [file://]path/to/repo.fossil |
| 100 | ** |
| 101 | ** Note: For ssh and filesystem, path must have an extra leading |
| 102 | ** '/' to use an absolute path. |
| 103 | ** |
| 104 | ** By default, your current login name is used to create the default |
| 105 | ** admin user. This can be overridden using the -A|--admin-user |
| 106 | ** parameter. |
| 107 | ** |
| 108 | ** Options: |
| 109 | ** --admin-user|-A USERNAME Make USERNAME the administrator |
| 110 | ** --once Don't remember the URL. |
| 111 | ** --private Also clone private branches |
| 112 | ** --ssl-identity FILENAME Use the SSL identity if requested by the server |
| 113 | ** --ssh-command|-c SSH Use SSH as the "ssh" command |
| 114 | ** --httpauth|-B USER:PASS Add HTTP Basic Authorization to requests |
| 115 | ** --verbose Show more statistics in output |
| 116 |
| --- src/clone.c | |
| +++ src/clone.c | |
| @@ -80,16 +80,16 @@ | |
| 80 | |
| 81 | |
| 82 | /* |
| 83 | ** COMMAND: clone |
| 84 | ** |
| 85 | ** Usage: %fossil clone ?OPTIONS? URI FILENAME |
| 86 | ** |
| 87 | ** Make a clone of a repository specified by URI in the local |
| 88 | ** file named FILENAME. |
| 89 | ** |
| 90 | ** URI may be one of the following form: ([...] mean optional) |
| 91 | ** HTTP/HTTPS protocol: |
| 92 | ** http[s]://[userid[:password]@]host[:port][/path] |
| 93 | ** |
| 94 | ** SSH protocol: |
| 95 | ** ssh://[userid[:password]@]host[:port]/path/to/repo.fossil\\ |
| @@ -96,20 +96,24 @@ | |
| 96 | ** [?fossil=path/to/fossil.exe] |
| 97 | ** |
| 98 | ** Filesystem: |
| 99 | ** [file://]path/to/repo.fossil |
| 100 | ** |
| 101 | ** Note 1: For ssh and filesystem, path must have an extra leading |
| 102 | ** '/' to use an absolute path. |
| 103 | ** |
| 104 | ** Note 2: Use %HH escapes for special characters in the userid and |
| 105 | ** password. For example "%40" in place of "@", "%2f" in place |
| 106 | ** of "/", and "%3a" in place of ":". |
| 107 | ** |
| 108 | ** By default, your current login name is used to create the default |
| 109 | ** admin user. This can be overridden using the -A|--admin-user |
| 110 | ** parameter. |
| 111 | ** |
| 112 | ** Options: |
| 113 | ** --admin-user|-A USERNAME Make USERNAME the administrator |
| 114 | ** --once Don't remember the URI. |
| 115 | ** --private Also clone private branches |
| 116 | ** --ssl-identity FILENAME Use the SSL identity if requested by the server |
| 117 | ** --ssh-command|-c SSH Use SSH as the "ssh" command |
| 118 | ** --httpauth|-B USER:PASS Add HTTP Basic Authorization to requests |
| 119 | ** --verbose Show more statistics in output |
| 120 |
+16
-11
| --- www/quickstart.wiki | ||
| +++ www/quickstart.wiki | ||
| @@ -53,27 +53,32 @@ | ||
| 53 | 53 | |
| 54 | 54 | <blockquote> |
| 55 | 55 | <b>fossil clone</b> <i>URL repository-filename</i> |
| 56 | 56 | </blockquote> |
| 57 | 57 | |
| 58 | - <p>The <i>URL</i> above is the http URL for the fossil repository | |
| 59 | - you want to clone, and it may include a "user:password" part, e.g. | |
| 60 | - <tt>http://user:[email protected]/fossil</tt>. You can | |
| 61 | - call the new repository anything you want - there are no naming | |
| 62 | - restrictions. As an example, you can clone the fossil repository | |
| 63 | - this way:</p> | |
| 58 | + <p>The <i>URL</i> specifies the fossil repository | |
| 59 | + you want to clone. The <i>repository-filename</i> is the new local | |
| 60 | + filename into which the cloned repository will be written. For | |
| 61 | + example: | |
| 64 | 62 | |
| 65 | 63 | <blockquote> |
| 66 | 64 | <b>fossil clone http://www.fossil-scm.org/ myclone.fossil</b> |
| 67 | 65 | </blockquote> |
| 68 | 66 | |
| 69 | - <p>The new local copy of the repository is stored in a single file, | |
| 70 | - which in the example above is named "myclone.fossil". | |
| 71 | - You can name your repositories anything you want. The ".fossil" suffix | |
| 72 | - is not required.</p> | |
| 67 | + <p>If the remote repository requires a login, include a | |
| 68 | + userid in the URL like this: | |
| 69 | + | |
| 70 | + <blockquote> | |
| 71 | + <b>fossil clone http://</b><i>userid</i><b>@www.fossil-scm.org/ myclone.fossil</b> | |
| 72 | + </blockquote> | |
| 73 | + | |
| 74 | + | |
| 75 | + <p>You will be prompted separately for the password. | |
| 76 | + Use "%HH" escapes for special characters in the userid. | |
| 77 | + Examples: "%40" in place of "@" and "%2F" in place of "/". | |
| 73 | 78 | |
| 74 | - <p>Note: If you are behind a restrictive firewall, you might need | |
| 79 | + <p>If you are behind a restrictive firewall, you might need | |
| 75 | 80 | to <a href="#proxy">specify an HTTP proxy</a>.</p> |
| 76 | 81 | |
| 77 | 82 | <p>A Fossil repository is a single disk file. Instead of cloning, |
| 78 | 83 | you can just make a copy of the repository file (for example, using |
| 79 | 84 | "scp"). Note, however, that the repository file contains auxiliary |
| 80 | 85 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -53,27 +53,32 @@ | |
| 53 | |
| 54 | <blockquote> |
| 55 | <b>fossil clone</b> <i>URL repository-filename</i> |
| 56 | </blockquote> |
| 57 | |
| 58 | <p>The <i>URL</i> above is the http URL for the fossil repository |
| 59 | you want to clone, and it may include a "user:password" part, e.g. |
| 60 | <tt>http://user:[email protected]/fossil</tt>. You can |
| 61 | call the new repository anything you want - there are no naming |
| 62 | restrictions. As an example, you can clone the fossil repository |
| 63 | this way:</p> |
| 64 | |
| 65 | <blockquote> |
| 66 | <b>fossil clone http://www.fossil-scm.org/ myclone.fossil</b> |
| 67 | </blockquote> |
| 68 | |
| 69 | <p>The new local copy of the repository is stored in a single file, |
| 70 | which in the example above is named "myclone.fossil". |
| 71 | You can name your repositories anything you want. The ".fossil" suffix |
| 72 | is not required.</p> |
| 73 | |
| 74 | <p>Note: If you are behind a restrictive firewall, you might need |
| 75 | to <a href="#proxy">specify an HTTP proxy</a>.</p> |
| 76 | |
| 77 | <p>A Fossil repository is a single disk file. Instead of cloning, |
| 78 | you can just make a copy of the repository file (for example, using |
| 79 | "scp"). Note, however, that the repository file contains auxiliary |
| 80 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -53,27 +53,32 @@ | |
| 53 | |
| 54 | <blockquote> |
| 55 | <b>fossil clone</b> <i>URL repository-filename</i> |
| 56 | </blockquote> |
| 57 | |
| 58 | <p>The <i>URL</i> specifies the fossil repository |
| 59 | you want to clone. The <i>repository-filename</i> is the new local |
| 60 | filename into which the cloned repository will be written. For |
| 61 | example: |
| 62 | |
| 63 | <blockquote> |
| 64 | <b>fossil clone http://www.fossil-scm.org/ myclone.fossil</b> |
| 65 | </blockquote> |
| 66 | |
| 67 | <p>If the remote repository requires a login, include a |
| 68 | userid in the URL like this: |
| 69 | |
| 70 | <blockquote> |
| 71 | <b>fossil clone http://</b><i>userid</i><b>@www.fossil-scm.org/ myclone.fossil</b> |
| 72 | </blockquote> |
| 73 | |
| 74 | |
| 75 | <p>You will be prompted separately for the password. |
| 76 | Use "%HH" escapes for special characters in the userid. |
| 77 | Examples: "%40" in place of "@" and "%2F" in place of "/". |
| 78 | |
| 79 | <p>If you are behind a restrictive firewall, you might need |
| 80 | to <a href="#proxy">specify an HTTP proxy</a>.</p> |
| 81 | |
| 82 | <p>A Fossil repository is a single disk file. Instead of cloning, |
| 83 | you can just make a copy of the repository file (for example, using |
| 84 | "scp"). Note, however, that the repository file contains auxiliary |
| 85 |