ppl 4.0.3 → 4.0.5

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

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

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

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

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

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

@@ -1,33 +0,0 @@
----
-title: ppl show Manual Page
-layout: command
-section: documentation
-command: show
----
-
-### Name
-
-ppl show - Display a contact's full details
-
-### Synopsis
-
-    ppl show <contact>
-
-### Description
-
-Display the full details of the specified `<contact>`. This command will output
-all the contact details that are currently stored, including email address, date
-of birth, organization, and so on.
-
-### Examples
-
-    $ ppl show jdoe
-    jdoe: John Doe <jdoe@example.org>
-
-        Birthday  1970-01-01
-
-    Phone Numbers:
-      0123456789
-      0543216790
-
-

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

@@ -1,44 +0,0 @@
----
-title: ppl url Manual Page
-layout: command
-section: documentation
-command: url
----
-
-### Name
-
-ppl url - List, show or change URLs
-
-### Synopsis
-
-    ppl url
-    ppl url <contact>
-    ppl url <contact> <url>
-    ppl url <contact> (-d | --delete) <url>
-
-### Description
-
-With no arguments, the URLs of each contact in the address book are listed.
-
-If a `<contact>` is specified, the URLs of that contact are shown.
-
-If both a `<contact>` and a `<URL>` are given, then the URL is added to the
-contact.
-
-If the `--delete` or `-d` flag is set, then the given `<url>` is
-deleted from the specified `<contact>`.
-
-### Examples
-
-    $ ppl url jdoe http://facebook.com/jdoe
-    $ ppl url adam http://adamswebsite.com
-    $ ppl url jdoe
-    http://facebook.com/jdoe
-    $ ppl url
-    adam:  http://adamswebsite.com
-    jdoe:  http://facebook.com/jdoe
-
-### See Also
-
-* [color output](/documentation/configuration/color_url)
-

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

@@ -1,27 +0,0 @@
----
-title: ppl version Manual Page
-layout: command
-section: documentation
-command: version
----
-
-### Name
-
-ppl version - Display ppl's version number
-
-### Synopsis
-
-    ppl version
-
-### Description
-
-This command simply displays the current version of ppl installed on the system.
-
-Pre-1.9.0 versions of ppl lack this command, but `gem list --local | grep ppl`
-ought to do the job just fine in its absence anyway.
-
-### Examples
-
-    $ ppl version
-    ppl version 1.9.0
-

data/gh-pages/documentation/configuration/address_book/index.md

@@ -1,22 +0,0 @@
----
-title: ppl [address book] Configuration Guide
-layout: configuration
-section: documentation
-config_section: address book
----
-
-### path
-
-    [address book]
-        path = ~/contacts
-
-By default, ppl determines the location of the address book based on the user's
-[working directory](http://en.wikipedia.org/wiki/Working_directory). This value
-overrides that behaviour and sets a particular directory as the location of the
-address book regardless of the working directory.
-
-This is intended for the typical use-case where a user of ppl only has one
-address book. The purpose is to increase the convenience of using ppl with that
-single address book by removing the requirement that the user first navigate to
-its directory before reading from or writing to it.
-

data/gh-pages/documentation/configuration/alias/index.md

@@ -1,45 +0,0 @@
----
-title: ppl [alias] Configuration Guide
-layout: configuration
-section: documentation
-config_section: alias
----
-
-Sometimes typing the same long commands repeatedly becomes tiresome. The
-`[alias]` section is intended to address this issue by providing a means of
-configuring shorter forms of commands.
-
-    [alias]
-        l = ls
-        s = show
-
-Adding the above lines to `~/.pplconfig` would allow the user to interact with
-ppl as follows:
-
-    $ ppl l
-    jdoe: John Doe    <jdoe@example.org>
-    fred: Fred Bloggs <fred@example.org>
-    $ ppl s jdoe
-    John Doe <jdoe@example.org>
-
-      Birthday      1970-01-01
-      Organization  Example Organization
-
-    Email Addresses
-      jdoe@example.org
-
-### Bang Aliases
-
-ppl's alias system is similar to git's in that it supports executing external
-commands via aliases prefixed with an exclamation mark, or "bang". In your
-`~/.pplconfig`, this would look something like the following:
-
-    [alias]
-        lsx = !ppl ls | grep -i x
-
-The above example creates an alias `lsx` that pipes the output of [ppl
-ls](/documentation/commands/ls) through `grep -i x`. This means that you
-effectively create a new command - `ppl lsx` - which is identical to `ppl ls`
-except that it only displays lines containing the letter x.
-
-

data/gh-pages/documentation/configuration/color/index.md

@@ -1,47 +0,0 @@
----
-title: ppl [color] Configuration Guide
-layout: configuration
-section: documentation
-config_section: color
----
-
-By default, ppl's commands output plain text with no [ANSI color escape
-codes](http://en.wikipedia.org/wiki/ANSI_escape_code). This is good in terms of
-ppl being a well-behaved, pipeable UNIX CLI program, but some people like a bit
-more color in their life, and this section of the config file allows those
-people to selectively enable color output on a per-command basis.
-
-### Enable color for all commands that support it
-
-    [color]
-            age   = true
-            bday  = true
-            email = true
-            ls    = true
-            name  = true
-            nick  = true
-            org   = true
-            phone = true
-            post  = true
-            show  = true
-            url   = true
-
-### List of supported colors
-
-* black
-* blue
-* cyan
-* green
-* magenta
-* red
-* white
-* yellow
-
-### Unsupported commands
-
-The [mutt](/documentation/commands/mutt) command doesn't support color output
-and never will. It'd be completely pointless.
-
-The [show](/documentation/commands/show) command doesn't, either, but this is
-due to be added sometime soon.
-

data/gh-pages/documentation/configuration/color_age/index.md

@@ -1,20 +0,0 @@
----
-title: ppl [color "age"] Configuration Guide
-layout: configuration
-section: documentation
-config_section: color "age"
----
-
-This section dictates the color of the output of the
-[age](/documentation/commands/age) command.
-
-### Example
-
-    [color "age"]
-        id  = green
-        age = blue
-
-### See Also
-
-* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
-

data/gh-pages/documentation/configuration/color_bday/index.md

@@ -1,20 +0,0 @@
----
-title: ppl [color "bday"] Configuration Guide
-layout: configuration
-section: documentation
-config_section: color "bday"
----
-
-This section dictates the color of the output of the
-[bday](/documentation/commands/bday) command.
-
-### Example
-
-    [color "bday"]
-        id       = green
-        birthday = blue
-
-### See Also
-
-* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
-

data/gh-pages/documentation/configuration/color_email/index.md

@@ -1,21 +0,0 @@
----
-title: ppl [color "email"] Configuration Guide
-layout: configuration
-section: documentation
-config_section: color "email"
----
-
-This section dictates the color of the output of the
-[email](/documentation/commands/email) command.
-
-### Example
-
-    [color "email"]
-        star            = red
-        id              = green
-        email_addresses = blue
-
-### See Also
-
-* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
-

data/gh-pages/documentation/configuration/color_ls/index.md

@@ -1,21 +0,0 @@
----
-title: ppl [color "ls"] Configuration Guide
-layout: configuration
-section: documentation
-config_section: color "ls"
----
-
-This section dictates the color of the output of the
-[ls](/documentation/commands/ls) command.
-
-### Example
-
-    [color "ls"]
-        id    = green
-        name  = yellow
-        email = blue
-
-### See Also
-
-* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
-

data/gh-pages/documentation/configuration/color_name/index.md

@@ -1,20 +0,0 @@
----
-title: ppl [color "name"] Configuration Guide
-layout: configuration
-section: documentation
-config_section: color "name"
----
-
-This section dictates the color of the output of the
-[name](/documentation/commands/name) command.
-
-### Example
-
-    [color "name"]
-        id   = green
-        name = blue
-
-### See Also
-
-* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
-

data/gh-pages/documentation/configuration/color_nick/index.md

@@ -1,20 +0,0 @@
----
-title: ppl [color "nick"] Configuration Guide
-layout: configuration
-section: documentation
-config_section: color "nick"
----
-
-This section dictates the color of the output of the
-[nick](/documentation/commands/nick) command.
-
-### Example
-
-    [color "nick"]
-        id        = green
-        nicknames = blue
-
-### See Also
-
-* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
-

data/gh-pages/documentation/configuration/color_org/index.md

@@ -1,20 +0,0 @@
----
-title: ppl [color "org"] Configuration Guide
-layout: configuration
-section: documentation
-config_section: color "org"
----
-
-This section dictates the color of the output of the
-[org](/documentation/commands/org) command.
-
-### Example
-
-    [color "org"]
-        id            = green
-        organizations = blue
-
-### See Also
-
-* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
-

data/gh-pages/documentation/configuration/color_phone/index.md

@@ -1,22 +0,0 @@
----
-title: ppl [color "phone"] Configuration Guide
-layout: configuration
-section: documentation
-config_section: color "phone"
----
-
-This section dictates the color of the output of the
-[phone](/documentation/commands/phone) command.
-
-### Example
-
-    [color "phone"]
-        star          = red
-        id            = green
-        phone_numbers = blue
-        type          = red
-
-### See Also
-
-* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
-

data/gh-pages/documentation/configuration/color_post/index.md

@@ -1,20 +0,0 @@
----
-title: ppl [color "post"] Configuration Guide
-layout: configuration
-section: documentation
-config_section: color "post"
----
-
-This section dictates the color of the output of the
-[post](/documentation/commands/post) command.
-
-### Example
-
-    [color "post"]
-        id             = green
-        postal_address = blue
-
-### See Also
-
-* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
-

data/gh-pages/documentation/configuration/color_url/index.md

@@ -1,20 +0,0 @@
----
-title: ppl [color "url"] Configuration Guide
-layout: configuration
-section: documentation
-config_section: color "url"
----
-
-This section dictates the color of the output of the
-[url](/documentation/commands/url) command.
-
-### Example
-
-    [color "url"]
-        id   = green
-        urls = blue
-
-### See Also
-
-* [List of supported colors](/documentation/configuration/color#list_of_supported_colors)
-

data/gh-pages/documentation/configuration/index.html

@@ -1,8 +0,0 @@
----
-title: Configuration
-layout: page
-section: documentation
----
-
-<p>configuration</p>
-