summaryrefslogtreecommitdiff
path: root/surveil/surveil/NOTES
blob: b4cf5215299d17f8c32a7c87c24d9a7acf55277f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
Handle unused variables more gracefully.

Program options:
-h
	prints help/usage message and exit

-p
	prints digest providers available

-q
	turn on quiet mode

-t
	test configuration and exit

-v
	turn on verbose mode

-c file
	sets a specific configuration file
	defaults to stdout for data
	overrides configuration directory, ignored and mutually exclusive
	if -d, data to that file
	if -D, data to that directory at $conf.dat

-d file
	sets a specific data file
	defaults to configuration from $config/surveil.conf 
		or if -C dir, then $dir/surveil.dat
		of if -c file, then $file.dat
	override data directory, ignored and mutually exclusive

-C dir
	sets configuration directory
	defaults to $XDG_CONFIG_HOME/$progname or $HOME/.$progname
	main configuration defaults to $dir/$progname.conf

-D dir
	set data directory
	defaults to $XDG_DATA_HOME/$progname or $HOME/.$progname
	main data file defaults to $dir/$progname.dat

With no command line options to change the configuration/data directories/files,
then defaults are (searched in order listed:

configuration:
	$XDG_CONFIG_HOME/$progname
	$HOME/.$progname

data:
	$XDG_DATA_HOME/$progname
	$HOME/.$progname

-P prunetype
	set pruning and method, for clearing out database entries

	without prune set in configuration file, defaults to none (keep all)
	STALE: only prune db entries that don't exist in config file
	PURGE: purge all db entries from db (empty)
	SPECIFIC: prune db entry for command line specified jobs