Changes To ShellPAK

Changes to "ShellPAK" between 2014-06-23 16:01:41 and 2014-07-31 04:43:47

     1         -# PRIVATE REPOSITORY
            1  +<div id="table-of-contents">
            2  +<h2>Table of Contents</h2>
            3  +<div id="text-table-of-contents">
            4  +<ul>
            5  +<li><a href="#sec-1">1. Overview</a></li>
            6  +<li><a href="#sec-2">2. Description</a>
            7  +<ul>
            8  +<li><a href="#sec-2-1">2.1. Requirements</a></li>
            9  +<li><a href="#sec-2-2">2.2. Supported Platforms</a></li>
           10  +</ul>
           11  +</li>
           12  +<li><a href="#sec-3">3. Obtaining ShellPAK</a></li>
           13  +<li><a href="#sec-4">4. Installation</a></li>
           14  +</ul>
           15  +</div>
           16  +</div>
           17  +
           18  +
           19  +# Overview<a id="sec-1" name="sec-1"></a>
           20  +
           21  +Provides a general overview of ShellPAK as well as instructions for
           22  +installing and removing ShellPAK.
           23  +
           24  +# Description<a id="sec-2" name="sec-2"></a>
           25  +
           26  +ShellPAK allows for the automatic installation and configuration of
           27  +my personal [GNU Bash](http://www.gnu.org/software/bash/) shell environment as well as the configuration
           28  +of the following programs:
           29  +
           30  +-   [Git](http://git-scm.com)
           31  +-   [GNU Emacs](http://www.gnu.org/software/emacs/)
           32  +-   [GNU Screen](http://www.gnu.org/software/screen/)
           33  +-   [GNU Indent](https://www.gnu.org/software/indent/)
           34  +-   [Perl::Tidy](http://search.cpan.org/~shancock/Perl-Tidy-20140711/lib/Perl/Tidy.pod)
           35  +-   [tmux](http://tmux.sourceforge.net)
           36  +
           37  +## Requirements<a id="sec-2-1" name="sec-2-1"></a>
           38  +
           39  +-   GNU Bash version 3.2 or greater
           40  +-   rsync
           41  +
           42  +## Supported Platforms<a id="sec-2-2" name="sec-2-2"></a>
           43  +
           44  +The following operating systems are known to be supported:
           45  +
           46  +-   Mac OS X 10.9 (Darwin)
           47  +-   NetBSD 6.1.x
           48  +-   OpenBSD 5.4
           49  +-   CentOS 6.5
           50  +-   Debian 7 (Wheezy) and derivatives
           51  +-   SunOS solaris 5.10
           52  +-   AIX 1 7
           53  +
           54  +In addition, ShellPAK has been known to run on OpenSuSE, SuSE
           55  +Enterprise Linux, Ubuntu, FreeBSD, and Cygwin.
           56  +
           57  +# Obtaining ShellPAK<a id="sec-3" name="sec-3"></a>
           58  +
           59  +As of <span class="timestamp-wrapper"><span class="timestamp">&lt;2014-07-30 Wed&gt;</span></span>, ShellPAK is managed by the [Fossil](http://fossil-scm.org)
           60  +distributed version control system.  To check out a repository:
           61  +
           62  +    # Clone the repository
           63  +    $ fossil clone https://www.fuhrwerks.com/fossil/shellpak ~/shellpak.fossil
           64  +    
           65  +    # Check out the repository
           66  +    $ mkdir shellpak
           67  +    $ cd shellpak
           68  +    $ fossil open ~/shellpak.fossil
           69  +
           70  +# Installation<a id="sec-4" name="sec-4"></a>
           71  +
           72  +Assuming you have a version of Shellpak checked out already:
     2     73   
     3         -This repository is for private use *only*!  Only persons given *explicit written permission* may access this repository.
           74  +    # Install ShellPAK
           75  +    $ ./setup.sh
           76  +    
           77  +    # Perform a dry-run
           78  +    $ ./setup.sh -r
           79  +    
           80  +    # Install into another directory
           81  +    $ ./setup.sh -d /path/to/directory
           82  +    
           83  +    # Do not automatically link files during installation
           84  +    $ ./setup.sh -n
           85  +    
           86  +    # Remove ShellPAK
           87  +    $ ./setup.sh -u
           88  +    
           89  +    # Change backup directory
           90  +    $ ./setup.sh -b /path/to/directory
           91  +    
           92  +    # List runtime options
           93  +    $ ./setup.sh -h
     4     94   
     5         -Thank you
           95  +Note that during installation, ShellPAK will store dot-files (e.g.,
           96  +`bashrc`, `bash_profile`, etc) in `~/Backup/shell` (or whatever is
           97  +specified by the `-b` flag).  These files will be restored during
           98  +un-installation.