cmd/shrt/internal/help/helpdoc.go in go-shrt

at v0.4.1

1
// See LICENSE file for copyright and license details
2
3
package help
4
5
import "djmo.ch/go-shrt/cmd/shrt/internal/base"
6
7
var EnvCmd = &base.Command{
8
	Name:      "environment",
9
	ShortHelp: "environment variables",
10
	LongHelp: `
11
The shrt command consults environment variables for configuration. If
12
an environment variable is unset, the shrt command uses a sensible
13
default setting. To see the effective setting of the variable <NAME>,
14
run 'shrt env <NAME>'. To change the default setting, run 'shrt env -w
15
<NAME>=<VALUE>'. Defaults changed using 'shrt env -w' are recorded in
16
a Shrt environment configuration file stored in /etc/shrt/config on
17
Unix systems and C:\ProgramData\shrt\config on Windows. The location
18
of the configuration file can be changed by setting the environment
19
variable DGITENV, and 'shrt env DGITENV' prints the effective
20
location, but 'shrt env -w' cannot change the default location. See
21
'shrt help env' for details.
22
23
Environment variables:
24
25
	SHRTENV
26
		The location of the Shrt environment configuration
27
		file. Cannot be set using 'shrt env -w'.
28
	SHRT_SRVNAME
29
		The server name of the Shrt host.
30
	SHRT_SCMTYPE
31
		The SCM (or VCS) type.
32
	SHRT_SUFFIX
33
		The SCM repository suffix, if required by repository
34
		host.
35
	SHRT_RDRNAME
36
		The server name of the repository host.
37
	SHRT_BARERDR
38
		Where requests with an empty path should redirect.
39
	SHRT_DBPATH
40
		The absolute path to the database file.
41
	SHRT_GOSOURCEDIR
42
		The string to append to the URL for go-get redirects
43
		to form the directory entry in the go-source meta tag.
44
		This key is experimental and may be removed in a
45
		future release.
46
	SHRT_GOSOURCEFILE
47
		The string to append to the URL for go-get redirects
48
		to form the file entry in the go-source meta tag. This
49
		key is experimental and may be removed in a future
50
		release.
51
`,
52
}