ppl 3.0.0 → 4.0.3

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

@@ -0,0 +1,45 @@
+---
+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

@@ -0,0 +1,44 @@
+---
+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

@@ -0,0 +1,45 @@
+---
+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

@@ -0,0 +1,56 @@
+---
+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

@@ -0,0 +1,61 @@
+---
+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

@@ -0,0 +1,39 @@
+---
+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

@@ -0,0 +1,36 @@
+---
+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)
+

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

@@ -0,0 +1,40 @@
+---
+title: ppl remote Manual Page
+layout: command
+section: documentation
+command: remote
+---
+
+### Name
+
+ppl remote - Execute `git remote` in the address book directory
+
+### Synopsis
+
+    ppl remote [-v | --verbose]
+    ppl remote rename <old> <new>
+    ppl remote rm <name>
+
+### Description
+
+This command is an alias of `git remote`. 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 `remote` in the
+address book directory. If you don't have the git CLI tool installed, this
+command will not work.
+
+### Examples
+
+    $ ppl remote
+    origin
+    github
+    $ ppl remote rm github
+
+### See Also
+
+* [git remote](http://git-scm.com/docs/git-remote)
+* [ppl pull](/documentation/commands/pull)
+* [ppl push](/documentation/commands/push)
+

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

@@ -0,0 +1,23 @@
+---
+title: ppl rm Manual Page
+layout: command
+section: documentation
+command: rm
+---
+
+### Name
+
+ppl rm - Delete a contact
+
+### Synopsis
+
+    ppl rm <contact>
+
+### Description
+
+Delete the specified `<contact>` from the address book.
+
+### Examples
+
+    ppl rm jdoe
+

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

@@ -0,0 +1,38 @@
+---
+title: ppl scrape Manual Page
+layout: command
+section: documentation
+command: scrape
+---
+
+### Name
+
+ppl scrape - Scrape contact details from an email in `stdin`
+
+### Synopsis
+
+    ppl scrape [<options>]
+        -q, --quiet        Add contacts to the address book without prompting
+        -s, --sender       Scrape the sender's contact details
+
+### Description
+
+Reads an email message from stdin and scrapes contact information from it into
+the address book. By default nothing will be scraped; the command must be told
+explicitly which information to scrape via its arguments.
+
+If the `--sender` option is used, then the details of the person in the email's
+`From:` header will be scraped into the address book.
+
+If the `--quiet` option is used, the command will not prompt the user to confirm
+whether they approve of each contact before saving them to the address book.
+
+This command is analogous to [abook](http://abook.sourceforge.net/)'s
+`--add-email` functionality. Both the confirmation prompt and the `--quiet` flag
+are provided with the intention of achieving feature parity with this part of
+abook.
+
+### Examples
+
+    ppl scrape --sender --quiet < ~/Mail/cur/1234.example.org
+

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

@@ -0,0 +1,39 @@
+---
+title: ppl shell Manual Page
+layout: command
+section: documentation
+command: shell
+---
+
+### Name
+
+ppl shell - Interactive mode
+
+### Synopsis
+
+    ppl shell
+
+### Description
+
+Opens ppl in interactive mode, allowing users to skip typing "ppl" at the start
+of every single command. This is intended to be useful in the case of longer
+sessions, when a user plans to interact with ppl many times and wants to avoid
+some of the repetition.
+
+In interactive mode, all the ppl commands work as normal. The only difference is
+that there is no need to prefix every command with `ppl`. So instead of typing
+`ppl ls`, in interactive mode you would just type `ls`.
+
+To exit interactive mode, type `exit`, or send a `sigint` or `eof` (Ctrl+C or
+Ctrl+D usually).
+
+### Examples
+
+    $ ppl shell
+    ppl 1.5.2 (type "exit" to leave)
+    ppl> ls
+    jdoe: John Doe <jdoe@example.org>
+    kdoe: Kent Doe <kdoe@example.org>
+    ppl> exit
+    $
+