.\" Man page generated from reStructuredText.
.
.TH "KHARD" "1" "Aug 13, 2020" "0.17" "khard"
.SH NAME
khard \- Console carddav client
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBkhard\fP [\fI\%\-c\fP CONFIG] [\fI\%\-\-debug\fP] [\fI\%\-\-skip\-unparsable\fP] SUBCOMMAND …
.sp
\fBkhard\fP \fI\%\-h\fP | \fI\%\-\-help\fP
.sp
\fBkhard\fP \fI\%\-v\fP | \fI\%\-\-version\fP
.SH DESCRIPTION
.sp
\fBkhard\fP is an address book for the Unix command line.  It can read, create,
modify and delete carddav address book entries.  \fBkhard\fP only works with a local
store of VCARD files.  It is intended to be used in conjunction with other
programs like an email client, text editor, vdir synchronizer or VOIP client.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config CONFIG
configuration file (default: \fB~/.config/khard/khard.conf\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-debug
output debugging information
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
show a help message and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-\-skip\-unparsable
skip unparsable vcards when reading the address books
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-version
show program’s version number and exit
.UNINDENT
.SH SUBCOMMANDS
.sp
The functionality of khard is divided into several subcommands.  All of these
have their own help text which can be seen with \fBkhard SUBCOMMAND \-\-help\fP\&.
.sp
Many subcommands accept search terms to limit the number of contacts they
should work on, display or present for selection.  The syntax is described in
\fI\%Search query syntax\fP\&.
.SS Listing subcommands
.sp
These subcommands list information of several contacts who match a search
query.
.INDENT 0.0
.TP
.B list
list all (selected) contacts
.TP
.B birthdays
list birthdays (sorted by month and day)
.TP
.B email
list email addresses
.TP
.B phone
list phone numbers
.TP
.B postaddress
list postal addresses
.TP
.B filename
list filenames of all matching contacts
.UNINDENT
.SS Detailed display
.sp
These subcommands display detailed information about one subcommand.
.INDENT 0.0
.TP
.B show
display detailed information about one contact, supported output formats
are “pretty”, “yaml” and “vcard”
.TP
.B export
DEPRECATED, use \fBshow \-\-format=yaml\fP instead
.UNINDENT
.SS Modifying subcommands
.sp
These subcommands are used to modify contacts.
.INDENT 0.0
.TP
.B edit
edit the data of a contact, supported formats for editing are “yaml” and
“vcard”
.TP
.B new
create a new contact
.TP
.B add\-email
Extract email address from the “From:” field of an email header and add to an
existing contact or create a new one
.TP
.B merge
merge two contacts
.TP
.B copy
copy a contact to a different addressbook
.TP
.B move
move a contact to a different addressbook
.TP
.B remove
remove a contact
.TP
.B source
DEPRECATED, use \fBedit \-\-format=vcard\fP instead
.UNINDENT
.SS Other subcommands
.INDENT 0.0
.TP
.B addressbooks
list all address books
.TP
.B template
print an empty yaml template
.UNINDENT
.SH SEARCH QUERY SYNTAX
.sp
Search queries consist of one or more command line arguments.  Each can be a
simple search term or a search term for a specific field.  The field name is
separated from the search term by a colon (\fB:\fP) without any spaces.
.sp
Spaces in the field name have to be replaced with underscores.
.sp
The available fields are the same fields as in the YAML template with the
exception of the five name components (first, last, prefix, suffix,
additional).  But there is the special pseudo field specifier \fBname:\fP which
will search in \fIany\fP name related field (including nichnames and formatted
names).
.sp
If a field name is not known the search term is interpreted as a plain search
term and the string (including the colon) is looked up in any field of the
contact.
.SH CONFIGURATION
.sp
See \fBkhard.conf(5)\fP\&.
.SH COPYRIGHT
2020, Eric Scheibler
.\" Generated by docutils manpage writer.
.