yapet_config(5)

1YAPET_CONFIG(5)                  YAPET_CONFIG                  YAPET_CONFIG(5)
2
3
4

NAME

6       yapet_config - format of a YAPET configuration file
7

DESCRIPTION

9       yapet(1) reads the configuration file $HOME/.yapet if it exists unless
10       a different file is specified by using the -r option, see yapet(1).
11       Options given on the command line override options given in a
12       configuration file.
13
14       The configuration file has the following syntax:
15
16           option=value
17
18       where option can be any of the following:
19
20       colors
21           (String) Set custom colors. See yapet_colors(5) for more
22           information.
23
24       load
25           (String) The file to load upon start of yapet. Equivalent to
26           providing a filename when invoking yapet. A ~ (tilde) sign as the
27           first character of the pathname will be replaced by the home
28           directory of the user running yapet.
29
30           Default: not set
31
32       locktimeout
33           (Integer) A positive integer specifying the time of inactivity in
34           seconds until the screen is locked. Equivalent to providing the -t
35           option when invoking yapet.
36
37           Default: 600
38
39       pwinputtimeout
40           (Integer) A positive integer specifying the time of inactivity in
41           seconds until the password prompt for unlocking the screen will
42           disappear.
43
44           Default: 60
45
46       allowlockquit
47           (Boolean) A value of true allows the user to quit yapet from the
48           locked screen (if no changes are pending).
49           A value of false prevents the user from quitting yapet when the
50           screen is locked.
51
52           Default: true
53
54       checkfsecurity
55           (Boolean) A value of true enables the verification of the file
56           owner and permissions when loading a file.
57           A value of false disables the verification of the file owner and
58           permissions when loading a file. Equivalent to providing the -S
59           (same as true) or -s (same as false) options when invoking yapet.
60
61           Default: true
62
63       pwgen_pwlen
64           (Integer) A positive integer greater than zero specifying the
65           default password length used by the Password Generator Dialog.
66
67           Default: 15
68
69       pwgen_letters
70           (Boolean) A value of true will preselect the Letters check box of
71           the Password Generator Dialog.
72
73           Default: true
74
75       pwgen_digits
76           (Boolean) A value of true will preselect the Digits check box of
77           the Password Generator Dialog.
78
79           Default: true
80
81       pwgen_punct
82           (Boolean) A value of true will preselect the Punctuation check box
83           of the Password Generator Dialog.
84
85           Default: true
86
87       pwgen_special
88           (Boolean) A value of true will preselect the Special check box of
89           the Password Generator Dialog.
90
91           Default: true
92
93       pwgen_other
94           (Boolean) A value of true will preselect Other check box of the
95           Password Generator Dialog.
96
97           Default: false
98
99       argon2_memory
100           (Integer) Memory used by the Argon2 hash algorithm in KB.
101
102           Default: 262144
103
104       argon2_parallelism
105           (Integer) Number of threads used by the Argon2 hash algorithm.
106
107           Default: 16
108
109       argon2_iterations
110           (Integer) Number of iterations performed by the Argon2 hash
111           algorithm.
112
113           Default: 5
114
115       For Boolean values, 1, yes, true, enable, and enabled denote true. 0,
116       false, no, disable, disabled denote false. Please note, Boolean values
117       are case-sensitive.
118
119       The argon2_* options only take effect when creating a new file or
120       changing the master password of an existing file.
121

EXAMPLES

123   Example of an yapet configuration file
124           load=/home/joe/passwords
125           locktimeout=300
126           checkfsecurity=0
127           pwgen_pwlen=8
128
129       In this example, the file /home/joe/passwords will be loaded upon
130       invocation of yapet. The timeout until the screen is locked is set to
131       300 seconds. File permissions will not be verified.
132
133       The Password Generator Dialog will have preset the Password Length to 8
134       characters.
135
136   Example of an yapet configuration file
137           locktimeout=150
138           checkfsecurity=yes
139           pwgen_other=enable
140
141       In this example, no file will be automatically loaded upon invocation
142       of yapet. The timeout until the screen is locked is set to 150 seconds.
143       File permissions and owner will be verified.
144
145       The Password Generator Dialog will have preset the Other check box
146       checked.
147
148   Example 1 revisited
149           load=~/passwords.pet
150           locktimeout=300
151           checkfsecurity=false
152           pwgen_pwlen=8
153
154       This example has the same effect as Example of an yapet configuration
155       file. But instead of specifying the full path to the home directory,
156       the ~ (tilde) sign is used, which is expanded to the home directory
157       automatically. The .pet suffix can be specified, but if omitted it will
158       be appended automatically.
159

FILES

161       $HOME/.yapet
162           The per-user configuration file. If existing, options are read from
163           this file but can be overridden by the command line options.
164           Processing of this file can be disabled by invoking yapet with the
165           -i option.
166

AUTHORS

168       Rafael Ostertag rafi@guengel.ch.
169

NAME

DESCRIPTION

EXAMPLES

FILES

AUTHORS

SEE ALSO