The 2vcard Handbook

Jan Schaumann jschauma@netmeister.org 
Version 0.6, Sat Jul 30 17:57:34 EDT 2005

This Handbook describes 2vcard Version 0.6


1. Introduction

2. Installation

  2.1 How to obtain 2vcard 
  2.2 Requirements 
  2.3 Compilation and installation 

3. Usage

4. Copyright

5. Misc

------------------------------------------

1. Introduction

2vcard is a little perl script to convert an addressbook to the popular VCARD
file format. Currently, 2vcard can convert mutt's and mh's alias as well as
pine's, abook's and juno's addressbook format. 

The VCARD format is used by gnomecard, for example, which in turn is used by
the balsa email client. 

This is version 0.6 of 2vcard.

------------------------------------------
2. Installation

2.1 How to obtain 2vcard

2vcard 0.4 can be obtained from:

   http://www.netmeister.org/apps/2vcard/2vcard-0.6.tar.gz - as a gzipped source-tarball 
   http://www.netmeister.org/apps/2vcard/2vcard-0.6.tar.bz2 - as a bzip2'ed source-tarball 

2.2 Requirements

In order to successfully use 2vcard, you need the following programs and
libraries which are available on most platforms as distribution packages and
thereby can be installed easily.

Required:

   Perl http://www.perl.com 

2.3 Compilation and installation

2vcard assumes that the Perl executable lives in /usr/bin/perl - if that is
not the case, use your favorite editor to modify the first line of the file
2vcard accordingly.

In order to install 2vcard from sources, type the following in the directory
to which you downloaded the 2vcard distribution:

   % tar zxvf 2vcard-0.6.tar.gz
   % cd 2vcard-0.6
   % less README
   % su
   % make install


This will install 2vcard in /usr/local/bin, the man page in /usr/local/share/man/man1/ and
the documentation in /usr/local/share/doc/2vcard/.

Should you run into problems please report them to the the author at
jschauma@netmeister.org

------------------------------------------

3. Usage

Per default, 2vcard reads from stdin and writes to stdout. Alternatively, the
input- and output-files can be specified as command-line options. 

Examples:

In a pipe:
cat ~/.addressbook | 2vcard -p

Alone:
2vcard -i ~/.aliases -o ~/.addbook.grcd 

If you run into any problems, if you encounter bugs, or if you have any other
comments on this program,please don't hesitate to email me.

------------------------------------------

4. Copyright

2vcard Copyright 2001,2002,2003 Jan Schaumann, jschauma@netmeister.org

 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

   * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.
   * The name of the author may not be used to endorse or promote products
     derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.

------------------------------------------

5. Misc

Please take the time to visit these websites:

   http://www.hrweb.org/legal/udhr.html 
   http://www.aclu.org 
   http://www.amnesty.org 
   http://www.worldwildlife.org 
   http://www.ncadp.org 

Take the time to think about it.
