Fossil SCM
Enhanced help text for the "fossil ui" command. No changes to code.
Commit
301bc21791f13e6abd8b2b4ff0f819d59cd4e2c629e80d9d1781a7dc4c4ee92c
Parent
a7aa779b2b16e0d…
1 file changed
+15
-15
+15
-15
| --- src/main.c | ||
| +++ src/main.c | ||
| @@ -2791,19 +2791,30 @@ | ||
| 2791 | 2791 | ** Usage: %fossil server ?OPTIONS? ?REPOSITORY? |
| 2792 | 2792 | ** or: %fossil ui ?OPTIONS? ?REPOSITORY? |
| 2793 | 2793 | ** |
| 2794 | 2794 | ** Open a socket and begin listening and responding to HTTP requests on |
| 2795 | 2795 | ** TCP port 8080, or on any other TCP port defined by the -P or |
| 2796 | -** --port option. The optional argument is the name of the repository. | |
| 2797 | -** The repository argument may be omitted if the working directory is | |
| 2798 | -** within an open checkout. | |
| 2796 | +** --port option. The optional REPOSITORY argument is the name of the | |
| 2797 | +** Fossil repository to be served. The REPOSITORY argument may be omitted | |
| 2798 | +** if the working directory is within an open checkout, in which case the | |
| 2799 | +** repository associated with that checkout is used. | |
| 2799 | 2800 | ** |
| 2800 | 2801 | ** The "ui" command automatically starts a web browser after initializing |
| 2801 | 2802 | ** the web server. The "ui" command also binds to 127.0.0.1 and so will |
| 2802 | 2803 | ** only process HTTP traffic from the local machine. |
| 2803 | 2804 | ** |
| 2804 | -** The REPOSITORY can be a directory (aka folder) that contains one or | |
| 2805 | +** If REPOSITORY is a directory name which is the root of a | |
| 2806 | +** checkout, then use the repository associated with that checkout. | |
| 2807 | +** This only works for the "fossil ui" command, not the "fossil server" | |
| 2808 | +** command. | |
| 2809 | +** | |
| 2810 | +** If REPOSITORY begins with a "HOST:" or "USER@HOST:" prefix, then | |
| 2811 | +** the command is run on the remote host specified and the results are | |
| 2812 | +** tunneled back to the local machine via SSH. This feature only works for | |
| 2813 | +** the "fossil ui" command, not the "fossil server" command. | |
| 2814 | +** | |
| 2815 | +** REPOSITORY may also be a directory (aka folder) that contains one or | |
| 2805 | 2816 | ** more repositories with names ending in ".fossil". In this case, a |
| 2806 | 2817 | ** prefix of the URL pathname is used to search the directory for an |
| 2807 | 2818 | ** appropriate repository. To thwart mischief, the pathname in the URL must |
| 2808 | 2819 | ** contain only alphanumerics, "_", "/", "-", and ".", and no "-" may |
| 2809 | 2820 | ** occur after "/", and every "." must be surrounded on both sides by |
| @@ -2813,21 +2824,10 @@ | ||
| 2813 | 2824 | ** such as ".txt" or ".html" or ".jpeg" and do not match the pattern |
| 2814 | 2825 | ** "*.fossil*" will be served as static content. With the "ui" command, |
| 2815 | 2826 | ** the REPOSITORY can only be a directory if the --notfound option is |
| 2816 | 2827 | ** also present. |
| 2817 | 2828 | ** |
| 2818 | -** If the REPOSITORY is a directory name which is the root of a | |
| 2819 | -** checkout, it will chdir to that directory and, unless overridden by | |
| 2820 | -** the --page option, select the current checkout version in the | |
| 2821 | -** timeline by default. This only works for the "fossil ui" command, | |
| 2822 | -** not the "fossil server" command. | |
| 2823 | -** | |
| 2824 | -** If the REPOSITORY argument has a "HOST:" or "USER@HOST:" prefix, then | |
| 2825 | -** the command is run on the remote host specified and the results are | |
| 2826 | -** tunneled back to the local host via SSH. This feature only works for | |
| 2827 | -** the "fossil ui" command, not the "fossil server" command. | |
| 2828 | -** | |
| 2829 | 2829 | ** For the special case REPOSITORY name of "/", the global configuration |
| 2830 | 2830 | ** database is consulted for a list of all known repositories. The --repolist |
| 2831 | 2831 | ** option is implied by this special case. See also the "fossil all ui" |
| 2832 | 2832 | ** command. |
| 2833 | 2833 | ** |
| 2834 | 2834 |
| --- src/main.c | |
| +++ src/main.c | |
| @@ -2791,19 +2791,30 @@ | |
| 2791 | ** Usage: %fossil server ?OPTIONS? ?REPOSITORY? |
| 2792 | ** or: %fossil ui ?OPTIONS? ?REPOSITORY? |
| 2793 | ** |
| 2794 | ** Open a socket and begin listening and responding to HTTP requests on |
| 2795 | ** TCP port 8080, or on any other TCP port defined by the -P or |
| 2796 | ** --port option. The optional argument is the name of the repository. |
| 2797 | ** The repository argument may be omitted if the working directory is |
| 2798 | ** within an open checkout. |
| 2799 | ** |
| 2800 | ** The "ui" command automatically starts a web browser after initializing |
| 2801 | ** the web server. The "ui" command also binds to 127.0.0.1 and so will |
| 2802 | ** only process HTTP traffic from the local machine. |
| 2803 | ** |
| 2804 | ** The REPOSITORY can be a directory (aka folder) that contains one or |
| 2805 | ** more repositories with names ending in ".fossil". In this case, a |
| 2806 | ** prefix of the URL pathname is used to search the directory for an |
| 2807 | ** appropriate repository. To thwart mischief, the pathname in the URL must |
| 2808 | ** contain only alphanumerics, "_", "/", "-", and ".", and no "-" may |
| 2809 | ** occur after "/", and every "." must be surrounded on both sides by |
| @@ -2813,21 +2824,10 @@ | |
| 2813 | ** such as ".txt" or ".html" or ".jpeg" and do not match the pattern |
| 2814 | ** "*.fossil*" will be served as static content. With the "ui" command, |
| 2815 | ** the REPOSITORY can only be a directory if the --notfound option is |
| 2816 | ** also present. |
| 2817 | ** |
| 2818 | ** If the REPOSITORY is a directory name which is the root of a |
| 2819 | ** checkout, it will chdir to that directory and, unless overridden by |
| 2820 | ** the --page option, select the current checkout version in the |
| 2821 | ** timeline by default. This only works for the "fossil ui" command, |
| 2822 | ** not the "fossil server" command. |
| 2823 | ** |
| 2824 | ** If the REPOSITORY argument has a "HOST:" or "USER@HOST:" prefix, then |
| 2825 | ** the command is run on the remote host specified and the results are |
| 2826 | ** tunneled back to the local host via SSH. This feature only works for |
| 2827 | ** the "fossil ui" command, not the "fossil server" command. |
| 2828 | ** |
| 2829 | ** For the special case REPOSITORY name of "/", the global configuration |
| 2830 | ** database is consulted for a list of all known repositories. The --repolist |
| 2831 | ** option is implied by this special case. See also the "fossil all ui" |
| 2832 | ** command. |
| 2833 | ** |
| 2834 |
| --- src/main.c | |
| +++ src/main.c | |
| @@ -2791,19 +2791,30 @@ | |
| 2791 | ** Usage: %fossil server ?OPTIONS? ?REPOSITORY? |
| 2792 | ** or: %fossil ui ?OPTIONS? ?REPOSITORY? |
| 2793 | ** |
| 2794 | ** Open a socket and begin listening and responding to HTTP requests on |
| 2795 | ** TCP port 8080, or on any other TCP port defined by the -P or |
| 2796 | ** --port option. The optional REPOSITORY argument is the name of the |
| 2797 | ** Fossil repository to be served. The REPOSITORY argument may be omitted |
| 2798 | ** if the working directory is within an open checkout, in which case the |
| 2799 | ** repository associated with that checkout is used. |
| 2800 | ** |
| 2801 | ** The "ui" command automatically starts a web browser after initializing |
| 2802 | ** the web server. The "ui" command also binds to 127.0.0.1 and so will |
| 2803 | ** only process HTTP traffic from the local machine. |
| 2804 | ** |
| 2805 | ** If REPOSITORY is a directory name which is the root of a |
| 2806 | ** checkout, then use the repository associated with that checkout. |
| 2807 | ** This only works for the "fossil ui" command, not the "fossil server" |
| 2808 | ** command. |
| 2809 | ** |
| 2810 | ** If REPOSITORY begins with a "HOST:" or "USER@HOST:" prefix, then |
| 2811 | ** the command is run on the remote host specified and the results are |
| 2812 | ** tunneled back to the local machine via SSH. This feature only works for |
| 2813 | ** the "fossil ui" command, not the "fossil server" command. |
| 2814 | ** |
| 2815 | ** REPOSITORY may also be a directory (aka folder) that contains one or |
| 2816 | ** more repositories with names ending in ".fossil". In this case, a |
| 2817 | ** prefix of the URL pathname is used to search the directory for an |
| 2818 | ** appropriate repository. To thwart mischief, the pathname in the URL must |
| 2819 | ** contain only alphanumerics, "_", "/", "-", and ".", and no "-" may |
| 2820 | ** occur after "/", and every "." must be surrounded on both sides by |
| @@ -2813,21 +2824,10 @@ | |
| 2824 | ** such as ".txt" or ".html" or ".jpeg" and do not match the pattern |
| 2825 | ** "*.fossil*" will be served as static content. With the "ui" command, |
| 2826 | ** the REPOSITORY can only be a directory if the --notfound option is |
| 2827 | ** also present. |
| 2828 | ** |
| 2829 | ** For the special case REPOSITORY name of "/", the global configuration |
| 2830 | ** database is consulted for a list of all known repositories. The --repolist |
| 2831 | ** option is implied by this special case. See also the "fossil all ui" |
| 2832 | ** command. |
| 2833 | ** |
| 2834 |