.\" Text automatically generated by txt2man
.TH cpm 1 "10 December 2022" "cpm 0.32" "User Commands"
.SH NAME
\fBcpm \- Console Password Manager
\fB
.SH SYNOPSIS
.nf
.fam C
\fBcpm\fP [\fB--config\fP \fIFILE\fP] [\fB--configtest\fP] [\fB--encoding\fP] [\fB--file\fP \fIFILE\fP] [\fB--help\fP]
  [\fB--key\fP \fIKEY\fP] [\fB--noencryption\fP] [\fB--readonly\fP] [\fB--security\fP] [\fB--testrun\fP \fITYPE\fP]
  [\fB--version\fP] [\fIPATH\fP]

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
Keep a password database safe and encrypted.
.TP
.B
\fB--config\fP, \fB-c\fP
configuration file to use [~/.cpmrc]
.TP
.B
\fB--configtest\fP
verify the configuration file and exit
.TP
.B
\fB--debuglevel\fP
debuglevel (0=off, 1 - 99)
.TP
.B
\fB--encoding\fP, \fB-e\fP
the encoding in which keyboard input arrives [ISO-8859-1]
.TP
.B
\fB--environment\fP
list the environment after cleanup
.TP
.B
\fB--file\fP, \fB-f\fP
database file to use [~/.cpmdb]
.TP
.B
\fB--help\fP, \fB-h\fP
display this help
.TP
.B
\fB--key\fP
overwrite the default encryption keys and use this key
instead; repeat for several keys
.TP
.B
\fB--noencryption\fP
turn off file encryption
WARNING: THIS IS FOR DEVELOPMENT AND TESTING ONLY!
.TP
.B
\fB--readonly\fP, \fB-r\fP
open the database in read-only mode
.TP
.B
\fB--security\fP, \fB-s\fP
run a security check and show the current security status
.TP
.B
\fB--testrun\fP
run one of the testmodes
.RS
.TP
.B
backup
run test on the backupfile creation
.TP
.B
compress[1-6]
run compression test 1-6
.TP
.B
decrypt
run test on the decryption code
.TP
.B
encrypt
run test on the encryption code
.TP
.B
environment
run test on the environment validation
.TP
.B
garbage
run test on garbage input files
.TP
.B
searchpattern
run test on the search patterns
This only works when the application has been compiled with
the compiler flag \fB-DTEST_OPTION\fP.
.RE
.TP
.B
\fB--version\fP
display the version and exit
.TP
.B
\fIPATH\fP
path to display the password for
.SH KEYS
The following keys launch commands in the GUI of \fBcpm\fP:
.RS
.TP
.B
* ^A
add a new node to the current node.
.TP
.B
* ^D
delete the currently selected node and all its subnodes.
.TP
.B
* ^E
edit the currently selected node.
.TP
.B
* ^H
show the help screen.
.TP
.B
* ^K
edit the currently used encryption keys.
.TP
.B
* ^N
edit the name of the current level.
.TP
.B
* ^O
edit the comment of the selected node.
.TP
.B
* ^P
edit the current node and suggest a password.
.TP
.B
* ^W
write the database to disk.
.SH ENVIRONMENT
The following environment variables are used by the application:
.RS
.TP
.B
* GNUPGHOME
If set directory used instead of "~/.gnupg".
.TP
.B
* GPG_AGENT_INFO
Used  to  locate the gpg-agent
.TP
.B
* HOME
Used to locate the default home directory.
.TP
.B
* LANG
Used to determine the user's language.
.TP
.B
* COLUMNS
Used to size some displays to the full size of the screen.
.TP
.B
* LINES
Used to size some displays to the full size of the screen.
.IP \(bu 3
NCURSES_NO_UTF8_ACS
Used to configure terminal behaviour with special
charaters, see \fBncurses\fP(3).
.TP
.B
* TERMCAP
Terminal settings of the currently used terminal.
.TP
.B
* TERM
Terminal settings of the currently used terminal.
.RE
.PP
All other variables are discarded at program startup.
.SH IMPORT
The data import utilities are installed in /usr/share/\fBcpm\fP and the following
formats can be imported:
.RS
.IP \(bu 3
csv
.IP \(bu 3
passwordsafe
.IP \(bu 3
pms
.SH SEE ALSO
\fBgpg\fP(1), \fBncurses\fP(3)
.SH REPORTING BUGS
Report bugs to <harry_b@mm.st>.
.SH COPYRIGHT
Copyright (C) 2005-2009 Harry Brueckner
.PP
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
.PP
Contact: Harry Brueckner <harry_b@mm.st>
Muenchener Strasse 12a
85253 Kleinberghofen
Germany