.\"Copyright 2018 Northern.tech AS
.\"
.\"This file is part of CFEngine 3 - written and maintained by Northern.tech AS.
.\"
.\"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; version 3.
.\"
.\"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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA
.\"
.\"To the extent this program is licensed as part of the Enterprise
.\"versions of CFEngine, the applicable Commercial Open Source License
.\"(COSL) may apply to this file if you as a licensee so wish it. See
.\"included file COSL.txt.
.TH CF-KEY 8 "CFEngine" "System Administration"
.SH NAME
cf-key \- make private/public key-pairs for CFEngine authentication
.SH SYNOPSIS
.B cf-key
.RI [ OPTION ]...

.SH DESCRIPTION
The CFEngine key generator makes key pairs for remote authentication.

.SH OPTIONS
.IP "--help, -h"
Print the help message
.IP "--inform, -I"
Print basic information about key generation
.IP "--debug, -d"
Enable debugging output
.IP "--verbose, -v"
Output verbose information about the behaviour of the agent
.IP "--version, -V"
Output the version of the software
.IP "--log-level, -g value"
Specify how detailed logs should be. Possible values: 'error', 'warning', 'notice', 'info', 'verbose', 'debug'
.IP "--output-file, -f value"
Specify an alternative output file than the default.
.IP "--key-type, -T value"
Specify a RSA key size in bits, the default value is 2048.
.IP "--show-hosts, -s"
Show lastseen hostnames and IP addresses
.IP "--remove-keys, -r value"
Remove keys for specified hostname/IP
.IP "--force-removal, -x"
Force removal of keys (USE AT YOUR OWN RISK)
.IP "--install-license, -l value"
Install license file on Enterprise server (CFEngine Enterprise Only)
.IP "--print-digest, -p value"
Print digest of the specified public key
.IP "--trust-key, -t value"
Make cf-serverd/cf-agent trust the specified public key. Argument value is of the form [[USER@]IPADDR:]FILENAME where FILENAME is the local path of the public key for client at IPADDR address.
.IP "--color, -C value"
Enable colorized output. Possible values: 'always', 'auto', 'never'. If option is used, the default value is 'auto'
.IP "--timestamp, -Ò"
Log timestamps on each line of log output
.IP "--numeric, -n"
Do not lookup host names
.SH CFENGINE
CFEngine provides automated configuration management of large-scale computer systems. A system administrator describes the desired state of a system using CFEngine policy code. The program \fBcf-agent\fR reads policy code and attempts to bring the current system state to the desired state described. Policy code is downloaded by \fBcf-agent\fR from a \fBcf-serverd\fR daemon. The daemon \fBcf-execd\fR is responsible for running \fBcf-agent\fR periodically.
.br
Documentation for CFEngine is available at http://cfengine.com/documentation/.
.SH PROMISE THEORY
CFEngine is built on principles from promise theory, proposed by Mark Burgess in 2004. Promise theory is a model of voluntary cooperation between individual, autonomous actors or agents who publish their intentions to one another in the form of promises. A promise is a declaration of intent whose purpose is to increase the recipient's certainty about a claim of past, present or future behaviour. For a promise to increase certainty, the recipient needs to trust the promiser, but trust can also be built on the verification that previous promises have been kept, thus trust plays a symbiotic relationship with promises. 
.br
For an introduction to promise theory, please see http://arxiv.org/abs/0810.3294/
.SH AVAILABILITY
cf-key is part of CFEngine.
.br
Binary packages may be downloaded from http://cfengine.com/downloads/.
.br
The source code is available at http://github.com/cfengine/
.SH BUGS
Please see the public bug-tracker at http://bug.cfengine.com/.
.br
GitHub pull-requests may be submitted to http://github.com/cfengine/core/.
.SH "SEE ALSO"
.BR cf-promises (8),
.BR cf-agent (8),
.BR cf-serverd (8),
.BR cf-execd (8),
.BR cf-monitord (8),
.BR cf-runagent (8),
.BR cf-key (8)
.SH AUTHOR
Mark Burgess and CFEngine AS