2 kabcclient - commandline client for the KDE addressbook
7 kabcclient [[-A] | [-R] | [-M] | [-S] | [-L]] [--match-case] [--nosave]
10 [-ic codec] [-if format] [-if-opts format-options]
11 [-oc codec] [-of format] [-of-opts format-options]
12 [input-data]
13
15 kabcclient allows commandline access to the KDE addressbook, for
16 example in shell scripts. It supports input from stdin or through
17 additional commandline arguments. Output is always written to stdout.
18
20 Operation modes
21 -A, --add
23 Add a new contact entry to the addressbook
24 -R, --remove
26 Removes an existing contact entry from the addressbook
27 -M, --merge
29 Merges input data with an existing contact entry from the
30 addressbook. This appends any new information to the already
31 existing one
32 -S, --search
34 Searches the addressbook for matching contact entries
35 -L, --list
37 Lists all contact entries of the addressbook
38 Input options
40 -ic, --input-codec
42 Pass input text through a specified text encoding. See -ic help
43 for additional information about input codecs. Default is local
44 which will use the codec for the current locale(5) settings
45 -if, --input-format
47 Parses the input text according to given formatting rules. See
48 -if help for available formats. Default is search
49 Instead of reading input text kabcclient can show a dialog for
51 selecting contacts using the input format
52 dialog
53 -if-opts, --input-format-options
55 Additional options for the chosen input format. Can be optional
56 as well as mandatory depending on the format. See -if-opts help
57 for available format options
58 Output options
60 -oc, --output-codec
62 Pass output text through a specified text encoding. See -oc
63 help for additional information about output codecs. Default is
64 local which will use the codec for the current locale(5)
65 settings.
66 -of, --output-format
68 Formats the output text according to given formatting rules.
69 See -of help for available formats. Default is vcard
70 -of-opts, --output-format-options
72 Additional options for the chosen output format. Can be
73 optional as well as mandatory depending on the format. See
74 -of-opts help for available format options
75 Additional options
77 --match-case
79 Use case sensitive text matching when comparing input text with
80 contact entries
81 --nosave
83 Perform information changing operations like -A, -R or -M only
84 in memory but do not write the changes back to the addressbook
85
87 As usual an exit status of zero indicates success. Depending on the
88 chosen operation mode a non-zero exit status indicates a certain
89 problem the application encountered
90 ADD
92 1
94 Reading the input text failed
95 2
97 Creating a suitable contact entry from the input text failed,
98 e.g. not data or wrongly formatted input for the chosen input
99 format
100 3
102 Saving the addressbook changes failed. This can be caused for
103 example by other applications currently locking the
104 addressbook.
105 REMOVE
107 1
109 Reading the input text failed
110 2
112 The program could not remove any contact entry from the
113 addressbook. This can be caused by failing to parse the input
114 text, failing to find a matching contact entry in the
115 addressbook or finding more than one matching contact entry in
116 the addressbook. In the latter case an error message is written
117 to stderr
118 3
120 Saving the addressbook changes failed. This can be caused for
121 example by other applications currently locking the
122 addressbook.
123 MERGE
125 1
127 Reading the input text failed
128 2
130 The program could not merge the input with any contact entry
131 from the addressbook. This can be caused by failing to parse
132 the input text, failing to find a matching contact entry in the
133 addressbook or finding more than one matching contact entry in
134 the addressbook. In the latter case an error message is written
135 to stderr
136 3
138 Saving the addressbook changes failed. This can be caused for
139 example by other applications currently locking the
140 addressbook.
141 SEARCH, 1
143 Reading the input text failed
144 2
146 The program could not find any matching contact entry in the
147 addressbook. This can be caused by failing to parse the input
148 text or failing to find a matching contact entry in the
149 addressbook
150
152 Look for contact entries with Joe in either name or email addresses
153 kabcclient -S Joe
155 Do the same but use case sensitive matching
157 kabcclient --match-case -S Joe
159 Do the same but read input text from stdin
161 echo "Joe" | kabcclient --match-case -S
163 Try to add a new contact entry using data from a formatted email
165 address
166 kabcclient --nosave --add -if email "Marilyn Monroe <mmonroe@moviestars.com>"
168 Do the same but this time really save the changed addressbook
170 kabcclient --add -if email "Marilyn Monroe <mmonroe@moviestars.com>"
172 Listing the available input formats
174 kabcclient -if help
176 Listing the available output formats
178 kabcclient -of help
180 Listing the available options for the 'email' output format
182 kabcclient -of email -of-opts help
184 Listing all email addresses for all contacts containing 'Marilyn'
186 kabcclient -of email -of-opts allemails -S Marilyn
188 Remove all contacts the user selected in the contact selection dialog
190 kabcclient --remove -if dialog
192 Export selected contacts to a VCard (default output format) file
194 kabcclient -S -if dialog > contacts.vcf
196
198 This manual page was written by Kevin Krammer <kevin.krammer@gmx.at>.
199 Permission is granted to copy, distribute and/or modify this document
200 under the terms of the GNU General Public License, Version 2 any later
201 version published by the Free Software Foundation.
202 On Debian systems, the complete text of the GNU General Public License
204 can be found in /usr/share/common-licenses/GPL.
205K Desktop Environment 2005-09-08 kabcclient(1)