'\" t
.\"     Title: yapet_config
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 02/23/2014
.\"    Manual: File Formats
.\"    Source: yapet 1.0
.\"  Language: English
.\"
.TH "YAPET_CONFIG" "5" "02/23/2014" "yapet 1\&.0" "File Formats"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
yapet_config \- format of YAPET configuration file
.SH "DESCRIPTION"
.PP

\fByapet\fR(1)
reads the configuration file
\fB$HOME\fR/\&.yapet
if it exists unless a different file is specified by using the
\fB\-r\fR
option (see
\fByapet\fR(1))\&. Options given on the command line override options given in a configuration file\&.
.PP
The configuration file has the following syntax:
.sp
.if n \{\
.RS 4
.\}
.nf
\fIoption\fR=\fIvalue\fR
.fi
.if n \{\
.RE
.\}
.PP
where
\fIoption\fR
can be any of the following:
.PP
\fBcolors\fR
.RS 4
(String) Set custom colors\&. See
\fByapet_colors\fR(5)
for more information\&.
.RE
.PP
\fBload\fR
.RS 4
(String) The file to load upon start of
\fByapet\fR\&.
.sp
Equivalent to providing a
\fIfilename\fR
when invoking
\fByapet\fR\&.
.sp
A
\fB~\fR
(tilde) sign as the first character of the pathname will be replaced by the home directory of the user running
\fByapet\fR\&.
.sp
Default: not set
.RE
.PP
\fBlocktimeout\fR
.RS 4
(Integer) A positive integer specifying the time of inactivity in seconds until the screen is locked\&.
.sp
Equivalent to providing the
\fB\-t\fR
option when invoking
\fByapet\fR\&.
.sp
Default: 600
.RE
.PP
\fBpwinputtimeout\fR
.RS 4
(Integer) A positive integer specifying the time of inactivity in seconds until the password prompt for unlocking the screen will disappear\&.
.sp
Default: 60
.RE
.PP
\fBallowlockquit\fR
.RS 4
(Boolean) A value of
true
allows the user to quit
\fByapet\fR
from the locked screen (if no changes are pending)\&. A value of
false
prevents the user from quitting
\fByapet\fR
when the screen is locked\&.
.sp
Default:
true
.RE
.PP
\fBcheckfsecurity\fR
.RS 4
(Boolean) A value of
true
enables the verification of the file owner and permissions when loading a file\&. A value of
false
disables the verification of the file owner and permissions when loading a file\&.
.sp
Equivalent to providing the
\fB\-S\fR
(same as
true) or
\fB\-s\fR
(same as
false) options when invoking
\fByapet\fR\&.
.sp
Default:
true
.RE
.PP
\fBpwgen_rng\fR
.RS 4
(String) The random number generator used to generate passwords\&. Possible values are
.PP
devrandom
.RS 4
Request using
/dev/random\&. This is a high\-quality random number generator\&. However, if the system lacks entropy, reading from this device may block, thus making
\fByapet\fR
unresponsive\&.
.RE
.PP
devurandom
.RS 4
Request using
/dev/urandom\&. This is a quality random number generator similar to
/dev/random
but not of the same quality\&.
.sp
Using this random number generator will not block as opposite to
/dev/random\&.
.RE
.PP
lrand48
.RS 4
Request using
lrand48\&. This is a low\-quality random number generator and should be used only if none of the above two random number generators are available\&.
.RE
.PP
rand
.RS 4
Request using
rand\&. This is a last resort random number generator and should not be used\&.
.RE
.sp
If the random number generator requested is not available on the system,
\fByapet\fR
takes the next best random number generator\&.
.sp
Default: devurandom
.RE
.PP
\fBpwgen_pwlen\fR
.RS 4
(Integer) A positive integer greater than zero specifying the default password length used by the Password Generator Dialog\&.
.sp
Default: 15
.RE
.PP
\fBpwgen_letters\fR
.RS 4
(Boolean) A value of
true
will preselect the
Letters
check box of the Password Generator Dialog\&.
false
does not preselect the
Letters
check box\&.
.sp
Default:
true
.RE
.PP
\fBpwgen_digits\fR
.RS 4
(Boolean) A value of
true
will preselect the
Digits
check box of the Password Generator Dialog\&.
false
does not preselect the
Digits
check box\&.
.sp
Default:
true
.RE
.PP
\fBpwgen_punct\fR
.RS 4
(Boolean) A value of
true
will preselect the
Punctuation
check box of the Password Generator Dialog\&.
false
does not preselect the
Punctuation
check box\&.
.sp
Default:
true
.RE
.PP
\fBpwgen_special\fR
.RS 4
(Boolean) A value of
true
will preselect the
Special
check box of the Password Generator Dialog\&.
false
does not preselect the
Special
check box\&.
.sp
Default:
true
.RE
.PP
\fBpwgen_other\fR
.RS 4
(Boolean) A value of
true
will preselect
Other
check box of the Password Generator Dialog\&.
false
does not preselect the
Other
check box\&.
.sp
Default:
false
.RE
.PP
For Boolean values,
1,
yes,
true,
enable, and
enabled
denote true\&.
0,
false,
no,
disable,
disabled
denote false\&. Please note, Boolean values are case\-sensitive\&.
.PP
See
the section called \(lqEXAMPLES\(rq
for examples of configuration files\&.
.SH "EXAMPLES"
.PP
\fBExample\ \&1.\ \&Example of an yapet configuration file\fR
.sp
.if n \{\
.RS 4
.\}
.nf
load=/home/joe/passwords
locktimeout=300
checkfsecurity=0
pwgen_pwlen=8
.fi
.if n \{\
.RE
.\}
.PP
In this example, the file
/home/joe/passwords
will be loaded upon invocation of
\fByapet\fR\&. The timeout until the screen is locked is set to 300 seconds\&. File permissions will not be verified\&.
.PP
The Password Generator Dialog will have preset the
Password Length
to 8 characters\&.
.PP
\fBExample\ \&2.\ \&Example of an yapet configuration file\fR
.sp
.if n \{\
.RS 4
.\}
.nf
locktimeout=150
checkfsecurity=yes
pwgen_other=enable
.fi
.if n \{\
.RE
.\}
.PP
In this example, no file will be automatically loaded upon invocation of
\fByapet\fR\&. The timeout until the screen is locked is set to 150 seconds\&. File permissions and owner will be verified\&.
.PP
The Password Generator Dialog will have preset the
Other
check box checked\&.
.PP
\fBExample\ \&3.\ \&Example 1 revisited\fR
.sp
.if n \{\
.RS 4
.\}
.nf
load=~/passwords\&.pet
locktimeout=300
checkfsecurity=false
pwgen_pwlen=8
.fi
.if n \{\
.RE
.\}
.PP
This example has the same effect as
Example\ \&1, \(lqExample of an yapet configuration file\(rq\&. But instead of specifying the full path to the home directory, the ~ (tilde) sign is used, which is expanded to the home directory automatically\&. The
\&.pet
suffix can be specified, but if omitted it will be appended automatically\&.
.SH "FILES"
.PP
\fB$HOME\fR/\&.yapet
.RS 4
The per\-user configuration file\&. If existing, options are read from this file but can be overridden by the command line options\&.
.sp
Processing of this file can be disabled by invoking
\fByapet\fR
with the
\fB\-i\fR
option\&.
.RE
.SH "AUTHOR"
.sp
Rafael Ostertag rafi@guengel\&.ch
.SH "SEE ALSO"
.sp
\fByapet\fR(1), \fByapet_colors\fR(5)
.SH "COPYRIGHT"
.br
Copyright \(co 2008, 2009, 2010, 2011, 2013, 2014 Rafael Ostertag <rafi@guengel.ch>
.br