'\" t
.\"     Title: yapet
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 02/23/2014
.\"    Manual: User Commands
.\"    Source: yapet 1.0
.\"  Language: English
.\"
.TH "YAPET" "1" "02/23/2014" "yapet 1\&.0" "User Commands"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
yapet \- text based password manager
.SH "SYNOPSIS"
.ad l
.HP \w'\fByapet\fR\ 'u
\fByapet\fR [[\fB\-c\fR] | [\fB\-h\fR] | [\fB\-V\fR]] [[\fB\-i\fR] | [\fB\-r\fR\ {\fIrcfile\fR}]] [[\fB\-s\fR] | [\fB\-S\fR]] [\fB\-t\fR\ {\fIsec\fR}] [\fIfilename\fR]
.ad
.SH "DESCRIPTION"
.PP

\fByapet\fR
provides a text user interface for storing passwords and associated information (referred to as
password records) in files encrypted on disk\&. A password record is comprised of a record name, host name, user name, password, and comment\&. A master password is required to encrypt/decrypt the password records in a given file\&.
\fByapet\fR
does not impose a limit of password records per file\&.
.PP
Files created by
\fByapet\fR
always have the suffix
\&.pet\&. Also, if a file is loaded using the command line,
\fByapet\fR
appends the suffix
\&.pet
to the filename unless the filename includes this suffix already\&. By default,
\fByapet\fR
refuses to load files not having a file mode of 0600\&. This behavior can be changed by providing the
\fB\-s\fR
option when starting
\fByapet\fR
or using a configuration file (see
\fByapet_config\fR(5), and
the section called \(lqOPTIONS\(rq)\&.
.PP
After loading a file, the record name of each password record is displayed in a list\&. Existing password records can be opened by selecting them and pressing
Enter\&. By default, existing password records are opened in read\-only mode to avoid accidental changes\&. Pressing
Ctrl+r
toggles between read\-only and edit mode\&.
.PP
On terminals supporting colors, the password is hidden if the password record dialog is in read\-only mode\&. The password can be made visible, by either going to edit mode (Ctrl+r), or by pressing
Ctrl+t\&.
.PP

\fByapet\fR
relies on OpenSSL for encryption and decryption of password records\&. The cipher for encryption and decryption is Blowfish with a 448 bits key\&.
.PP
Other features of
\fByapet\fR
are:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Screen lock after a certain amount of inactivity when password file is loaded (see also
\fByapet_config\fR(5)
and
the section called \(lqOPTIONS\(rq)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Password records opened in read\-only mode (default) hide the password\&. Toggling into edit mode reveals the password (see
the section called \(lqPassword Record Dialog Keys\(rq)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Import of CSV files (see
\fBcsv2yapet\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Export of YAPET files to CSV files (see
\fByapet2csv\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Integrated password generator\&.
.RE
.SS "Main Window Function Keys"
.PP
Following function keys are recognized in the main window:
.PP
h
.RS 4
Show an overview of the function keys\&.
.RE
.PP
Enter
.RS 4
Open the currently selected password record\&.
.RE
.PP
s
.RS 4
Save changes to currently loaded file\&.
.RE
.PP
r
.RS 4
Open a file\&.
.RE
.PP
e
.RS 4
Create a new, empty file\&.
.RE
.PP
l
.RS 4
Lock the screen immediately\&. Takes only effect if a file is loaded\&.
.RE
.PP
a
.RS 4
Add a new password record\&.
.RE
.PP
d
.RS 4
Delete the currently selected password record\&.
.RE
.PP
o
.RS 4
Change the sort order of the password record list\&.
.RE
.PP
/
.RS 4
Search for a password record\&. The search is only performed on the Name of the password record\&. Other password record fields won\'t be searched\&.
.RE
.PP
n
.RS 4
Search for the next occurrence of a previous search initiated by
/\&.
.RE
.PP
c
.RS 4
Change the master password of the currently loaded YAPET file\&.
.RE
.PP
i
.RS 4
Show various information about YAPET and the loaded file, if any\&.
.RE
.PP
Ctrl+l (^L)
.RS 4
Redraw the entire screen\&.
.RE
.PP
g
.RS 4
Open the password generator\&.
.RE
.PP
q
.RS 4
Quit YAPET\&.
.RE
.SS "Cursor Movement Keys"
.PP
Cursor movement, whether in clear text or password fields, is accomplished by using the following keys:
.PP
Left, Ctrl+b
.RS 4
Moves the cursor one character to the left\&.
.RE
.PP
Right, Ctrl+f
.RS 4
Moves the cursor one character to the right\&.
.RE
.PP
Home, Ctrl+a
.RS 4
Moves the cursor to the beginning of the input field\&.
.RE
.PP
End, Ctrl+e
.RS 4
Moves the cursor to the end of the input field\&.
.RE
.PP
Backspace
.RS 4
Delete the character left of the cursor\&.
.RE
.PP
Delete, Ctrl+d
.RS 4
Delete the character under the cursor\&.
.RE
.PP
Ctrl+k
.RS 4
Delete all characters under and right of the cursor\&.
.RE
.PP
Ctrl+u
.RS 4
Delete all characters left of the cursor\&.
.RE
.PP
Enter, Tab
.RS 4
Focus the next widget\&.
.RE
.PP
Shift+Tab
.RS 4
Focus the previous widget\&.
.RE
.SS "Password Record Dialog Keys"
.PP
Following function keys are recognized in the password record dialog, besides cursor movement keys (see
the section called \(lqCursor Movement Keys\(rq):
.PP
Ctrl+r
.RS 4
Toggle the password record dialog between read\-only and edit mode\&. In read\-only mode,
\fByapet\fR
hides the password (only supported on color terminals)\&.
.RE
.PP
Ctrl+t
.RS 4
Toggle between hiding and showing the password, without setting the password record dialog to edit mode (only supported on color terminals)\&. Has no effect if the password record dialog is in edit mode\&.
.RE
.SH "OPTIONS"
.PP
The following options are supported:
.PP
\fB\-c\fR
.RS 4
Show copyright information\&.
.RE
.PP
\fB\-h\fR
.RS 4
Print help text\&.
.RE
.PP
\fB\-i\fR
.RS 4
Do not read the configuration file\&.
.RE
.PP
\fB\-r\fR \fIrcfile\fR
.RS 4
Read the configuration file specified by
\fIrcfile\fR\&. If this option is not given, the default configuration file read is
\fB$HOME\fR/\&.yapet
unless
\fB\-i\fR
is specified\&.
.RE
.PP
\fB\-s\fR
.RS 4
Disable the check for the owner and file mode when loading files\&. Without this option,
\fByapet\fR
checks password files for having the same owner as the user running
\fByapet\fR
and verifies that the file mode is strictly 0600\&. If one of these conditions are not met,
\fByapet\fR
refuses to load the file\&. Providing this options disables those checks and
\fByapet\fR
will load files with owners other than the process owner of
\fByapet\fR
and file modes different from 0600\&.
.sp
New files saved while this option is active will have the file mode set according to
\fBumask\fR(2)\&.
.RE
.PP
\fB\-S\fR
.RS 4
Enable the check for the owner and file mode when loading files\&. This option makes
\fByapet\fR
to load password files having the owner set to the process owner of
\fByapet\fR
and the file mode strictly set to 0600 only\&. If one of these conditions are not met,
\fByapet\fR
refuses to load the file\&.
.sp
New files saved while this option is active will have the file mode set to 0600\&.
.sp
This is the default mode\&.
.RE
.PP
\fB\-t\fR \fIsec\fR
.RS 4
Set the timeout until the screen is locked to
\fIsec\fR
seconds\&. The minimum time allowed is 10 seconds\&. If a smaller value is provided, the timeout will be set to 10 seconds\&.
.sp
Default: 10 min\&.
.RE
.PP
\fB\-V\fR
.RS 4
Show version of
\fByapet\fR\&.
.RE
.PP
\fB\fIfilename\fR\fR
.RS 4
The file to open upon invocation of
\fByapet\fR\&. If the file does not exist,
\fByapet\fR
asks whether it should be created\&.
.sp
Files created by
\fByapet\fR
always have the suffix
\&.pet\&.
.RE
.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\&.
.sp
Refer to the
\fByapet_config\fR(5)
for an explanation of the per\-user configuration file\&.
.RE
.SH "ENVIRONMENT"
.PP
\fBLC_MESSAGES\fR
.RS 4
Displaying messages in the specified language\&. Currently only German is supported besides English\&.
.RE
.SH "FORMAT OF YAPET FILES"
.PP
Please refer to the
DESIGN
file in the source code distribution or point your browser to
\m[blue]\fBhttp://www\&.guengel\&.ch/myapps/yapet/\fR\m[]\&.
.SH "BUGS"
.PP
Please report bugs to
\m[blue]\fBhttp://bugs\&.guengel\&.ch/\fR\m[]\&.
.SH "AUTHOR"
.sp
Rafael Ostertag rafi@guengel\&.ch
.SH "SEE ALSO"
.sp
\fByapet_config\fR(5), \fByapet_colors\fR(5), \fBcsv2yapet\fR(1), \fByapet2csv\fR(1)
.SH "AVAILABILITY"
.PP
The latest version of
\fByapet\fR
can be found under
\m[blue]\fBhttp://www\&.guengel\&.ch/myapps/yapet/\fR\m[]\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2008, 2009, 2010, 2011, 2013, 2014 Rafael Ostertag <rafi@guengel.ch>
.br