Go to file
Adam Spiers fe5b658803 default-ignore-list: ignore top-level README.*, LICENSE.*, and COPYING
These files are by definition specific to a given package,
so if they exist in the top-level directory, they should
not be stowed.
2013-04-12 17:42:14 +01:00
automake Reorganise more files into subdirectories and add CPAN support via Module::Build 2011-11-26 15:10:26 +00:00
bin Fix RT ticket #75349 2012-07-09 01:05:27 +01:00
doc Fix typo in manual. 2012-02-19 01:42:10 +00:00
lib Only include $! in error messages for failed syscalls. 2012-07-09 01:06:13 +01:00
t Remove accidentally duplicated code. 2012-02-19 19:16:00 +00:00
.gitignore Ignore tmp-testing-trees anywhere. 2012-02-18 17:14:50 +00:00
aclocal.m4 Ditch deprecated AM_MAINTAINER_MODE. 2011-12-06 16:26:29 +00:00
AUTHORS Add a missing space. 2011-12-03 17:09:48 +00:00
Build.PL Fix some incorrect CPAN meta-data about the project. 2011-12-15 21:14:07 +00:00
configure.ac Bump version to 2.2.0 2012-02-18 20:33:34 +00:00
COPYING Grafted root commit from savannah git master: 2011-11-16 14:04:03 +00:00
default-ignore-list default-ignore-list: ignore top-level README.*, LICENSE.*, and COPYING 2013-04-12 17:42:14 +01:00
INSTALL Significantly improve the handling of --with-pmdir. 2011-12-07 20:48:50 +00:00
Makefile.am Significantly improve the handling of --with-pmdir. 2011-12-07 20:48:50 +00:00
MANIFEST Rename test files to reflect their purpose. 2012-01-09 22:12:49 +00:00
MANIFEST.SKIP Ignore tmp-testing-trees anywhere. 2012-02-18 17:14:50 +00:00
META.json Bump version to 2.2.0 2012-02-18 20:33:34 +00:00
META.yml Bump version to 2.2.0 2012-02-18 20:33:34 +00:00
NEWS Bump version to 2.2.0 2012-02-18 20:33:34 +00:00
README Revamp README. 2012-03-01 11:40:34 +00:00
THANKS Remove "There are no outstanding operations to perform" warning. 2012-01-11 14:01:40 +00:00
TODO Update TODO 2012-02-18 20:33:34 +00:00

README for GNU Stow
===================

This is GNU Stow, a symlink farm manager program which takes distinct
packages of software and/or data located in separate directories on
the filesystem, and makes them appear to be installed in the same
place.  For example, /usr/local/bin could contain symlinks to files
within /usr/local/stow/emacs/bin, /usr/local/stow/perl/bin etc., and
likewise recursively for any other subdirectories such as .../share,
.../man, and so on.

This is particularly useful for keeping track of system-wide and
per-user installations of software built from source, but can also
facilitate a more controlled approach to management of configuration
files in the user's home directory, especially when coupled with
version control systems.

Stow is implemented as a combination of a Perl script providing a CLI
interface, and a backend Perl module which does most of the work.

You can get the latest information about Stow from the home page:

    http://www.gnu.org/software/stow/

License
-------

Stow is free software, licensed under the GNU General Public License,
which can be found in the file COPYING.

Installation
------------

See INSTALL for installation instructions.

Feedback
--------

Please do send comments, questions, and constructive criticism.  The
mailing lists and any other communication channels are detailed on the
above home page.

Brief history
-------------

Stow was inspired by Carnegie Mellon's "Depot" program, but is
substantially simpler.  Whereas Depot requires database files to keep
things in sync, Stow stores no extra state between runs, so there's no
danger (as there is in Depot) of mangling directories when file
hierarchies don't match the database.  Also unlike Depot, Stow will
never delete any files, directories, or links that appear in a Stow
directory (e.g., /usr/local/stow/emacs), so it's always possible to
rebuild the target tree (e.g., /usr/local).