/usr/lib/python3/dist-packages/khard-0.11.3.egg-info/PKG-INFO is in khard 0.11.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 | Metadata-Version: 1.1
Name: khard
Version: 0.11.3
Summary: A console carddav client
Home-page: https://github.com/scheibler/khard/
Author: Eric Scheibler
Author-email: email@eric-scheibler.de
License: GPL
Description: khard
=====
Khard is an address book for the Linux console. It creates, reads, modifies and removes carddav
address book entries at your local machine. Khard is also compatible to the email clients mutt and
alot and the SIP client twinkle. You can find more information about khard and the whole
synchronization process
[here](http://eric-scheibler.de/en/blog/2014/10/Sync-calendars-and-address-books-between-Linux-and-Android/).
Khard is developed and tested on Debian operating system, versions 7, 8 and testing but should run
on all Unix-like systems.
Warning: If you want to create or modify contacts with khard, beware that the vcard standard is very
inconsistent and lacks interoperability. Different actors in that sector have defined their own
extensions and even produce non-standard output. A good example is the type value, which is tied to
phone numbers, email and post addresses. Khard tries to avoid such incompatibilities but if you sync
your contacts with an Android or iOS device, expect problems. You are on the save side, if you only
use khard to read contacts. For further information about the vcard compatibility issues have a look
into [this blog post](http://alessandrorossini.org/2012/11/15/the-sad-story-of-the-vcard-format-and-its-lack-of-interoperability/).
With version 0.11.0, khard changed from python2 to python3. So if you come from a prior khard
version, it may be necessary to reinstall in a newly created python3 virtual environment.
Configuration
-------------
You can copy the example config file and adapt it's contents to your needs:
```
mkdir ~/.config/khard/
cp /usr/share/doc/khard/examples/khard/khard.conf.example ~/.config/khard/khard.conf
```
Usage
-----
The following subsections give an overview of khard's main features.
You may get general help and all available actions with
```
khard --help
```
If you need help on a specific action, use:
```
khard action --help
```
Beware, that the order of the command line parameters matters.
### Show contacts ###
After you have created a new address book or calendar and you have synced it to your local machine,
you can list all available contacts with the following command:
```
khard list
```
or if you have more than one address book and you want to filter the output:
```
khard list -a addressbook1,addressbook2
```
The resulting contact table only contains the first phone number and email address. If you want to view all contact
details you can pick one from the list:
```
khard details
```
or search for it:
```
khard details [--strict-search] name of contact
```
or select the contact by it's uid, which you can find at the contacts table:
```
khard details -u ID
```
The parameters -a and -u from the examples above are always optional. If you don't use them or your
input produces unambiguous results, you may pick the contacts from a list instead.
The search parameter searches in all data fields. Therefore you aren't limited to the contact's name
but you also could for example search for a part of a phone number, email address or post address.
However if you explicitly want to narrow your search to the name field, you may use the
--strict-search parameter instead.
### Create contact ###
Add new contact with the following command:
```
khard new [-a "address book name"]
```
The template for the new contact opens in the text editor, which you can set in the khard.conf file.
It follows the yaml syntax.
Alternatively you can create the contact from stdin:
```
echo """
First name : John
Last name : Smith
Email :
work : john.smith@example.org
Phone :
home : xxx 555 1234
Categories :
- cat1
- cat2
- cat3
""" | khard new [-a "address book name"]
```
or create from input template file:
```
khard new -i contact.yaml [-a "address book name"]
```
You may get an empty contact template with the following command:
```
khard export --empty-contact-template -o empty.yaml
```
Per default khard creates vcards of version 3.0. If your other contact applications support vcards
of the more recent version 4.0, you may change this with the option --vcard-version. Example:
```
khard new --vcard-version=4.0 [-a "address book name"]
```
For a more permanent solution you may set the preferred_version parameter in the vcard section of
the khard config file (see misc/khard/khard.conf.example for more details). But beware, that khard
cannot convert already existing contacts from version 3.0 to 4.0. Therefore this setting is not
applicable to the modify action.
### Edit contacts ###
Use the following to modify the contact after successful creation:
```
khard modify [-a addr_name] [-u uid|search terms [search terms ...]]
```
If you want to edit the contact elsewhere, you can export the filled contact template:
```
khard export -o contact.yaml [-a addr_name] [-u uid|search terms [search terms ...]]
```
Edit the yaml file and re-import either through stdin:
```
cat contact.yaml | khard modify [-a addr_name] [-u uid|search terms [search terms ...]]
```
or file name:
```
khard modify -i contact.yaml [-a addr_name] [-u uid|search terms [search terms ...]]
```
If you want to merge contacts use the following to select a first and then a second contact:
```
khard merge [-a source_abook] [-u uid|search terms [search terms ...]] [-A target_abook] [-U target_uid|-t target_search_terms]
```
You will be launched into your merge_editor ( see the "merge_editor" option in khard.conf)
where you can merge all changes from the first selected contact onto the second.
Once you are finished, the first contact is deleted and the second one updated.
Copy or move contact:
```
khard copy [-a source_abook] [-u uid|search terms [search terms ...]] [-A target_abook]
khard move [-a source_abook] [-u uid|search terms [search terms ...]] [-A target_abook]
```
Remove contact:
```
khard remove [-a addr_name] [-u uid|search terms [search terms ...]]
```
mutt
----
Khard may be used as an external address book for the email client mutt. To accomplish that, add the
following to your mutt config file (mostly ~/.mutt/muttrc):
```
set query_command= "khard email --parsable %s"
bind editor <Tab> complete-query
bind editor ^T complete
```
Then you can complete email addresses by pressing the Tab-key in mutt's new mail dialog. If your
address books contain hundreds or even thousands of contacts and the query process is very slow, you
may try the --search-in-source-files option to speed up the search:
```
set query_command= "khard email --parsable --search-in-source-files %s"
```
To add email addresses to khard's address book, you may also add the following lines to your muttrc file:
```
macro index,pager A \
"<pipe-message>khard add-email<return>" \
"add the sender email address to khard"
```
Then navigate to an email message in mutt's index view and press "A" to start the address import dialog.
Alot
----
Add the following lines to your alot config file:
```
[accounts]
[[youraccount]]
[[[abook]]]
type = shellcommand
command = khard email --parsable
regexp = '^(?P<email>[^@]+@[^\t]+)\t+(?P<name>[^\t]+)'
ignorecase = True
```
Twinkle
-------
For those who also use the SIP client twinkle to take phone calls, khard can be used to query
incoming numbers. The plugin tries to find the incoming caller id and speaks it together with the
phone's ring tone. The plugin needs the following programs:
```
sudo aptitude install ffmpeg espeak sox mpc
```
sox and ffmpeg are used to cut and convert the new ring tone and espeak speaks the caller id. mpc is a client
for the music player daemon (mpd). It's required to stop music during an incoming call. Skip the last,
if you don't use mpd. Don't forget to set the "stop_music"-parameter in the config.py file to
False too.
After the installation, copy the scripts and sounds folders to your twinkle config folder:
```
cp -R misc/twinkle/* ~/.twinkle/
```
Then edit your twinkle config file (mostly ~/.twinkle/twinkle.cfg) like this:
```
# RING TONES
# We need a default ring tone. Otherwise the phone would not ring at all, if something with the
# custom ring tone creation goes wrong.
ringtone_file=/home/USERNAME/.twinkle/sounds/incoming_call.wav
ringback_file=/home/USERNAME/.twinkle/sounds/outgoing_call.wav
# SCRIPTS
script_incoming_call=/home/USERNAME/.twinkle/scripts/incoming_call.py
script_in_call_answered=
script_in_call_failed=/home/USERNAME/.twinkle/scripts/incoming_call_failed.py
script_outgoing_call=
script_out_call_answered=
script_out_call_failed=
script_local_release=/home/USERNAME/.twinkle/scripts/incoming_call_ended.py
script_remote_release=/home/USERNAME/.twinkle/scripts/incoming_call_ended.py
```
Zsh
---
The file /usr/share/doc/khard/examples/zsh/_khard contains a zsh completion definition for khard.
Install by copying to a directory where zsh searches for completion functions (the $fpath array).
If you, for example, put all completion functions into the folder ~/.zsh/completions you must add
the following to your zsh main config file:
```
fpath=( $HOME/.zsh/completions $fpath )
autoload -U compinit
compinit
```
sdiff
-----
Use the wrapper script /usr/share/doc/khard/examples/sdiff/sdiff_khard_wrapper.sh if you want to use sdiff as your contact
merging tool. Just make the script executable and set it as your merge editor in khard's config file:
```
merge_editor = /path/to/sdiff_khard_wrapper.sh
```
Related projects
----------------
If you need a console based calendar too, try out [khal](https://github.com/geier/khal).
Keywords: Carddav console addressbook
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3 :: Only
|