Fossil SCM

Completed rough draft pass through all the global command line options.

rberteig 2016-02-29 08:01 UTC ross-doc-env
Commit 95bd81f85e85077f041d62d6cc2a5bfb433ee6dc
1 file changed +35 -17
+35 -17
--- www/env-opts.md
+++ www/env-opts.md
@@ -27,48 +27,66 @@
2727
probably odd interactions possible if you mix case sensitive and case
2828
insensitive file systems on any single platform. This option or the
2929
global setting should be used to force the case sensitivity to the
3030
most sensible condition.
3131
32
-`--chdir DIRECTORY`:
32
+`--chdir DIRECTORY`: Change to the named directory before processing
33
+any commands.
3334
3435
36
+`--comfmtflags NUMBER`: Specify flags that control how check-in
37
+comments and certain other text outputs are formatted for display. The
38
+flags are individual bits in `NUMBER`:
3539
36
-`--comfmtflags NUMBER`:
40
+ 0 no special formatting
41
+ 1 legacy algorithm (default)
42
+ 2 trim leading CR and LF
43
+ 4 trim leading and trailing spaces
44
+ 8 word break
45
+ 16 line break before comment
3746
3847
39
-`--errorlog ERRLOG`:
48
+`--errorlog ERRLOG`: Name a file to which fossil will log panics,
49
+errors, and warnings.
50
+
4051
4152
`--help`: If `--help` is found anywhere on the command line, translate
4253
the command to `fossil help cmdname` where `cmdname` is the first
4354
argument that does not begin with a `-` character. If all arguments
4455
start with `-`, translate to `fossil help argv[1] argv[2]...`.
4556
46
-`--httptrace`:
57
+`--httptrace`: (Sets `g.fHttpTrace`.) Trace outbound HTTP requests.
4758
48
-`--localtime`:
59
+`--localtime`: Override the `timeline-utc` option to explicitly use
60
+local time.
4961
5062
`--nocgi`: Prevent fossil from acting as a CGI by default even if the
5163
`GATEWAY_INTERFACE` environment variable is set.
5264
53
-`--no-th-hook`:
54
-
55
-`--quiet`:
56
-
57
-`--sqltrace`:
58
-
59
-`--sqlstats`:
60
-
61
-`--sshtrace`:
65
+`--no-th-hook`: (Sets `g.fNoThHook`.)
66
+
67
+`--quiet`: (Sets `g.fQuiet`.) Cause fossil to suppress various messages and progress
68
+indicators that would otherwise be printed.
69
+
70
+`--sqltrace`: (Sets `g.SqlTrace`.) Implies `--sqlstats`. Trace certain
71
+SQLite database activity, especially showing every SQL query
72
+processed.
73
+
74
+`--sqlstats`: (Sets `g.fSqlStats`.) Print a number of performance
75
+statistics about each SQLite database used when it is closed.
76
+
77
+`--sshtrace`: (Sets `g.fSshTrace`.)
6278
6379
`--ssl-identity SSLIDENTITY`:
6480
65
-`--systemtrace`:
81
+`--systemtrace`: (Sets `g.fSystemTrace`.) Trace all commands launched
82
+as sub processes.
6683
67
-`--user LOGIN`: Also `-U LOGIN`.
84
+`--user LOGIN`: Also `-U LOGIN`. Set the user name.
6885
69
-`--utc`:
86
+`--utc`: Override the `timeline-utc` option to explicitly use
87
+UTC time.
7088
7189
`--vfs VFSNAME`: Load the named VFS into SQLite.
7290
7391
7492
Environment Variables
7593
--- www/env-opts.md
+++ www/env-opts.md
@@ -27,48 +27,66 @@
27 probably odd interactions possible if you mix case sensitive and case
28 insensitive file systems on any single platform. This option or the
29 global setting should be used to force the case sensitivity to the
30 most sensible condition.
31
32 `--chdir DIRECTORY`:
 
33
34
 
 
 
35
36 `--comfmtflags NUMBER`:
 
 
 
 
 
37
38
39 `--errorlog ERRLOG`:
 
 
40
41 `--help`: If `--help` is found anywhere on the command line, translate
42 the command to `fossil help cmdname` where `cmdname` is the first
43 argument that does not begin with a `-` character. If all arguments
44 start with `-`, translate to `fossil help argv[1] argv[2]...`.
45
46 `--httptrace`:
47
48 `--localtime`:
 
49
50 `--nocgi`: Prevent fossil from acting as a CGI by default even if the
51 `GATEWAY_INTERFACE` environment variable is set.
52
53 `--no-th-hook`:
54
55 `--quiet`:
56
57 `--sqltrace`:
58
59 `--sqlstats`:
60
61 `--sshtrace`:
 
 
 
 
62
63 `--ssl-identity SSLIDENTITY`:
64
65 `--systemtrace`:
 
66
67 `--user LOGIN`: Also `-U LOGIN`.
68
69 `--utc`:
 
70
71 `--vfs VFSNAME`: Load the named VFS into SQLite.
72
73
74 Environment Variables
75
--- www/env-opts.md
+++ www/env-opts.md
@@ -27,48 +27,66 @@
27 probably odd interactions possible if you mix case sensitive and case
28 insensitive file systems on any single platform. This option or the
29 global setting should be used to force the case sensitivity to the
30 most sensible condition.
31
32 `--chdir DIRECTORY`: Change to the named directory before processing
33 any commands.
34
35
36 `--comfmtflags NUMBER`: Specify flags that control how check-in
37 comments and certain other text outputs are formatted for display. The
38 flags are individual bits in `NUMBER`:
39
40 0 no special formatting
41 1 legacy algorithm (default)
42 2 trim leading CR and LF
43 4 trim leading and trailing spaces
44 8 word break
45 16 line break before comment
46
47
48 `--errorlog ERRLOG`: Name a file to which fossil will log panics,
49 errors, and warnings.
50
51
52 `--help`: If `--help` is found anywhere on the command line, translate
53 the command to `fossil help cmdname` where `cmdname` is the first
54 argument that does not begin with a `-` character. If all arguments
55 start with `-`, translate to `fossil help argv[1] argv[2]...`.
56
57 `--httptrace`: (Sets `g.fHttpTrace`.) Trace outbound HTTP requests.
58
59 `--localtime`: Override the `timeline-utc` option to explicitly use
60 local time.
61
62 `--nocgi`: Prevent fossil from acting as a CGI by default even if the
63 `GATEWAY_INTERFACE` environment variable is set.
64
65 `--no-th-hook`: (Sets `g.fNoThHook`.)
66
67 `--quiet`: (Sets `g.fQuiet`.) Cause fossil to suppress various messages and progress
68 indicators that would otherwise be printed.
69
70 `--sqltrace`: (Sets `g.SqlTrace`.) Implies `--sqlstats`. Trace certain
71 SQLite database activity, especially showing every SQL query
72 processed.
73
74 `--sqlstats`: (Sets `g.fSqlStats`.) Print a number of performance
75 statistics about each SQLite database used when it is closed.
76
77 `--sshtrace`: (Sets `g.fSshTrace`.)
78
79 `--ssl-identity SSLIDENTITY`:
80
81 `--systemtrace`: (Sets `g.fSystemTrace`.) Trace all commands launched
82 as sub processes.
83
84 `--user LOGIN`: Also `-U LOGIN`. Set the user name.
85
86 `--utc`: Override the `timeline-utc` option to explicitly use
87 UTC time.
88
89 `--vfs VFSNAME`: Load the named VFS into SQLite.
90
91
92 Environment Variables
93

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button