ppl 4.0.3 → 4.0.5

data/gh-pages/documentation/commands/age/index.md

@@ -1,38 +0,0 @@
----
-title: ppl age Manual Page
-layout: command
-section: documentation
-command: age
----
-
-### Name
-
-ppl age - List or show contacts' ages
-
-### Synopsis
-
-    ppl age [<contact>]
-
-### Description
-
-This command calculates contacts' current ages in years based on their date of
-birth. The purpose of this command is to provide easy access to an often-needed
-piece of information which is indirectly available from the data in the address
-book.
-
-Invoked without any arguments, all contacts are listed with their respective
-ages. If a `<contact>` is specified, only the age of that contact will be shown.
-
-### Examples
-
-    $ ppl bday jdoe 1980-01-01
-    $ ppl age jdoe
-    33
-    $ ppl age
-    fred: 25
-    jdoe: 33
-
-### See Also
-
-* [ppl bday](../bday)
-* [color output](/documentation/configuration/color_age)

data/gh-pages/documentation/commands/bday/index.md

@@ -1,44 +0,0 @@
----
-title: ppl bday Manual Page
-layout: command
-section: documentation
-command: bday
----
-
-### Name
-
-ppl bday - List, show or change birthdays
-
-### Synopsis
-
-    ppl bday
-    ppl bday <contact>
-    ppl bday <contact> <date>
-
-### Description
-
-With no arguments, the dates of birth of each contact in the address book are
-listed.
-
-If a `<contact>` is specified, the date of birth of that contact is shown.
-
-If both a `<contact>` and a `<date>` are given, then the date is stored as the
-date of birth of that contact. The `<date>` parameter must be a valid date
-string parseable by Ruby's
-[Date.parse](http://ruby-doc.org/stdlib-1.9.3/libdoc/date/rdoc/Date.html\#method-c-parse)
-function.
-
-### Examples
-
-    $ ppl bday jdoe 1970-01-01
-    $ ppl bday adam 1975-06-01
-    $ ppl bday jdoe
-    1970-01-01
-    $ ppl bday
-    adam:  1975-06-01
-    jdoe:  1970-01-01
-
-### See Also
-
-* [Date.parse](http://ruby-doc.org/stdlib-1.9.3/libdoc/date/rdoc/Date.html\#method-c-parse)
-* [color output](/documentation/configuration/color_bday)

data/gh-pages/documentation/commands/completion/index.md

@@ -1,38 +0,0 @@
----
-title: ppl completion Manual Page
-layout: command
-section: documentation
-command: completion
----
-
-### Name
-
-ppl completion - Output a completion function for shell integration
-
-### Synopsis
-
-    ppl completion <shell>
-
-### Description
-
-Output a shell autocomplete function to enable automatic completion of commands
-
-The following shells are supported:
-
-* `bash`
-* `zsh`
-
-### Examples
-
-    $ ppl completion bash
-    _ppl()
-    {
-      ....
-    }
-    complete -F _ppl ppl
-
-### See Also
-
-* [Bash Integration Guide](/documentation/integration/bash)
-* [ZSH Integration Guide](/documentation/integration/zsh)
-

data/gh-pages/documentation/commands/email/index.md

@@ -1,64 +0,0 @@
----
-title: ppl email Manual Page
-layout: command
-section: documentation
-command: email
----
-
-### Name
-
-ppl email - List, show or change email addresses
-
-### Synopsis
-
-    ppl email
-    ppl email <contact>
-    ppl email <contact> <email-address>
-        -d, --delete           delete email address
-        -p, --preferred        mark as preferred
-        -P, --not-preferred    mark as not preferred
-            --format <format>  specify a custom output format
-
-### Description
-
-With no arguments, the email addresses of each contact in the address book are
-listed.
-
-If a `<contact>` is specified, the email addresses of that contact are shown.
-
-If both a `<contact>` and an `<email-address>` are given, then the address is
-added to the email addresses of the contact.
-
-It the `--delete` or `-d` flag is set, then the given `<email-address>` is
-deleted from the specified `<contact>`.
-
-The `--preferred` and `--not-preferred` flags are for marking a given email
-address as "preferred" or not. Internally, this status is represented with
-vCard's `TYPE=pref` parameter in the `EMAIL` field. Preferred email addresses
-are shown with a `*` next to them in the output of `ppl email <contact>`.
-
-### Formatting Options
-
-Using the `--format` option, it is possible to customize the output of `ppl
-email` in several ways. This customizability is similar in usage to a typical
-`printf` function or [`git log`](http://git-scm.com/docs/git-log)'s own
-`--format` option. Here are the placeholders and their values.
-
-    %n   Newline
-    %a   Email address
-    %f   Preferred status ("*" if preferred)
-
-### Examples
-
-    $ ppl email jdoe jdoe@example.org --preferred
-    $ ppl email adam adam@example.com
-    $ ppl email jdoe
-    *  jdoe@example.org
-    $ ppl email
-    adam:  adam@example.com
-    jdoe:  jdoe@example.org
-
-### See Also
-
-* [color output](/documentation/configuration/color_email)
-

data/gh-pages/documentation/commands/grep/index.md

@@ -1,32 +0,0 @@
----
-title: ppl grep Manual Page
-layout: command
-section: documentation
-command: grep
----
-
-### Name
-
-ppl grep - Search the address book
-
-### Synopsis
-
-    ppl grep <options> <search>
-
-### Description
-
-This command is an alias of `git grep`. The `<options>` and the `<search>`
-string given are passed straight on through to `git grep`.
-
-The format and color of the output of this command is subject to your system's
-git configuration, not the contents of your `~/.pplconfig`.
-
-### Examples
-
-    $ ppl grep smith
-    john.vcf:EMAIL:john.smith@example.org
-
-### See Also
-
-* [git grep](http://git-scm.com/docs/git-grep)
-

data/gh-pages/documentation/commands/init/index.md

@@ -1,28 +0,0 @@
----
-title: ppl init Manual Page
-layout: command
-section: documentation
-command: init
----
-
-### Name
-
-ppl init - Create an empty address book
-
-### Synopsis
-
-    ppl init [<directory>]
-
-### Description
-
-This command creates an empty ppl repository. It creates the specified directory
-if it doesn't already exist, and initializes a git repository there.
-
-If no `<directory>` parameter is explicitly specified, then the operation is
-applied to the current working directory.
-
-### Examples
-
-    ppl init ~/contacts
-
-

data/gh-pages/documentation/commands/ls/index.md

@@ -1,55 +0,0 @@
----
-title: ppl ls Manual Page
-layout: command
-section: documentation
-command: ls
----
-
-### Name
-
-ppl ls - List all contacts
-
-### Synopsis
-
-    ppl ls [<options>]
-        --format <format>  specify a custom output format
-        --pretty <preset>  specify a preset output format
-
-### Description
-
-List all the contacts in the address book.
-
-### Formatting Options
-
-Using the `--format` option, `ppl ls` can be customized to produce output in a
-user-specified format. This is similar functionality to `printf` or the
-customizability of other software such as [git
-log](http://git-scm.com/docs/git-log). Here are the placeholders.
-
-    %n   Newline
-    %i   Contact ID
-    %N   Name
-    %a   Age
-    %b   Birthday
-    %k   Nickname      (first)
-    %e   Email address (preferred/first)
-    %p   Phone number  (preferred/first)
-    %o   Organization  (first)
-
-Commonly used output formats can be stored in `~/.pplconfig` and invoked by name
-using the `--pretty` option. For example, the following configuration would
-allow the format to be used by running `ppl ls --pretty age_info`.
-
-    [pretty]
-        age_info = "%i: %a (%b)"
-
-### Examples
-
-    $ ppl ls
-    jdoe: John Doe <jdoe@example.org>
-    kdoe: Kent Doe <kdoe@example.org>
-
-### See Also
-
-* [color output](/documentation/configuration/color_ls)
-

data/gh-pages/documentation/commands/mutt/index.md

@@ -1,36 +0,0 @@
----
-title: ppl mutt Manual Page
-layout: command
-section: documentation
-command: mutt
----
-
-### Name
-
-ppl mutt - Integration with mutt's query_command
-
-### Synopsis
-
-    ppl mutt [<options>] <query>
-        -i, --ignore-case     Turn off case sensitivity
-
-### Description
-
-Searches the names and email addresses in the address book for the given
-`<query>` string and returns a list of results formatted for compatibility with
-[mutt's query_command
-option](http://www.mutt.org/doc/manual/manual-4.html#ss4.5).
-
-This is intended to enable mutt users to integrate ppl as the search backend for
-recipient autocompletion.
-
-If the `-i` flag is given, the search will be case-insensitive, ignoring case
-differences between the query given and the contacts' names and email addresses.
-
-### Examples
-
-Put the following in your `~/.muttrc`:
-
-    set query_command = "ppl mutt '%s'"
-
-

data/gh-pages/documentation/commands/mv/index.md

@@ -1,26 +0,0 @@
----
-title: ppl mv Manual Page
-layout: command
-section: documentation
-command: mv
----
-
-### Name
-
-ppl mv - Move a contact to a different ID
-
-### Synopsis
-
-    ppl mv <source> <destination>
-
-### Description
-
-This changes the ID of a contact. The `<source>` parameter must correspond to
-the ID of an existing contact in the address book. The `<destination>` parameter
-must not already be in use as the ID of an existing contact.
-
-### Examples
-
-    ppl mv john jdoe
-
-

data/gh-pages/documentation/commands/name/index.md

@@ -1,45 +0,0 @@
----
-title: ppl name Manual Page
-layout: command
-section: documentation
-command: name
----
-
-### Name
-
-ppl name - List, show or change names
-
-### Synopsis
-
-    ppl name
-    ppl name <contact>
-    ppl name <contact> <name>
-        -f, --family <family-name(s)>
-        -g, --given  <given-name(s)>
-        -m, --middle <middle-name(s)>
-        -p, --prefix <prefix>
-        -s, --suffix <suffix>
-
-### Description
-
-With no arguments, the full names of each contact in the address book are
-listed.
-
-If a `<contact>` is specified, the full name of that contact is shown.
-
-If both a `<contact>` and a `<name>` are given, then the name is stored as the
-full name of the contact.
-
-### Examples
-
-    $ ppl name jdoe "John Doe"
-    $ ppl name adam "Adam West" --family West -g Adam
-    $ ppl name jdoe
-    John Doe
-    $ ppl name
-    adam:  Adam West
-    jdoe:  John Doe
-
-### See Also
-
-* [color output](/documentation/configuration/color_name)

data/gh-pages/documentation/commands/nick/index.md

@@ -1,44 +0,0 @@
----
-title: ppl nick Manual Page
-layout: command
-section: documentation
-command: nick
----
-
-### Name
-
-ppl nick - List, show or change nicknames
-
-### Synopsis
-
-    ppl nick (--no-color)
-    ppl nick <contact>
-    ppl nick <contact> <nickname>
-    ppl nick <contact> (-d | --delete) <nickname>
-
-### Description
-
-With no arguments, the nicknames of each contact in the address book are listed.
-
-If a `<contact>` is specified, their nicknames are shown. If both a `<contact>`
-and a `<nickname>` are given, then the nickname is added to the contact. If the
-`--delete` or `-d` flag is set, then the given `<nickname>` is
-deleted from the specified `<contact>`.
-
-If the `--no-color` flag is set, then the list of nicknames will be printed
-without any ANSI color escape codes, regardless of any configuration settings.
-
-### Examples
-
-    $ ppl nick jdoe Johnny
-    $ ppl nick fred Freddy
-    $ ppl nick jdoe
-    Johnny
-    $ ppl nick
-    fred:  Freddy
-    jdoe:  Johnny
-
-### See Also
-
-* [color output](/documentation/configuration/color_nick)
-

data/gh-pages/documentation/commands/org/index.md

@@ -1,45 +0,0 @@
----
-title: ppl org Manual Page
-layout: command
-section: documentation
-command: org
----
-
-### Name
-
-ppl org - List, show or change organizations
-
-### Synopsis
-
-    ppl org
-    ppl org <contact>
-    ppl org <contact> <organization>
-    ppl org <contact> (-d | --delete) <organization>
-
-### Description
-
-With no arguments, the organizations of each contact in the address book are
-listed.
-
-If a `<contact>` is specified, the organization of that contact is shown.
-
-If both a `<contact>` and an `<organization>` are given, then the organization
-is added to that contact's organizations.
-
-It the `--delete` or `-d` flag is set, then the given `<organization>` is
-deleted from the specified `<contact>`.
-
-### Examples
-
-    $ ppl org jdoe "Free Software Foundation"
-    $ ppl org adam "Microsoft Corporation"
-    $ ppl org jdoe
-    Free Software Foundation
-    $ ppl org
-    adam:  Microsoft Corporation
-    jdoe:  Free Software Foundation
-
-### See Also
-
-* [color output](/documentation/configuration/color_org)
-

data/gh-pages/documentation/commands/phone/index.md

@@ -1,56 +0,0 @@
----
-title: ppl phone Manual Page
-layout: command
-section: documentation
-command: phone
----
-
-### Name
-
-ppl phone - List, show or change phone numbers
-
-### Synopsis
-
-    ppl phone
-    ppl phone <contact>
-    ppl phone <contact> <phone-number>
-    ppl phone <contact> <phone-number>
-        -d, --delete         delete phone number
-        -t, --type <type>    set the number's type
-        -p, --preferred      mark as preferred
-        -P, --not-preferred  mark as not preferred
-
-### Description
-
-With no arguments, the phone numbers of each contact in the address book are
-listed.
-
-If a `<contact>` is specified, the phone number of that contact is shown.
-
-If both a `<contact>` and a `<phone-number>` are given, then the number is added
-to the contact's phone numbers.
-
-It the `--delete` or `-d` flag is set, then the given `<phone-number>` is
-deleted from the specified `<contact>`.
-
-Use the `--type <type>` option to assign a type to the phone number. You can use
-this option both when adding a new number or to amend an existing number.
-
-The `--preferred` and `--not-preferred` flags are for marking a given phone
-number as "preferred" or not. Internally, this status is represented with
-vCard's `TYPE=pref` parameter in the `TEL` field. Preferred phone numbers are
-shown with a `*` next to them in the output of `ppl phone <contact>`.
-
-### Examples
-
-    $ ppl phone jdoe 0123456789 --type cell
-    $ ppl phone adam 0777111222
-    $ ppl phone jdoe
-    0123456789 (cell)
-    $ ppl phone
-    adam:  0777111222
-    jdoe:  0123456789
-
-### See Also
-
-* [color output](/documentation/configuration/color_phone)

data/gh-pages/documentation/commands/post/index.md

@@ -1,61 +0,0 @@
----
-title: ppl post Manual Page
-layout: command
-section: documentation
-command: post
----
-
-### Name
-
-ppl post - List, show or change postal addresses
-
-### Synopsis
-
-    ppl post
-    ppl post <contact>
-    ppl post <contact> <address>
-        -s, --street <street-address>
-        -z, --postal-code <postal-code>
-        -p, --po-box <po-box>
-        -l, --locality <locality>
-        -r, --region <region>
-        -c, --country <country>
-    ppl post <contact> <address> (-m | --move) <new-name>
-
-### Description
-
-With no arguments, the postal addresses of each contact in the address book are
-listed.
-
-If a just a `<contact>` is specified, the postal addresses of that contact are
-shown.
-
-If both a `<contact>` and an `<address>` are specified, an address will be
-created or updated using the options provided.
-
-Use the `-m` or `--move` flag to move an address to a new ID.
-
-### Examples
-
-    $ ppl post
-    alice:  home, work
-    jdoe:   home
-    $ ppl post alice
-    *  home  3701 Southwest 12th Street, Topeka, Kansas, USA
-       work  123 Business Road, Businesstown, USA
-    $ ppl post alice home
-    3701 Southwest 12th Street
-    Topeka
-    Kansas
-    USA
-    $ ppl post alice home --country Canada
-    $ ppl post alice home
-    3701 Southwest 12th Street
-    Topeka
-    Kansas
-    Canada
-
-### See Also
-
-* [color output](/documentation/configuration/color_post)
-

data/gh-pages/documentation/commands/pull/index.md

@@ -1,39 +0,0 @@
----
-title: ppl pull Manual Page
-layout: command
-section: documentation
-command: pull
----
-
-### Name
-
-ppl pull - Execute `git pull` in the address book directory
-
-### Synopsis
-
-    ppl pull <remote> <branch>
-
-### Description
-
-This command is an alias of `git pull`. It is intended to make it more
-convenient to use git to synchronise your address book. The rationale is that it
-is tiresome to have to type `cd ~/contacts` and then `git pull origin master`.
-Assuming you have configured ppl to [remember the location of your address
-book](/documentation/configuration/address_book), then `ppl pull origin master`
-is the equivalent of those two commands.
-
-Note that this command literally executes the git command `push` in the address
-book directory. If you don't have the git CLI tool installed, this command will
-not work.
-
-### Examples
-
-    $ ppl pull origin master
-    Already up-to-date.
-
-### See Also
-
-* [git pull](http://git-scm.com/docs/git-pull)
-* [ppl push](/documentation/commands/push)
-* [ppl remote](/documentation/commands/push)
-

data/gh-pages/documentation/commands/push/index.md

@@ -1,36 +0,0 @@
----
-title: ppl push Manual Page
-layout: command
-section: documentation
-command: push
----
-
-### Name
-
-ppl push - Execute `git push` in the address book directory
-
-### Synopsis
-
-    ppl push <remote> <branch>
-
-### Description
-
-This command is an alias of `git push`. It is intended to make it more
-convenient to use git to synchronise your address book. See the documentation
-for [git pull](/documentation/commands/pull) for more details.
-
-Note that this command literally executes the git command `push` in the address
-book directory. If you don't have the git CLI tool installed, this command will
-not work.
-
-### Examples
-
-    $ ppl push origin master
-    Everything up-to-date.
-
-### See Also
-
-* [git push](http://git-scm.com/docs/git-push)
-* [ppl pull](/documentation/commands/pull)
-* [ppl remote](/documentation/commands/push)
-