00dani/stow
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update the introductory text to clarify Stow's common usage

Browse source 
Thanks to Jean Louis for some suggestions on this.
This commit is contained in:
Adam Spiers 2018-02-11 11:47:39 +00:00
parent 655e8e4a3d
commit e7e6c7fbde
1 changed files with 28 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
doc/stow.texi
View file

@ -82,7 +82,10 @@ approved by the Free Software Foundation.
@ifinfo @ifinfo
This manual describes GNU Stow @value{VERSION} (@value{UPDATED}), a This manual describes GNU Stow @value{VERSION} (@value{UPDATED}), a
program for managing the installation of software packages. program for managing sets of symbolic links, in order to make groups
of related files (such as distinct packages of software, or
configuration files) in one place in the filesystem appear to be
located in another place.
@end ifinfo @end ifinfo
@end ifnottex @end ifnottex
@ -128,14 +131,19 @@ Advice on changing compilation and installation parameters
@node Introduction, Terminology, Top, Top @node Introduction, Terminology, Top, Top
@chapter Introduction @chapter Introduction
Stow is a tool for managing the installation of multiple software Stow is a tool for managing sets of symbolic links in order to
packages in the same run-time directory tree. One historical difficulty facilitate the installation of multiple software packages, or other
of this task has been the need to administer, upgrade, install, and groups of related files, such as configuration files, into a single
remove files in independent packages without confusing them with other directory tree.
files sharing the same file system space. For instance, it is common to
install Perl and Emacs in @file{/usr/local}. When one does so, one 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, it used to be common to compile Perl and Emacs from
source and install them in @file{/usr/local}. When one does so, one
winds up with the following files@footnote{As of Perl 4.036 and Emacs winds up with the following files@footnote{As of Perl 4.036 and Emacs
19.22.} in @file{/usr/local/man/man1}: 19.22. These are now ancient releases but the example still holds
valid.} in @file{/usr/local/man/man1}:
@example @example
a2p.1 a2p.1
@ -163,6 +171,18 @@ tree; i.e. (in the typical case) there should be a @file{bin} directory
containing executables, a @file{man/man1} directory containing section 1 containing executables, a @file{man/man1} directory containing section 1
man pages, and so on. man pages, and so on.
In more recent times, software packages are often managed by more
sophisticated package management software such as
@uref{https://en.wikipedia.org/wiki/Rpm_(software), @command{rpm}},
@uref{https://en.wikipedia.org/wiki/Dpkg, @command{dpkg}}, and
@uref{https://en.wikipedia.org/wiki/Nix_package_manager, Nix}.
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@footnote{@uref{http://brandon.invergo.net/news/2012-05-26-using-gnu-stow-to-manage-your-dotfiles.html}},
especially when coupled with version control
systems@footnote{@uref{http://lists.gnu.org/archive/html/info-stow/2011-12/msg00000.html}}.
Stow was inspired by Carnegie Mellon's Depot program, but is Stow was inspired by Carnegie Mellon's Depot program, but is
substantially simpler and safer. Whereas Depot required database files substantially simpler and safer. Whereas Depot required database files
to keep things in sync, Stow stores no extra state between runs, so to keep things in sync, Stow stores no extra state between runs, so