Debian Codegraph @

README

raw
1 The 2vcard Handbook
2
3 Jan Schaumann [email protected]
4 Version 0.6, Sat Jul 30 17:57:34 EDT 2005
5
6 This Handbook describes 2vcard Version 0.6
7
8
9 1. Introduction
10
11 2. Installation
12
13 2.1 How to obtain 2vcard
14 2.2 Requirements
15 2.3 Compilation and installation
16
17 3. Usage
18
19 4. Copyright
20
21 5. Misc
22
23 ------------------------------------------
24
25 1. Introduction
26
27 2vcard is a little perl script to convert an addressbook to the popular VCARD
28 file format. Currently, 2vcard can convert mutt's and mh's alias as well as
29 pine's, abook's and juno's addressbook format.
30
31 The VCARD format is used by gnomecard, for example, which in turn is used by
32 the balsa email client.
33
34 This is version 0.6 of 2vcard.
35
36 ------------------------------------------
37 2. Installation
38
39 2.1 How to obtain 2vcard
40
41 2vcard 0.4 can be obtained from:
42
43 http://www.netmeister.org/apps/2vcard/2vcard-0.6.tar.gz - as a gzipped source-tarball
44 http://www.netmeister.org/apps/2vcard/2vcard-0.6.tar.bz2 - as a bzip2'ed source-tarball
45
46 2.2 Requirements
47
48 In order to successfully use 2vcard, you need the following programs and
49 libraries which are available on most platforms as distribution packages and
50 thereby can be installed easily.
51
52 Required:
53
54 Perl http://www.perl.com
55
56 2.3 Compilation and installation
57
58 2vcard assumes that the Perl executable lives in /usr/bin/perl - if that is
59 not the case, use your favorite editor to modify the first line of the file
60 2vcard accordingly.
61
62 In order to install 2vcard from sources, type the following in the directory
63 to which you downloaded the 2vcard distribution:
64
65 % tar zxvf 2vcard-0.6.tar.gz
66 % cd 2vcard-0.6
67 % less README
68 % su
69 % make install
70
71
72 This will install 2vcard in /usr/local/bin, the man page in /usr/local/share/man/man1/ and
73 the documentation in /usr/local/share/doc/2vcard/.
74
75 Should you run into problems please report them to the the author at
76 [email protected]
77
78 ------------------------------------------
79
80 3. Usage
81
82 Per default, 2vcard reads from stdin and writes to stdout. Alternatively, the
83 input- and output-files can be specified as command-line options.
84
85 Examples:
86
87 In a pipe:
88 cat ~/.addressbook | 2vcard -p
89
90 Alone:
91 2vcard -i ~/.aliases -o ~/.addbook.grcd
92
93 If you run into any problems, if you encounter bugs, or if you have any other
94 comments on this program,please don't hesitate to email me.
95
96 ------------------------------------------
97
98 4. Copyright
99
100 2vcard Copyright 2001,2002,2003 Jan Schaumann, [email protected]
101
102 All rights reserved.
103
104 Redistribution and use in source and binary forms, with or without
105 modification, are permitted provided that the following conditions are met:
106
107 * Redistributions of source code must retain the above copyright notice,
108 this list of conditions and the following disclaimer.
109 * Redistributions in binary form must reproduce the above copyright
110 notice, this list of conditions and the following disclaimer in the
111 documentation and/or other materials provided with the distribution.
112 * The name of the author may not be used to endorse or promote products
113 derived from this software without specific prior written permission.
114
115 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
116 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
117 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
118 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
119 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
120 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
121 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
122 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
123 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
124 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
125 POSSIBILITY OF SUCH DAMAGE.
126
127 ------------------------------------------
128
129 5. Misc
130
131 Please take the time to visit these websites:
132
133 http://www.hrweb.org/legal/udhr.html
134 http://www.aclu.org
135 http://www.amnesty.org
136 http://www.worldwildlife.org
137 http://www.ncadp.org
138
139 Take the time to think about it.