ppl 3.0.0 → 4.0.3

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

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

data/gh-pages/documentation/index.html

@@ -0,0 +1,183 @@
+---
+title: Documentation
+layout: page
+section: documentation
+---
+
+<h2>Documentation</h2>
+
+<div class="row">
+
+  <div class="span4">
+    <h3>Quick Start</h3>
+    <div class="well well-large">
+      <p>
+        Trying ppl for the first time?
+        <br />
+        Want to learn the basics?
+        <br />
+        In 30 seconds or less?
+      </p>
+
+      <p>
+        <a class="btn btn-primary" href="{{site.url}}/documentation/quick-start">
+          Get Started
+        </a>
+      </p>
+
+    </div>
+  </div>
+
+  <div class="span8">
+    <h3>Command Reference</h3>
+
+    <div class="row">
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/commands/age">age</a></li>
+          <li><a href="{{site.url}}/documentation/commands/add">add</a></li>
+          <li><a href="{{site.url}}/documentation/commands/bday">bday</a></li>
+          <li><a href="{{site.url}}/documentation/commands/completion">completion</a></li>
+          <li><a href="{{site.url}}/documentation/commands/email">email</a></li>
+          <li><a href="{{site.url}}/documentation/commands/grep">grep</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/commands/init">init</a></li>
+          <li><a href="{{site.url}}/documentation/commands/ls">ls</a></li>
+          <li><a href="{{site.url}}/documentation/commands/mutt">mutt</a></li>
+          <li><a href="{{site.url}}/documentation/commands/mv">mv</a></li>
+          <li><a href="{{site.url}}/documentation/commands/name">name</a></li>
+          <li><a href="{{site.url}}/documentation/commands/nick">nick</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/commands/org">org</a></li>
+          <li><a href="{{site.url}}/documentation/commands/phone">phone</a></li>
+          <li><a href="{{site.url}}/documentation/commands/post">post</a></li>
+          <li><a href="{{site.url}}/documentation/commands/pull">pull</a></li>
+          <li><a href="{{site.url}}/documentation/commands/push">push</a></li>
+          <li><a href="{{site.url}}/documentation/commands/remote">remote</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/commands/rm">rm</a></li>
+          <li><a href="{{site.url}}/documentation/commands/scrape">scrape</a></li>
+          <li><a href="{{site.url}}/documentation/commands/shell">shell</a></li>
+          <li><a href="{{site.url}}/documentation/commands/show">show</a></li>
+          <li><a href="{{site.url}}/documentation/commands/url">url</a></li>
+          <li><a href="{{site.url}}/documentation/commands/version">version</a></li>
+        </ul>
+      </div>
+
+    </div>
+
+  </div>
+
+</div>
+
+
+<div class="row">
+
+  <div class="span4">
+    <h3>Tips &amp; Tricks</h3>
+    <p>
+      Small bits of advice for getting the most out of ppl.
+      <br />
+      <a href="{{site.url}}/documentation/tips">Sound interesting?</a>
+    </p>
+  </div>
+
+  <div class="span8">
+    <h3>Integration Guide</h3>
+    <div class="row">
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/integration/bash">Bash</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/integration/google">Google</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/integration/mutt">Mutt</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/integration/zsh">ZSH</a></li>
+        </ul>
+      </div>
+
+    </div>
+  </div>
+
+</div>
+
+<div class="row">
+
+  <div class="span4">
+    <h3>About ppl</h3>
+    <p>
+      Wondering why ppl even exists? Whose idea it was?
+      <br />
+      <a href="{{site.url}}/documentation/about">Look no further</a>
+    </p>
+  </div>
+
+  <div class="span8">
+    <h3>Configuration Guide</h3>
+    <div class="row">
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/configuration/address_book">[address&nbsp;book]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/alias">[alias]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color">[color]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_age">[color "age"]</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/configuration/color_bday">[color "bday"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_email">[color "email"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_ls">[color "ls"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_name">[color "name"]</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/configuration/color_nick">[color "nick"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_org">[color "org"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_phone">[color&nbsp;"phone"]</a></li>
+          <li><a href="{{site.url}}/documentation/configuration/color_post">[color "post"]</a></li>
+        </ul>
+      </div>
+
+      <div class="span2">
+        <ul class="nav nav-pills nav-stacked">
+          <li><a href="{{site.url}}/documentation/configuration/color_url">[color "url"]</a></li>
+        </ul>
+      </div>
+
+    </div>
+  </div>
+
+</div>
+

data/gh-pages/documentation/integration/bash/index.md

@@ -0,0 +1,23 @@
+---
+title: Bash Integration Guide
+layout: integration
+section: documentation
+integration: bash
+---
+
+If you've ever used a command-line program like Git, you've probably used tab
+completion before. For example, you type `git chec`, press the `<Tab>` key, and
+bash automatically completes the rest of the command for you: `git checkout`.
+Bash accomplishes this through the use of a [completion
+function](http://tldp.org/LDP/abs/html/tabexpansion.html), and the good news is
+that there's one available for ppl.
+
+### Install the completion function globally
+
+    $ ppl completion bash | sudo tee /etc/bash_completion.d/ppl
+
+The [completion](/documentation/commands/completion) command simply outputs the
+completion function code in its entirety. The above line pipes that code into
+its rightful place in your system's Bash completion function config directory.
+
+

data/gh-pages/documentation/integration/google/index.md

@@ -0,0 +1,26 @@
+---
+title: Google Integration Guide
+layout: integration
+section: documentation
+integration: google
+---
+
+Many people have a large set of address book data stored in Google Contacts,
+usually under the hood of GMail itself. If you fall in this category, and you
+want to copy over that data as a starting point for your ppl address book, you
+have a few options thanks to the enterprising work of some generous ppl users.
+
+### gv-contacts
+
+Part of an npm package called [gv](https://github.com/matthewp/gv-app/), the `gv
+contacts` command is a way of importing contacts directly from your Google
+account into ppl. It imports contacts' names, phone numbers and email addresses. 
+
+### goog2ppl
+
+[goog2ppl](https://github.com/shushcat/goog2ppl) is a python script for
+converting a contacts.vcf file [exported from
+Google](http://support.google.com/mail/answer/24911?hl=en) and breaking it up
+into pieces suitable for initialization as the contents of a ppl address book
+directory.
+

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

@@ -0,0 +1,8 @@
+---
+title: Integration
+layout: page
+section: documentation
+---
+
+<h2>Integration</h3>
+

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

@@ -0,0 +1,35 @@
+---
+title: Mutt Integration Guide
+layout: integration
+section: documentation
+integration: mutt
+---
+
+The [Mutt E-Mail Client](http://www.mutt.org/)
+
+### Email Address Autocompletion
+
+Mutt supports the use of external address book programs as a source of [email
+address autocompletion
+suggestions](http://www.mutt.org/doc/manual/manual-4.html#ss4.5).  You can use
+this to integrate ppl into mutt by adding the following to your `~/.muttrc`:
+
+    set query_command = "ppl mutt '%s'"
+
+With that configured, you can then invoke ppl from within mutt as a means of
+quickly finding email addresses by pressing `Q` in the index menu, or by
+pressing `^T` in any prompt for address entry.
+
+### Quickly Adding New Contacts
+
+If you have a lot of email to deal with, you may find it tedious to have to add
+each new email contact to your address book manually. With a macro like the
+following in your `~/.muttrc`, adding the sender of the currently selected email
+is as simple as pressing the `a` key.
+
+    macro index,pager a "<pipe-message>ppl scrape --sender<return>"
+
+This macro uses the [scrape](/documentation/commands/scrape) command to pull out
+the sender's email address and name (if available), and adds them to the address
+book.
+

data/gh-pages/documentation/integration/zsh/index.md

@@ -0,0 +1,19 @@
+---
+title: ZSH Integration Guide
+layout: integration
+section: documentation
+integration: zsh
+---
+
+Similarly to the [Bash completion](/documentation/integration/bash/)
+functionality also available, ppl comes ready with a ZSH completion function as
+well. Here's how to get it set up:
+
+### Install the completion function
+
+    $ ppl completion zsh | sudo tee /usr/share/zsh/site-functions/_ppl
+
+Depending on your choice of operating system, the target directory in the above
+code may differ. The above is certainly correct for Arch Linux, but on Debian,
+for example, the target would be `/usr/local/share/zsh/site-functions/`.
+

data/gh-pages/documentation/quick-start/index.html

@@ -0,0 +1,88 @@
+---
+title: ppl Quick Start
+layout: page
+section: documentation
+---
+
+<h2>Quick Start</h2>
+
+<div class="row">
+  <div class="span8">
+    <h3>Requirements</h3>
+    <p>
+      ppl depends on <a href="http://rubygems.org/">rubygems</a> for
+      installation, and on <a href="http://git-scm.com/">git</a> for storage and
+      syncing.
+    </p>
+  </div>
+</div>
+
+<div class="row">
+  <div class="span8">
+    <h3>Installation</h3>
+    <pre><code>$ sudo gem install ppl</code></pre>
+  </div>
+</div>
+
+<div class="row">
+  <div class="span8">
+    <h3>Create An Address Book</h3>
+    <pre><code>$ ppl init ~/contacts</code></pre>
+  </div>
+  <div class="span4">
+    <h3>&nbsp;</h3>
+    <p>
+      <a href="{{site.url}}/documentation/commands/init">ppl init</a> is just
+      like creating a Git repo
+    </p>
+  </div>
+</div>
+
+<div class="row">
+  <div class="span8">
+    <h3>Add Some Contacts</h3>
+    <pre><code>$ cd ~/contacts
+$ ppl add alice "Alice Adams"
+$ ppl add bob "Bob Brown"
+$ ppl add eve "Eve Edwards"</code></pre>
+  </div>
+  <div class="span4">
+    <h3>&nbsp;</h3>
+    <p>
+      <a href="{{site.url}}/documentation/commands/add">ppl add</a> creates new
+      contacts in the address book
+    </p>
+  </div>
+</div>
+
+<div class="row">
+  <div class="span8">
+    <h3>Store Some Contact Details</h3>
+    <pre><code>$ ppl email alice alice@example.org
+$ ppl phone bob 0123456789
+$ ppl org eve "Red Hat"</code></pre>
+  </div>
+  <div class="span4">
+    <h3>&nbsp;</h3>
+    <p>
+      ppl has many commands for adding new properties to contacts. Further
+      information is available in the <a href="{{site.url}}/documentation">documentation</a>
+    </p>
+  </div>
+</div>
+
+<div class="row">
+  <div class="span8">
+    <h3>Set Your Default Address Book</h3>
+    <pre><code>$ echo "[address book]" > ~/.pplconfig
+$ echo path = "`pwd`" >> ~/.pplconfig</code></pre>
+  </div>
+  <div class="span4">
+    <h3>&nbsp;</h3>
+    <p>
+      This tells ppl to let you keep working with this address book even after
+      you <code>cd</code> into another directory
+    </p>
+  </div>
+</div>
+

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

@@ -0,0 +1,9 @@
+---
+title: "Tips & Tricks"
+section: documentation
+---
+
+{% assign page = site.categories.tips.first %}
+{% assign content = site.categories.tips.first.content %}
+{% include tip.html %}
+

data/gh-pages/index.html

@@ -0,0 +1,108 @@
+---
+title: ppl - The Command Line Address Book
+layout: frontpage
+---
+
+
+<div class="front-page">
+
+  <div class="row welcome">
+
+    <div class="span4">
+
+      <h1 class="big-welcome">
+        ppl
+      </h1>
+
+      <p class="little-welcome">
+        The command line address book
+      </p>
+      <p class="little-welcome">
+        <a href="{{site.url}}/documentation/quick-start">
+          Try it!
+        </a>
+      </p>
+
+    </div>
+
+    <div class="span8">
+      <pre class="welcome-example"><code><span class="bash-prompt">$</span> ppl add henry "Henry Smith"
+<span class="bash-prompt">$</span> ppl phone henry 012345678
+<span class="bash-prompt">$</span> ppl email henry henry@henrysmith.org
+<span class="bash-prompt">$</span> ppl show henry
+Henry Smith &lt;henry@henrysmith.org&gt;
+
+Email Addresses:
+  henry@henrysmith.org
+
+Phone Numbers:
+  0123456789
+</code></pre>
+    </div>
+
+  </div>
+
+  <div class="row what">
+
+    <div class="span4">
+      <h2>Free</h2>
+      <p>
+        ppl is free software made out of other free software. It's built on top
+        of Ruby and Git, and the completely free vcard address book format.
+      </p>
+    </div>
+
+    <div class="span4">
+      <h2>Decentralized</h2>
+      <p>
+        ppl is built on top of Git, the world's most popular decentralized
+        version control system. Use your address book wherever you like and let
+        Git worry about making sense of it all.
+      </p>
+    </div>
+
+    <div class="span4">
+      <h2>Good</h2>
+      <p>
+        ppl does its best to be a proper UNIX-style comand line program. Proper
+        exit codes, no superfluous output, that sort of thing.
+      </p>
+    </div>
+
+  </div>
+
+  <div class="row latest">
+
+    <div class="span4">
+      <h3>Latest Version</h3>
+      <div class="well">
+        <h2>
+          {{site.categories.changelog.first.title}}
+          <small>
+            ({{ site.categories.changelog.first.date | date: '%Y-%m-%d' }})
+          </small>
+        </h2>
+        <p>
+          <a href="{{site.url}}{{site.categories.changelog.first.permalink}}">
+            {{site.categories.changelog.first.summary}}
+          </a>
+        </p>
+      </div>
+    </div>
+
+    <div class="span8">
+      <h3>
+        {{site.categories.news.first.title}}
+        <small>
+          <a href="{{site.url}}{{site.categories.news.first.url}}">
+            {{site.categories.news.first.date | date: '%Y-%m-%d'}}
+          </a>
+        </small>
+      </h3>
+      {{site.categories.news.first.content}}
+    </div>
+
+  </div>
+
+</div>
+