manpage.md

   1 % phone(1)
   2 % Victor Wagner <vitus@wagner.pp.ru>
   3 % June 2018
   4
   5 NAME
   6 ====
   7
   8 *phone* - manage phonebook in vcf file
   9
  10 SYNOPSIS
  11 ========
  12
  13 **phone** [**-vtm**] *pattern*
  14
  15 **phone** **-p** *pattern* > *filename.jpg*
  16
  17 **phone** **-e** *pattern*
  18
  19 **phone** **-n**
  20
  21 **phone** **-d** *pattern*
  22
  23 **phone** **-i** *filename.vcf*
  24
  25 **phone** **-P** *pattern* *filename.jpg*
  26
  27 DESCRIPTION
  28 ===========
  29
  30 This program allows you to query and modify addressbook stored in
  31 single file of VCARDs. Such phone book can be exported from most mobile
  32 phones or synchronized from CardDAV server using **vdirsyncer**(1).
  33
  34 Phonebook can be also added as address source into **claws-mail**(1).
  35
  36 Default mode of operation is to search phonebook for given pattern and
  37 output results in the specified format.
  38
  39 One of available output formats is VCARD, so it is possible to export
  40 some contacts as vcf files.
  41
  42 Other functions available are
  43
  44 * Display/export contact's photo
  45 * Edit entry in the text editor
  46 * Create new contact by entering field by field from keyboard
  47 * Add/replace photo
  48 * Delete contact(s)
  49
  50 This program doesn't understand GNU-style long options. It is
  51 intentional.
  52
  53 PATTERN SYNTAX
  54 ==============
  55
  56 By default pattern is interpreted as regular expression and matched
  57 against all meaningful fields.
  58
  59 Also possible to use syntax *name*=*regular-expression* which allows
  60 to match specific field.
  61
  62 OPTIONS
  63 =======
  64
  65 Output Options
  66 --------------
  67
  68 **-m**
  69
  70    : *Mail* output just E-Mail address. Suitable to use as **mutt**(1)
  71    `query_command` option
  72
  73 **-v**
  74
  75    : *VCARD* output output found contacts as vcards.
  76
  77 **-t**
  78
  79    : *tabular* output.
  80
  81 **-p**
  82
  83    : output contacts *photo*.  If stdout is redirected, sends it there,
  84    otherwise saves it to temporary file and invokes **xdg-open**(1) to
  85    display. If more than one contact with photo matches the pattern,
  86    lets user choose interactively.
  87
  88 Common Options
  89 --------------
  90
  91 **-f** *filename.vcf*
  92
  93   : Use specified file instead of default one.
  94
  95 Editing options
  96 ---------------
  97
  98 **-n**
  99
 100   : Create new contact by asking for fields from STDIN
 101
 102 **-e**
 103
 104   : Edit contact
 105