Fossil SCM
Improved help-page for the "http" command.
Commit
42c4d045e10f40ba7ce413937955623c9b602e16ada8336e5310453988a728ba
Parent
076e7863c21e648…
1 file changed
+19
-23
+19
-23
| --- src/main.c | ||
| +++ src/main.c | ||
| @@ -2616,12 +2616,12 @@ | ||
| 2616 | 2616 | ** |
| 2617 | 2617 | ** Usage: %fossil http ?REPOSITORY? ?OPTIONS? |
| 2618 | 2618 | ** |
| 2619 | 2619 | ** Handle a single HTTP request appearing on stdin. The resulting webpage |
| 2620 | 2620 | ** is delivered on stdout. This method is used to launch an HTTP request |
| 2621 | -** handler from inetd, for example. The argument is the name of the | |
| 2622 | -** repository. | |
| 2621 | +** handler from inetd, for example. The REPOSITORY argument is the name of | |
| 2622 | +** the repository. | |
| 2623 | 2623 | ** |
| 2624 | 2624 | ** If REPOSITORY is a directory that contains one or more repositories, |
| 2625 | 2625 | ** either directly in REPOSITORY itself or in subdirectories, and |
| 2626 | 2626 | ** with names of the form "*.fossil" then a prefix of the URL pathname |
| 2627 | 2627 | ** selects from among the various repositories. If the pathname does |
| @@ -2632,31 +2632,24 @@ | ||
| 2632 | 2632 | ** and every "." must be surrounded on both sides by alphanumerics or else |
| 2633 | 2633 | ** a 404 error is returned. Static content files in the directory are |
| 2634 | 2634 | ** returned if they match comma-separate GLOB pattern specified by --files |
| 2635 | 2635 | ** and do not match "*.fossil*" and have a well-known suffix. |
| 2636 | 2636 | ** |
| 2637 | -** The --host option can be used to specify the hostname for the server. | |
| 2638 | -** The --https option indicates that the request came from HTTPS rather | |
| 2639 | -** than HTTP. If --nossl is given, then SSL connections will not be available, | |
| 2640 | -** thus also no redirecting from http: to https: will take place. | |
| 2641 | -** | |
| 2642 | -** If the --localauth option is given, then automatic login is performed | |
| 2643 | -** for requests coming from localhost, if the "localauth" setting is not | |
| 2644 | -** enabled. | |
| 2645 | -** | |
| 2646 | 2637 | ** Options: |
| 2647 | 2638 | ** --acme Deliver files from the ".well-known" subdirectory |
| 2648 | 2639 | ** --baseurl URL base URL (useful with reverse proxies) |
| 2649 | 2640 | ** --cert FILE Use TLS (HTTPS) encryption with the certificate (the |
| 2650 | 2641 | ** fullchain.pem) taken from FILE. |
| 2651 | 2642 | ** --chroot DIR Use directory for chroot instead of repository path. |
| 2652 | 2643 | ** --ckout-alias N Treat URIs of the form /doc/N/... as if they were |
| 2653 | 2644 | ** /doc/ckout/... |
| 2654 | -** --extroot DIR document root for the /ext extension mechanism | |
| 2655 | -** --files GLOB comma-separate glob patterns for static file to serve | |
| 2656 | -** --host NAME specify hostname of the server | |
| 2657 | -** --https signal a request coming in via https | |
| 2645 | +** --extroot DIR Document root for the /ext extension mechanism | |
| 2646 | +** --files GLOB Comma-separate glob patterns for static file to serve | |
| 2647 | +** --host NAME DNS Hostname of the server | |
| 2648 | +** --https The HTTP request originated from https but has already | |
| 2649 | +** been decoded by a reverse proxy. Hence, URLs created | |
| 2650 | +** by Fossil should use "https:" rather than "http:". | |
| 2658 | 2651 | ** --in FILE Take input from FILE instead of standard input |
| 2659 | 2652 | ** --ipaddr ADDR Assume the request comes from the given IP address |
| 2660 | 2653 | ** --jsmode MODE Determine how JavaScript is delivered with pages. |
| 2661 | 2654 | ** Mode can be one of: |
| 2662 | 2655 | ** inline All JavaScript is inserted inline at |
| @@ -2668,25 +2661,28 @@ | ||
| 2668 | 2661 | ** concatenate scripts together. |
| 2669 | 2662 | ** Depending on the needs of any given page, inline |
| 2670 | 2663 | ** and bundled modes might result in a single |
| 2671 | 2664 | ** amalgamated script or several, but both approaches |
| 2672 | 2665 | ** result in fewer HTTP requests than the separate mode. |
| 2673 | -** --localauth enable automatic login for local connections | |
| 2666 | +** --localauth Connections from localhost are given "setup" | |
| 2667 | +** privileges without having to log in. | |
| 2674 | 2668 | ** --mainmenu FILE Override the mainmenu config setting with the contents |
| 2675 | 2669 | ** of the given file. |
| 2676 | -** --nocompress do not compress HTTP replies | |
| 2677 | -** --nodelay omit backoffice processing if it would delay | |
| 2670 | +** --nocompress Do not compress HTTP replies | |
| 2671 | +** --nodelay Omit backoffice processing if it would delay | |
| 2678 | 2672 | ** process exit |
| 2679 | -** --nojail drop root privilege but do not enter the chroot jail | |
| 2680 | -** --nossl signal that no SSL connections are available | |
| 2681 | -** --notfound URL use URL as "HTTP 404, object not found" page. | |
| 2682 | -** --out FILE write results to FILE instead of to standard output | |
| 2673 | +** --nojail Drop root privilege but do not enter the chroot jail | |
| 2674 | +** --nossl Do not do http: to https: redirects, regardless of | |
| 2675 | +** the redirect-to-https setting. | |
| 2676 | +** --notfound URL Use URL as the "HTTP 404, object not found" page. | |
| 2677 | +** --out FILE Write the HTTP reply to FILE instead of to | |
| 2678 | +** standard output | |
| 2683 | 2679 | ** --pkey FILE Read the private key used for TLS from FILE. |
| 2684 | 2680 | ** --repolist If REPOSITORY is directory, URL "/" lists all repos |
| 2685 | 2681 | ** --scgi Interpret input as SCGI rather than HTTP |
| 2686 | 2682 | ** --skin LABEL Use override skin LABEL |
| 2687 | -** --th-trace trace TH1 execution (for debugging purposes) | |
| 2683 | +** --th-trace Trace TH1 execution (for debugging purposes) | |
| 2688 | 2684 | ** --usepidkey Use saved encryption key from parent process. This is |
| 2689 | 2685 | ** only necessary when using SEE on Windows. |
| 2690 | 2686 | ** |
| 2691 | 2687 | ** See also: [[cgi]], [[server]], [[winsrv]] |
| 2692 | 2688 | */ |
| 2693 | 2689 |
| --- src/main.c | |
| +++ src/main.c | |
| @@ -2616,12 +2616,12 @@ | |
| 2616 | ** |
| 2617 | ** Usage: %fossil http ?REPOSITORY? ?OPTIONS? |
| 2618 | ** |
| 2619 | ** Handle a single HTTP request appearing on stdin. The resulting webpage |
| 2620 | ** is delivered on stdout. This method is used to launch an HTTP request |
| 2621 | ** handler from inetd, for example. The argument is the name of the |
| 2622 | ** repository. |
| 2623 | ** |
| 2624 | ** If REPOSITORY is a directory that contains one or more repositories, |
| 2625 | ** either directly in REPOSITORY itself or in subdirectories, and |
| 2626 | ** with names of the form "*.fossil" then a prefix of the URL pathname |
| 2627 | ** selects from among the various repositories. If the pathname does |
| @@ -2632,31 +2632,24 @@ | |
| 2632 | ** and every "." must be surrounded on both sides by alphanumerics or else |
| 2633 | ** a 404 error is returned. Static content files in the directory are |
| 2634 | ** returned if they match comma-separate GLOB pattern specified by --files |
| 2635 | ** and do not match "*.fossil*" and have a well-known suffix. |
| 2636 | ** |
| 2637 | ** The --host option can be used to specify the hostname for the server. |
| 2638 | ** The --https option indicates that the request came from HTTPS rather |
| 2639 | ** than HTTP. If --nossl is given, then SSL connections will not be available, |
| 2640 | ** thus also no redirecting from http: to https: will take place. |
| 2641 | ** |
| 2642 | ** If the --localauth option is given, then automatic login is performed |
| 2643 | ** for requests coming from localhost, if the "localauth" setting is not |
| 2644 | ** enabled. |
| 2645 | ** |
| 2646 | ** Options: |
| 2647 | ** --acme Deliver files from the ".well-known" subdirectory |
| 2648 | ** --baseurl URL base URL (useful with reverse proxies) |
| 2649 | ** --cert FILE Use TLS (HTTPS) encryption with the certificate (the |
| 2650 | ** fullchain.pem) taken from FILE. |
| 2651 | ** --chroot DIR Use directory for chroot instead of repository path. |
| 2652 | ** --ckout-alias N Treat URIs of the form /doc/N/... as if they were |
| 2653 | ** /doc/ckout/... |
| 2654 | ** --extroot DIR document root for the /ext extension mechanism |
| 2655 | ** --files GLOB comma-separate glob patterns for static file to serve |
| 2656 | ** --host NAME specify hostname of the server |
| 2657 | ** --https signal a request coming in via https |
| 2658 | ** --in FILE Take input from FILE instead of standard input |
| 2659 | ** --ipaddr ADDR Assume the request comes from the given IP address |
| 2660 | ** --jsmode MODE Determine how JavaScript is delivered with pages. |
| 2661 | ** Mode can be one of: |
| 2662 | ** inline All JavaScript is inserted inline at |
| @@ -2668,25 +2661,28 @@ | |
| 2668 | ** concatenate scripts together. |
| 2669 | ** Depending on the needs of any given page, inline |
| 2670 | ** and bundled modes might result in a single |
| 2671 | ** amalgamated script or several, but both approaches |
| 2672 | ** result in fewer HTTP requests than the separate mode. |
| 2673 | ** --localauth enable automatic login for local connections |
| 2674 | ** --mainmenu FILE Override the mainmenu config setting with the contents |
| 2675 | ** of the given file. |
| 2676 | ** --nocompress do not compress HTTP replies |
| 2677 | ** --nodelay omit backoffice processing if it would delay |
| 2678 | ** process exit |
| 2679 | ** --nojail drop root privilege but do not enter the chroot jail |
| 2680 | ** --nossl signal that no SSL connections are available |
| 2681 | ** --notfound URL use URL as "HTTP 404, object not found" page. |
| 2682 | ** --out FILE write results to FILE instead of to standard output |
| 2683 | ** --pkey FILE Read the private key used for TLS from FILE. |
| 2684 | ** --repolist If REPOSITORY is directory, URL "/" lists all repos |
| 2685 | ** --scgi Interpret input as SCGI rather than HTTP |
| 2686 | ** --skin LABEL Use override skin LABEL |
| 2687 | ** --th-trace trace TH1 execution (for debugging purposes) |
| 2688 | ** --usepidkey Use saved encryption key from parent process. This is |
| 2689 | ** only necessary when using SEE on Windows. |
| 2690 | ** |
| 2691 | ** See also: [[cgi]], [[server]], [[winsrv]] |
| 2692 | */ |
| 2693 |
| --- src/main.c | |
| +++ src/main.c | |
| @@ -2616,12 +2616,12 @@ | |
| 2616 | ** |
| 2617 | ** Usage: %fossil http ?REPOSITORY? ?OPTIONS? |
| 2618 | ** |
| 2619 | ** Handle a single HTTP request appearing on stdin. The resulting webpage |
| 2620 | ** is delivered on stdout. This method is used to launch an HTTP request |
| 2621 | ** handler from inetd, for example. The REPOSITORY argument is the name of |
| 2622 | ** the repository. |
| 2623 | ** |
| 2624 | ** If REPOSITORY is a directory that contains one or more repositories, |
| 2625 | ** either directly in REPOSITORY itself or in subdirectories, and |
| 2626 | ** with names of the form "*.fossil" then a prefix of the URL pathname |
| 2627 | ** selects from among the various repositories. If the pathname does |
| @@ -2632,31 +2632,24 @@ | |
| 2632 | ** and every "." must be surrounded on both sides by alphanumerics or else |
| 2633 | ** a 404 error is returned. Static content files in the directory are |
| 2634 | ** returned if they match comma-separate GLOB pattern specified by --files |
| 2635 | ** and do not match "*.fossil*" and have a well-known suffix. |
| 2636 | ** |
| 2637 | ** Options: |
| 2638 | ** --acme Deliver files from the ".well-known" subdirectory |
| 2639 | ** --baseurl URL base URL (useful with reverse proxies) |
| 2640 | ** --cert FILE Use TLS (HTTPS) encryption with the certificate (the |
| 2641 | ** fullchain.pem) taken from FILE. |
| 2642 | ** --chroot DIR Use directory for chroot instead of repository path. |
| 2643 | ** --ckout-alias N Treat URIs of the form /doc/N/... as if they were |
| 2644 | ** /doc/ckout/... |
| 2645 | ** --extroot DIR Document root for the /ext extension mechanism |
| 2646 | ** --files GLOB Comma-separate glob patterns for static file to serve |
| 2647 | ** --host NAME DNS Hostname of the server |
| 2648 | ** --https The HTTP request originated from https but has already |
| 2649 | ** been decoded by a reverse proxy. Hence, URLs created |
| 2650 | ** by Fossil should use "https:" rather than "http:". |
| 2651 | ** --in FILE Take input from FILE instead of standard input |
| 2652 | ** --ipaddr ADDR Assume the request comes from the given IP address |
| 2653 | ** --jsmode MODE Determine how JavaScript is delivered with pages. |
| 2654 | ** Mode can be one of: |
| 2655 | ** inline All JavaScript is inserted inline at |
| @@ -2668,25 +2661,28 @@ | |
| 2661 | ** concatenate scripts together. |
| 2662 | ** Depending on the needs of any given page, inline |
| 2663 | ** and bundled modes might result in a single |
| 2664 | ** amalgamated script or several, but both approaches |
| 2665 | ** result in fewer HTTP requests than the separate mode. |
| 2666 | ** --localauth Connections from localhost are given "setup" |
| 2667 | ** privileges without having to log in. |
| 2668 | ** --mainmenu FILE Override the mainmenu config setting with the contents |
| 2669 | ** of the given file. |
| 2670 | ** --nocompress Do not compress HTTP replies |
| 2671 | ** --nodelay Omit backoffice processing if it would delay |
| 2672 | ** process exit |
| 2673 | ** --nojail Drop root privilege but do not enter the chroot jail |
| 2674 | ** --nossl Do not do http: to https: redirects, regardless of |
| 2675 | ** the redirect-to-https setting. |
| 2676 | ** --notfound URL Use URL as the "HTTP 404, object not found" page. |
| 2677 | ** --out FILE Write the HTTP reply to FILE instead of to |
| 2678 | ** standard output |
| 2679 | ** --pkey FILE Read the private key used for TLS from FILE. |
| 2680 | ** --repolist If REPOSITORY is directory, URL "/" lists all repos |
| 2681 | ** --scgi Interpret input as SCGI rather than HTTP |
| 2682 | ** --skin LABEL Use override skin LABEL |
| 2683 | ** --th-trace Trace TH1 execution (for debugging purposes) |
| 2684 | ** --usepidkey Use saved encryption key from parent process. This is |
| 2685 | ** only necessary when using SEE on Windows. |
| 2686 | ** |
| 2687 | ** See also: [[cgi]], [[server]], [[winsrv]] |
| 2688 | */ |
| 2689 |