Fossil SCM
Add documentation for the FOSSIL_REPOLIST_SHOW environment variable.
Commit
fbd77310b65e0ce5c64c86e14d738795e32ad3f43e9f70ad7420230f9efe8882
Parent
aca98b92e2c31ac…
3 files changed
+8
-1
+6
+6
+8
-1
| --- src/main.c | ||
| +++ src/main.c | ||
| @@ -2365,11 +2365,18 @@ | ||
| 2365 | 2365 | ** notfound: URL When in "directory:" mode, redirect to |
| 2366 | 2366 | ** URL if no suitable repository is found. |
| 2367 | 2367 | ** |
| 2368 | 2368 | ** repolist When in "directory:" mode, display a page |
| 2369 | 2369 | ** showing a list of available repositories if |
| 2370 | -** the URL is "/". | |
| 2370 | +** the URL is "/". Some control over the display | |
| 2371 | +** is accomplished using environment variables. | |
| 2372 | +** FOSSIL_REPOLIST_TITLE is the tital of the page. | |
| 2373 | +** FOSSIL_REPOLIST_SHOW cause the "Description" | |
| 2374 | +** column to display if it contains "description" as | |
| 2375 | +** as a substring, and causes the Login-Group column | |
| 2376 | +** to display if it contains the "login-group" | |
| 2377 | +** substring. | |
| 2371 | 2378 | ** |
| 2372 | 2379 | ** localauth Grant administrator privileges to connections |
| 2373 | 2380 | ** from 127.0.0.1 or ::1. |
| 2374 | 2381 | ** |
| 2375 | 2382 | ** nossl Signal that no SSL connections are available. |
| 2376 | 2383 |
| --- src/main.c | |
| +++ src/main.c | |
| @@ -2365,11 +2365,18 @@ | |
| 2365 | ** notfound: URL When in "directory:" mode, redirect to |
| 2366 | ** URL if no suitable repository is found. |
| 2367 | ** |
| 2368 | ** repolist When in "directory:" mode, display a page |
| 2369 | ** showing a list of available repositories if |
| 2370 | ** the URL is "/". |
| 2371 | ** |
| 2372 | ** localauth Grant administrator privileges to connections |
| 2373 | ** from 127.0.0.1 or ::1. |
| 2374 | ** |
| 2375 | ** nossl Signal that no SSL connections are available. |
| 2376 |
| --- src/main.c | |
| +++ src/main.c | |
| @@ -2365,11 +2365,18 @@ | |
| 2365 | ** notfound: URL When in "directory:" mode, redirect to |
| 2366 | ** URL if no suitable repository is found. |
| 2367 | ** |
| 2368 | ** repolist When in "directory:" mode, display a page |
| 2369 | ** showing a list of available repositories if |
| 2370 | ** the URL is "/". Some control over the display |
| 2371 | ** is accomplished using environment variables. |
| 2372 | ** FOSSIL_REPOLIST_TITLE is the tital of the page. |
| 2373 | ** FOSSIL_REPOLIST_SHOW cause the "Description" |
| 2374 | ** column to display if it contains "description" as |
| 2375 | ** as a substring, and causes the Login-Group column |
| 2376 | ** to display if it contains the "login-group" |
| 2377 | ** substring. |
| 2378 | ** |
| 2379 | ** localauth Grant administrator privileges to connections |
| 2380 | ** from 127.0.0.1 or ::1. |
| 2381 | ** |
| 2382 | ** nossl Signal that no SSL connections are available. |
| 2383 |
+6
| --- www/cgi.wiki | ||
| +++ www/cgi.wiki | ||
| @@ -79,10 +79,16 @@ | ||
| 79 | 79 | If no repository has such a non-zero repolist-skin setting, then |
| 80 | 80 | the repository list is generic HTML without any decoration, with |
| 81 | 81 | the page title taken from the <tt>FOSSIL_REPOLIST_TITLE</tt> |
| 82 | 82 | environment variable. The variable can be defined in the CGI |
| 83 | 83 | control file using the [#setenv|<tt>setenv:</tt>] statement. |
| 84 | + | |
| 85 | +The "Project Description" and "Login-Group" columns on the repolist page | |
| 86 | +are optional. They are hidden by default. Show them by putting value "1" | |
| 87 | +in the global settings "show-repolist-desc" and "show-repolist-lg", or | |
| 88 | +by setting the <tt>FOSSIL_REPOLIST_SHOW</tt> environment variable to | |
| 89 | +a string that contains substrings "description" and/or "login-group". | |
| 84 | 90 | |
| 85 | 91 | The repolist-generated page recurses into subdirectories and will list |
| 86 | 92 | all <tt>*.fossil</tt> files found, with the following exceptions: |
| 87 | 93 | |
| 88 | 94 | * Filenames starting with a period are treated as "hidden" and skipped. |
| 89 | 95 |
| --- www/cgi.wiki | |
| +++ www/cgi.wiki | |
| @@ -79,10 +79,16 @@ | |
| 79 | If no repository has such a non-zero repolist-skin setting, then |
| 80 | the repository list is generic HTML without any decoration, with |
| 81 | the page title taken from the <tt>FOSSIL_REPOLIST_TITLE</tt> |
| 82 | environment variable. The variable can be defined in the CGI |
| 83 | control file using the [#setenv|<tt>setenv:</tt>] statement. |
| 84 | |
| 85 | The repolist-generated page recurses into subdirectories and will list |
| 86 | all <tt>*.fossil</tt> files found, with the following exceptions: |
| 87 | |
| 88 | * Filenames starting with a period are treated as "hidden" and skipped. |
| 89 |
| --- www/cgi.wiki | |
| +++ www/cgi.wiki | |
| @@ -79,10 +79,16 @@ | |
| 79 | If no repository has such a non-zero repolist-skin setting, then |
| 80 | the repository list is generic HTML without any decoration, with |
| 81 | the page title taken from the <tt>FOSSIL_REPOLIST_TITLE</tt> |
| 82 | environment variable. The variable can be defined in the CGI |
| 83 | control file using the [#setenv|<tt>setenv:</tt>] statement. |
| 84 | |
| 85 | The "Project Description" and "Login-Group" columns on the repolist page |
| 86 | are optional. They are hidden by default. Show them by putting value "1" |
| 87 | in the global settings "show-repolist-desc" and "show-repolist-lg", or |
| 88 | by setting the <tt>FOSSIL_REPOLIST_SHOW</tt> environment variable to |
| 89 | a string that contains substrings "description" and/or "login-group". |
| 90 | |
| 91 | The repolist-generated page recurses into subdirectories and will list |
| 92 | all <tt>*.fossil</tt> files found, with the following exceptions: |
| 93 | |
| 94 | * Filenames starting with a period are treated as "hidden" and skipped. |
| 95 |
+6
| --- www/env-opts.md | ||
| +++ www/env-opts.md | ||
| @@ -153,10 +153,16 @@ | ||
| 153 | 153 | |
| 154 | 154 | `FOSSIL_REPOLIST_TITLE`: The page title of the "Repository List" page |
| 155 | 155 | loaded by the `fossil all ui` or `fossil ui /` commands. Only used if |
| 156 | 156 | none of the listed repositories has the `repolist_skin` property set. |
| 157 | 157 | Can be set from the [CGI control file][cgictlfile]. |
| 158 | + | |
| 159 | +`FOSSIL_REPOLIST_SHOW`: If this variable exists and has a text value | |
| 160 | +that contains the substring "description", then the "Project Description" | |
| 161 | +column appears on the repolist page. If it contains the substring | |
| 162 | +"login-group", then the Login-Group column appears on the repolist page. | |
| 163 | +Can be set from the [CGI control file][cgictlfile]. | |
| 158 | 164 | |
| 159 | 165 | `FOSSIL_USE_SEE_TEXTKEY`: If set, treat the encryption key string for |
| 160 | 166 | SEE as text to be hashed into the actual encryption key. This has no |
| 161 | 167 | effect if Fossil was not compiled with SEE support enabled. |
| 162 | 168 | |
| 163 | 169 |
| --- www/env-opts.md | |
| +++ www/env-opts.md | |
| @@ -153,10 +153,16 @@ | |
| 153 | |
| 154 | `FOSSIL_REPOLIST_TITLE`: The page title of the "Repository List" page |
| 155 | loaded by the `fossil all ui` or `fossil ui /` commands. Only used if |
| 156 | none of the listed repositories has the `repolist_skin` property set. |
| 157 | Can be set from the [CGI control file][cgictlfile]. |
| 158 | |
| 159 | `FOSSIL_USE_SEE_TEXTKEY`: If set, treat the encryption key string for |
| 160 | SEE as text to be hashed into the actual encryption key. This has no |
| 161 | effect if Fossil was not compiled with SEE support enabled. |
| 162 | |
| 163 |
| --- www/env-opts.md | |
| +++ www/env-opts.md | |
| @@ -153,10 +153,16 @@ | |
| 153 | |
| 154 | `FOSSIL_REPOLIST_TITLE`: The page title of the "Repository List" page |
| 155 | loaded by the `fossil all ui` or `fossil ui /` commands. Only used if |
| 156 | none of the listed repositories has the `repolist_skin` property set. |
| 157 | Can be set from the [CGI control file][cgictlfile]. |
| 158 | |
| 159 | `FOSSIL_REPOLIST_SHOW`: If this variable exists and has a text value |
| 160 | that contains the substring "description", then the "Project Description" |
| 161 | column appears on the repolist page. If it contains the substring |
| 162 | "login-group", then the Login-Group column appears on the repolist page. |
| 163 | Can be set from the [CGI control file][cgictlfile]. |
| 164 | |
| 165 | `FOSSIL_USE_SEE_TEXTKEY`: If set, treat the encryption key string for |
| 166 | SEE as text to be hashed into the actual encryption key. This has no |
| 167 | effect if Fossil was not compiled with SEE support enabled. |
| 168 | |
| 169 |