00dani/stow
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
509 commits 1 branch 21 tags 1.3 MiB
Perl 89.7%
Makefile 5.6%
Shell 2.2%
M4 1.6%
Dockerfile 0.9%
Find a file
Adam Spiers 7815bc8b44 Revert "Remove unnecessary AM_MAKEINFOFLAGS tweak" 
This reverts commit 1a20a3f7ee.

It turns out that `texi2dvi` _does_ require `-I $(srcdir)` for
`@verbatiminclude default-ignore-list` to work after all.  It's needed
not for a normal docs build, but when `make distcheck` is run,
presumably because `distcheck` runs from a different directory.
2024-04-06 14:54:32 +01:00
automake Ditch texinfo.tex from distribution 2021-04-15 15:11:29 +01:00
bin Move setting of cperl-indent-level to .dir-locals.el 2024-03-31 12:02:58 +01:00
doc manual: clarify the pros and cons and history of --compat 2024-04-05 22:28:40 +01:00
docker Split perlbrew install-multiple into separate RUN cmd 2019-06-28 23:54:30 +01:00
lib iterate over directories in sorted order 2024-04-06 13:33:53 +01:00
t t/unstow.t: convert to use subtests 2024-04-06 11:59:23 +01:00
tools Change -w to "use warnings;" in tools/get-version 2019-06-27 20:39:16 +01:00
.dir-locals.el emacs: tweak more cperl indentation config to match existing style 2024-04-01 22:39:32 +01:00
.dumbjump Add support for emacs dumb-jump 2021-04-15 15:11:30 +01:00
.gitignore Switch to makeinfo --html --no-split for single-page HTML manual (#21) 2019-06-26 13:48:06 +01:00
.travis.yml Allow make to fail if missing modules for test dependencies 2019-06-28 20:28:22 +01:00
aclocal.m4 aclocal.m4: update to 1.16.5 2024-03-09 17:56:57 +00:00
AUTHORS AUTHORS: mention THANKS file 2021-04-15 15:11:30 +01:00
build-docker.sh Make docker scripts use get-version 2019-06-28 17:08:48 +01:00
Build.PL Remove dependencies on Hash::Merge and Clone::Choose 2019-06-29 13:42:19 +01:00
configure.ac Revert "Remove unnecessary AM_MAKEINFOFLAGS tweak" 2024-04-06 14:54:32 +01:00
CONTRIBUTING.md Highlight an issue with prove overriding TEST_VERBOSE 2024-03-31 12:02:57 +01:00
COPYING Upgrade to GPL v3 and add headers to files (#44) 2019-06-27 20:37:40 +01:00
default-ignore-list default-ignore-list: ignore top-level README.*, LICENSE.*, and COPYING 2013-04-12 17:42:14 +01:00
INSTALL.md Upgrade to GPL v3 and add headers to files (#44) 2019-06-27 20:37:40 +01:00
Makefile.am Revert "Remove unnecessary AM_MAKEINFOFLAGS tweak" 2024-04-06 14:54:32 +01:00
MANIFEST Ditch texinfo.tex from distribution 2021-04-15 15:11:29 +01:00
MANIFEST.SKIP Switch to makeinfo --html --no-split for single-page HTML manual (#21) 2019-06-26 13:48:06 +01:00
META.json Bump version to 2.3.2 for development of next release 2019-07-28 14:52:53 +01:00
META.yml Bump version to 2.3.2 for development of next release 2019-07-28 14:52:53 +01:00
NEWS foldable: rename $target => $target_subdir 2024-04-01 22:39:32 +01:00
README.md Beef up README.md and add CONTRIBUTING.md 2021-04-15 15:11:30 +01:00
test-docker.sh Make testing within Docker containers easier 2019-06-28 20:36:38 +01:00
THANKS cli.t: test with the right Perl executable 2019-07-15 16:12:26 -04:00
TODO Replace broken gmane links with links to lists.gnu.org 2021-04-15 15:11:29 +01:00

README.md

Build Status Coverage Status

README for GNU Stow

This README describes GNU Stow. This is not the definitive documentation for Stow; for that, see the info manual.

Stow is a symlink farm manager program which takes distinct sets of software and/or data located in separate directories on the filesystem, and makes them all appear to be installed in a single directory tree.

Originally Stow was born to address the need to administer, upgrade, install, and remove files in independent software packages without confusing them with other files sharing the same file system space. For instance, many years ago it used to be common to compile programs such as Perl and Emacs from source and install them in /usr/local. By using Stow, /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.

While this is useful for keeping track of system-wide and per-user installations of software built from source, in more recent times software packages are often managed by more sophisticated package management software such as rpm, dpkg, and Nix / GNU Guix, or language-native package managers such as Ruby's gem, Python's pip, Javascript's npm, and so on.

However Stow is still used not only for software package management, but also for other purposes, such as facilitating a more controlled approach to management of configuration files in the user's home directory, especially when coupled with version control systems.

Stow was inspired by Carnegie Mellon's Depot program, but is substantially simpler and safer. Whereas Depot required database files to keep things in sync, Stow stores no extra state between runs, so there's no danger (as there was 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).

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/

Installation

See INSTALL.md for installation instructions.

Documentation

Documentation for Stow is available online, as is documentation for most GNU software. Once you have Stow installed, you may also find more information about Stow by running info stow or man stow, or by looking at /usr/share/doc/stow/, /usr/local/doc/stow/, or similar directories on your system. A brief summary is available by running stow --help.

Mailing lists

Stow has the following mailing lists:

  • help-stow is for general user help and discussion.
  • stow-devel is used to discuss most aspects of Stow, including development and enhancement requests.
  • bug-stow is for bug reports.

Announcements about Stow are posted to info-stow and also, as with most other GNU software, to info-gnu (archive).

Security reports that should not be made immediately public can be sent directly to the maintainer. If there is no response to an urgent issue, you can escalate to the general security mailing list for advice.

The Savannah project also has a mailing lists page.

Getting involved

Please see the CONTRIBUTING.md file.

License

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

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without any warranty.

Brief history and authorship

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).

For a high-level overview of the contributions of the main developers over the years, see the AUTHORS file.

For a more detailed history, please see the ChangeLog file.