dot/stow
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Compare commits

base: dot:d3ba668350731fd2c56b60e0454135af5eb86a6a
Branches Tags
dot:main
..
compare: dot:d7da96382fa7e043d631f5d7b30fad0a3d2ae3a7
Branches Tags
dot:main

No commits in common. "d3ba668350731fd2c56b60e0454135af5eb86a6a" and "d7da96382fa7e043d631f5d7b30fad0a3d2ae3a7" have entirely different histories.
d3ba668350 ... d7da96382f

77 changed files with 9565 additions and 13015 deletions
Show stats Expand all files Collapse all files

1
.stow-rename Normal file
View file

@ -0,0 +1 @@
local => .local

3685
dot-local/share/doc/stow/ChangeLog
View file

File diff suppressed because it is too large Load diff

202
dot-local/share/doc/stow/INSTALL.md
View file

@ -1,202 +0,0 @@
How to install GNU Stow
=======================
Prerequisites
-------------
Stow is a collection of Perl scripts and modules. You must have Perl
5.6.1 or later in order for it to run. The test suite also requires
the `Test::More` and `Test::Output` modules which can be obtained from
CPAN. They are also available as packages in some of the GNU/Linux
distributions.
Installation methods
--------------------
Stow can either be installed via the standard GNU Autotools procedure
(`./configure && make install`) or since 2.1.0, via CPAN-style via
Module::Build.
Advantages of the Autotools approach:
- It's arguably more flexible.
- It will install the documentation in Info, HTML, man, and PDF
formats.
Advantages of the `Module::Build` approach:
- It's more in keeping with the standard way to distribute CPAN
modules.
- It performs dependency checking to ensure you have the necessary
Perl modules installed.
Both approaches are described in detail below. However if you are
building from the git repository rather than an official release,
you first need to perform some extra steps:
Preparatory steps required only when building from git
------------------------------------------------------
`configure` and `Makefile` are included in official releases of Stow,
but they are deliberately omitted from the git repository because they
are autogenerated. Therefore if you are installing directly from git,
you first need to generate them as follows.
First `cd` to the directory containing the source code (and this
file), and then run:
autoreconf -iv
If this runs successfully then you are ready to continue with one of
the two installation methods below.
Basic Installation via `Module::Build`
--------------------------------------
The steps in building Stow are:
1. `cd` to the directory containing the source code (and this file).
2. If you are building from an official GNU release tarball, type
`./configure && make` to configure stow for your system. If you
are building from a CPAN tarball, this step can be skipped.
If `make` warns that the Perl module installation directory is
not in `@INC`, then you should run:
eval `perl -V:siteprefix`
./configure --prefix=$siteprefix && make
to avoid a superfluous `use lib` line in your stow executable.
3. Type `perl Build.PL`.
4. Type `./Build install` to install the various files. As noted
above, this installs fewer files than the Autotools installation.
Basic Installation via Autotools
--------------------------------
The steps in building Stow are:
1. `cd` to the directory containing the source code (and this file).
2. Type `./configure` to configure stow for your system. This step
will attempt to locate your copy of perl and set its location in
`Makefile.in`. You can use the normal arguments to change the
default installation paths (see below); additionally you can use
the
--with-pmdir=/path/to/perl/modules
option to manually choose where the Perl modules get installed.
However, if you don't, the `configure` script will go to great
lengths to try to choose a sensible default.
3. Type `make install` to install the various files. If the chosen
installation directory for Perl modules is not included in Perl's
built-in `@INC` search path, the Makefile rules will automatically
insert a
use lib "...";
line into the generated stow script to ensure that it can always
locate the Perl modules without needing to manually set `PERL5LIB`.
4. You can remove the generated files from the source code directory
by typing `make clean`. To also remove the files that `configure`
created (so you can compile the package for a different computer),
type `make distclean`. There is also a `make maintainer-clean`
target, but that is intended mainly for stow's developers. If you
use it, you may have to get all sorts of other programs in order
to regenerate files that came with the distribution.
Installation Names
------------------
By default, `make install` will install the package's files in
`/usr/local/bin` and `/usr/local/info`. You can specify an
installation prefix other than `/usr/local` by giving `configure` the
option `--prefix=PATH`.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure`
the option `--program-prefix=PREFIX` or `--program-suffix=SUFFIX`.
Since `stow` is concerned with separating a package's installation
tree from its run-time tree, you might want to install `stow` into a
directory such as `/usr/local/stow/stow` but have it run out of
`/usr/local`. Do this by giving the run-time prefix (e.g.,
/usr/local) to configure as described above; then run `make`; then run
`make install prefix=/usr/local/stow/stow`. For more information on
this technique, see the Stow manual.
The configuration system
------------------------
The `configure` shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile` and to create the `stow` script
itself, using Makefile.in and stow.in as templates. Finally, it
creates a shell script `config.status` that you can run in the future
to recreate the current configuration, a file `config.cache` that
saves the results of its tests to speed up reconfiguring, and a file
`config.log` containing other output.
The file `configure.ac` is used to create `configure` by a program
called `autoconf`. You only need `configure.ac` if you want to change
it or regenerate `configure` using a newer version of `autoconf`.
The file `Makefile.am` is used to create `Makefile.in` by a program
called `automake`. You only need `Makefile.am` if you want to change
it or regenerate `Makefile.in` using a newer version of `automake`.
Sharing Defaults
----------------
If you want to set default values for `configure` scripts to share,
you can create a site shell script called `config.site` that gives
default values for variables like `CC`, `cache_file`, and `prefix`.
`configure` looks for `PREFIX/share/config.site` if it exists, then
`PREFIX/etc/config.site` if it exists. Or, you can set the
`CONFIG_SITE` environment variable to the location of the site script.
A warning: not all `configure` scripts look for a site script.
Operation Controls
------------------
`configure` recognizes the following options to control how it
operates.
`--cache-file=FILE`
Use and save the results of the tests in FILE instead of
`./config.cache`. Set FILE to `/dev/null` to disable caching, for
debugging `configure`.
`--help`
Print a summary of the options to `configure`, and exit.
`--quiet`
`--silent`
`-q`
Do not print messages saying which checks are being made.
`--srcdir=DIR`
Look for the package's source code in directory DIR. Usually
`configure` can determine that directory automatically.
`--version`
Print the version of Autoconf used to generate the `configure`
script, and exit.
`configure` also accepts some other, not widely useful, options.
License for this file
---------------------
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.

101
dot-local/share/doc/stow/README.md
View file

@ -1,101 +0,0 @@
[![Build Status](https://travis-ci.org/aspiers/stow.svg)](https://travis-ci.org/aspiers/stow)
[![Coverage Status](https://coveralls.io/repos/aspiers/stow/badge.svg?branch=master&service=github)](https://coveralls.io/github/aspiers/stow?branch=master)
README for GNU Stow
===================
This README describes GNU Stow. This is not the definitive
documentation for Stow; for that, see the [info
manual](https://www.gnu.org/software/stow/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`](https://en.wikipedia.org/wiki/Rpm_(software)),
[`dpkg`](https://en.wikipedia.org/wiki/Dpkg), and
[Nix](https://en.wikipedia.org/wiki/Nix_package_manager) / [GNU
Guix](https://en.wikipedia.org/wiki/GNU_Guix), or language-native
package managers such as Ruby's
[`gem`](https://en.wikipedia.org/wiki/RubyGems), Python's
[`pip`](https://en.wikipedia.org/wiki/Pip_(package_manager)),
Javascript's [`npm`](https://en.wikipedia.org/wiki/Npm_(software)),
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](http://brandon.invergo.net/news/2012-05-26-using-gnu-stow-to-manage-your-dotfiles.html),
especially when [coupled with version control
systems](http://lists.gnu.org/archive/html/info-stow/2011-12/msg00000.html).
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/
License
-------
Stow is free software, licensed under the GNU General Public License,
which can be found in the file [`COPYING`](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.
Installation
------------
See [`INSTALL.md`](INSTALL.md) 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 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](AUTHORS).
For a more detailed history, please see the `ChangeLog` file.

2326
dot-local/share/doc/stow/manual-single.html
View file

File diff suppressed because it is too large Load diff

104
dot-local/share/doc/stow/manual-split/Bootstrapping.html
View file

@ -1,104 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Bootstrapping (Stow)</title>
<meta name="description" content="Bootstrapping (Stow)">
<meta name="keywords" content="Bootstrapping (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Reporting-Bugs.html" rel="next" title="Reporting Bugs">
<link href="Compile_002dtime-vs-Install_002dtime.html" rel="prev" title="Compile-time vs Install-time">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Bootstrapping">
<div class="nav-panel">
<p>
Next: <a href="Reporting-Bugs.html" accesskey="n" rel="next">Reporting Bugs</a>, Previous: <a href="Compile_002dtime-vs-Install_002dtime.html" accesskey="p" rel="prev">Compile-time vs Install-time</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Bootstrapping-1"><span>13 Bootstrapping<a class="copiable-link" href="#Bootstrapping-1"> &para;</a></span></h2>
<p>Suppose you have a stow directory all set up and ready to go:
<samp class="file">/usr/local/stow/perl</samp> contains the Perl installation,
<samp class="file">/usr/local/stow/stow</samp> contains Stow itself, and perhaps you have
other packages waiting to be stowed. You&rsquo;d like to be able to do this:
</p>
<div class="example">
<pre class="example-preformatted">cd /usr/local/stow
stow -vv *
</pre></div>
<p>but <code class="command">stow</code> is not yet in your <code class="env">PATH</code>. Nor can you do this:
</p>
<div class="example">
<pre class="example-preformatted">cd /usr/local/stow
stow/bin/stow -vv *
</pre></div>
<p>because the &lsquo;<samp class="samp">#!</samp>&rsquo; line at the beginning of <code class="command">stow</code> tries to
locate Perl (usually in <samp class="file">/usr/local/bin/perl</samp>), and that won&rsquo;t be
found. The solution you must use is:
</p>
<div class="example">
<pre class="example-preformatted">cd /usr/local/stow
perl/bin/perl stow/bin/stow -vv *
</pre></div>
</div>
</body>
</html>

162
dot-local/share/doc/stow/manual-split/Compile_002dtime-vs-Install_002dtime.html
View file

@ -1,162 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Compile-time vs Install-time (Stow)</title>
<meta name="description" content="Compile-time vs Install-time (Stow)">
<meta name="keywords" content="Compile-time vs Install-time (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Bootstrapping.html" rel="next" title="Bootstrapping">
<link href="Resource-Files.html" rel="prev" title="Resource Files">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span.r {font-family: initial; font-weight: normal; font-style: normal}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Compile_002dtime-vs-Install_002dtime">
<div class="nav-panel">
<p>
Next: <a href="Bootstrapping.html" accesskey="n" rel="next">Bootstrapping</a>, Previous: <a href="Resource-Files.html" accesskey="p" rel="prev">Resource Files</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Compile_002dtime-vs-Install_002dtime-1"><span>12 Compile-time vs Install-time<a class="copiable-link" href="#Compile_002dtime-vs-Install_002dtime-1"> &para;</a></span></h2>
<p>Software whose installation is managed with Stow needs to be installed
in one place (the package directory, e.g. <samp class="file">/usr/local/stow/perl</samp>)
but needs to appear to run in another place (the target tree, e.g.,
<samp class="file">/usr/local</samp>). Why is this important? What&rsquo;s wrong with Perl, for
instance, looking for its files in <samp class="file">/usr/local/stow/perl</samp> instead
of in <samp class="file">/usr/local</samp>?
</p>
<p>The answer is that there may be another package, e.g.,
<samp class="file">/usr/local/stow/perl-extras</samp>, stowed under <samp class="file">/usr/local</samp>. If
Perl is configured to find its files in <samp class="file">/usr/local/stow/perl</samp>, it
will never find the extra files in the &lsquo;<samp class="samp">perl-extras</samp>&rsquo; package, even
though they&rsquo;re intended to be found by Perl. On the other hand, if Perl
looks for its files in <samp class="file">/usr/local</samp>, then it will find the
intermingled Perl and &lsquo;<samp class="samp">perl-extras</samp>&rsquo; files.
</p>
<p>This means that when you compile a package, you must tell it the
location of the run-time, or target tree; but when you install it, you
must place it in the stow tree.
</p>
<ul class="mini-toc">
<li><a href="#Advice-on-changing-compilation-and-installation-parameters" accesskey="1">Advice on changing compilation and installation parameters</a></li>
<li><a href="GNU-Emacs.html" accesskey="2">GNU Emacs</a></li>
<li><a href="Other-FSF-Software.html" accesskey="3">Other FSF Software</a></li>
<li><a href="Cygnus-Software.html" accesskey="4">Cygnus Software</a></li>
<li><a href="Perl-and-Perl-5-Modules.html" accesskey="5">Perl and Perl 5 Modules</a></li>
</ul>
<div class="section-level-extent" id="Advice-on-changing-compilation-and-installation-parameters">
<h3 class="section"><span>12.1 Advice on changing compilation and installation parameters<a class="copiable-link" href="#Advice-on-changing-compilation-and-installation-parameters"> &para;</a></span></h3>
<p>Some software packages allow you to specify, at compile-time, separate
locations for installation and for run-time. Perl is one such package;
see <a class="ref" href="Perl-and-Perl-5-Modules.html">Perl and Perl 5 Modules</a>. Others allow you to compile the
package, then give a different destination in the &lsquo;<samp class="samp">make install</samp>&rsquo;
step without causing the binaries or other files to get rebuilt. Most
GNU software falls into this category; Emacs is a notable exception.
See <a class="xref" href="GNU-Emacs.html">GNU Emacs</a>, and <a class="ref" href="Other-FSF-Software.html">Other FSF Software</a>.
</p>
<p>Still other software packages cannot abide the idea of separate
installation and run-time locations at all. If you try to &lsquo;<samp class="samp">make
install prefix=/usr/local/stow/<var class="var">foo</var></samp>&rsquo;, then first the whole package
will be recompiled to hardwire the <samp class="file">/usr/local/stow/<var class="var">foo</var></samp>
path. With these packages, it is best to compile normally, then run
&lsquo;<samp class="samp">make -n install</samp>&rsquo;, which should report all the steps needed to
install the just-built software. Place this output into a file, edit
the commands in the file to remove recompilation steps and to reflect
the Stow-based installation location, and execute the edited file as a
shell script in place of &lsquo;<samp class="samp">make install</samp>&rsquo;. Be sure to execute the
script using the same shell that &lsquo;<samp class="samp">make install</samp>&rsquo; would have used.
</p>
<p>(If you use GNU Make and a shell [such as GNU bash] that understands
<code class="command">pushd</code> and <code class="command">popd</code>, you can do the following:
</p>
<ol class="enumerate">
<li> Replace all lines matching &lsquo;<samp class="samp">make[<var class="var">n</var>]: Entering directory
<var class="var">dir</var></samp>&rsquo; with &lsquo;<samp class="samp">pushd <var class="var">dir</var></samp>&rsquo;.
</li><li> Replace all lines matching &lsquo;<samp class="samp">make[<var class="var">n</var>]: Leaving directory
<var class="var">dir</var></samp>&rsquo; with &lsquo;<samp class="samp">popd</samp>&rsquo;.
</li><li> Delete all lines matching &lsquo;<samp class="samp">make[<var class="var">n</var>]: Nothing to be done for
<var class="var">rule</var></samp>&rsquo;.
</li></ol>
<p>Then find other lines in the output containing <code class="command">cd</code> or <code class="command">make</code>
commands and rewrite or delete them. In particular, you should be able
to delete sections of the script that resemble this:
</p>
<div class="example">
<pre class="example-preformatted">for i in <var class="var">dir_1</var> <var class="var">dir_2</var> <span class="r">...</span>; do \
(cd $i; make <var class="var">args</var> <span class="r">...</span>) \
done
</pre></div>
<p>Note, that&rsquo;s &ldquo;should be able to,&rdquo; not &ldquo;can.&rdquo; Be sure to modulate
these guidelines with plenty of your own intelligence.
</p>
<p>The details of stowing some specific packages are described in the
following sections.
</p>
</div>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Bootstrapping.html">Bootstrapping</a>, Previous: <a href="Resource-Files.html">Resource Files</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>

117
dot-local/share/doc/stow/manual-split/Conflicts.html
View file

@ -1,117 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Conflicts (Stow)</title>
<meta name="description" content="Conflicts (Stow)">
<meta name="keywords" content="Conflicts (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Mixing-Operations.html" rel="next" title="Mixing Operations">
<link href="Deleting-Packages.html" rel="prev" title="Deleting Packages">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Conflicts">
<div class="nav-panel">
<p>
Next: <a href="Mixing-Operations.html" accesskey="n" rel="next">Mixing Operations</a>, Previous: <a href="Deleting-Packages.html" accesskey="p" rel="prev">Deleting Packages</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Conflicts-1"><span>7 Conflicts<a class="copiable-link" href="#Conflicts-1"> &para;</a></span></h2>
<a class="index-entry-id" id="index-conflicts-1"></a>
<p>If, during installation, a file or symlink exists in the target tree and
has the same name as something Stow needs to create, and if the
existing name is not a folded tree that can be split open, then a
<em class="dfn">conflict</em> has arisen. A conflict also occurs if a directory exists
where Stow needs to place a symlink to a non-directory. On the
other hand, if the existing name is merely a symlink that already points
where Stow needs it to, then no conflict has occurred. (Thus it
is harmless to install a package that has already been installed.)
</p>
<p>For complex packages, scanning the stow and target trees in tandem,
and deciding whether to make directories or links, split-open or fold
directories, can actually take a long time (a number of seconds).
Moreover, an accurate analysis of potential conflicts requires us to
take into account all of these operations.
</p>
<a class="anchor" id="Deferred-Operation"></a><ul class="mini-toc">
<li><a href="#Deferred-Operation-1" accesskey="1">Deferred Operation</a></li>
</ul>
<div class="section-level-extent" id="Deferred-Operation-1">
<h3 class="section"><span>7.1 Deferred Operation<a class="copiable-link" href="#Deferred-Operation-1"> &para;</a></span></h3>
<a class="index-entry-id" id="index-deferred-operation"></a>
<p>Since version 2.0, Stow now adopts a two-phase algorithm, first
scanning for any potential conflicts before any stowing or unstowing
operations are performed. If any conflicts are found, they are
displayed and then Stow terminates without making any modifications to
the filesystem. This means that there is much less risk of a package
being partially stowed or unstowed due to conflicts.
</p>
<p>Prior to version 2.0, if a conflict was discovered, the stow or unstow
operation could be aborted mid-flow, leaving the target tree in an
inconsistent state.
</p>
</div>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Mixing-Operations.html">Mixing Operations</a>, Previous: <a href="Deleting-Packages.html">Deleting Packages</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>

103
dot-local/share/doc/stow/manual-split/Cygnus-Software.html
View file

@ -1,103 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Cygnus Software (Stow)</title>
<meta name="description" content="Cygnus Software (Stow)">
<meta name="keywords" content="Cygnus Software (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Compile_002dtime-vs-Install_002dtime.html" rel="up" title="Compile-time vs Install-time">
<link href="Perl-and-Perl-5-Modules.html" rel="next" title="Perl and Perl 5 Modules">
<link href="Other-FSF-Software.html" rel="prev" title="Other FSF Software">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span.r {font-family: initial; font-weight: normal; font-style: normal}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="section-level-extent" id="Cygnus-Software">
<div class="nav-panel">
<p>
Next: <a href="Perl-and-Perl-5-Modules.html" accesskey="n" rel="next">Perl and Perl 5 Modules</a>, Previous: <a href="Other-FSF-Software.html" accesskey="p" rel="prev">Other FSF Software</a>, Up: <a href="Compile_002dtime-vs-Install_002dtime.html" accesskey="u" rel="up">Compile-time vs Install-time</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="Cygnus-Software-1"><span>12.4 Cygnus Software<a class="copiable-link" href="#Cygnus-Software-1"> &para;</a></span></h3>
<p>Cygnus is a commercial supplier and supporter of GNU software. It has
also written several of its own packages, released under the terms of
the GNU General Public License; and it has taken over the maintenance of
other packages. Among the packages released by Cygnus are &lsquo;<samp class="samp">gdb</samp>&rsquo;,
&lsquo;<samp class="samp">gnats</samp>&rsquo;, and &lsquo;<samp class="samp">dejagnu</samp>&rsquo;.
</p>
<p>Cygnus packages have the peculiarity that each one unpacks into a
directory tree with a generic top-level Makefile, which is set up to
compile <em class="emph">all</em> of Cygnus&rsquo; packages, any number of which may reside
under the top-level directory. In other words, even if you&rsquo;re only
building &lsquo;<samp class="samp">gnats</samp>&rsquo;, the top-level Makefile will look for, and try to
build, <samp class="file">gdb</samp> and <samp class="file">dejagnu</samp> subdirectories, among many others.
</p>
<p>The result is that if you try &lsquo;<samp class="samp">make -n install
prefix=/usr/local/stow/<var class="var">package</var></samp>&rsquo; at the top level of a Cygnus
package, you&rsquo;ll get a bewildering amount of output. It will then be
very difficult to visually scan the output to see whether the install
will proceed correctly. Unfortunately, it&rsquo;s not always clear how to
invoke an install from the subdirectory of interest.
</p>
<p>In cases like this, the best approach is to run your &lsquo;<samp class="samp">make install
prefix=<span class="r">&hellip;</span></samp>&rsquo;, but be ready to interrupt it if you detect that it
is recompiling files. Usually it will work just fine; otherwise,
install manually.
</p>
</div>
</body>
</html>

55
dot-local/share/doc/stow/manual-split/Deferred-Operation.html
View file

@ -1,55 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<!-- This file redirects to the location of a node or anchor -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Deferred Operation (Stow)</title>
<meta name="description" content="Deferred Operation (Stow)">
<meta name="keywords" content="Deferred Operation (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Refresh" content="0; url=Conflicts.html#Deferred-Operation">
<meta name="viewport" content="width=device-width,initial-scale=1">
</head>
<body lang="en">
<p>The node you are looking for is at <a href="Conflicts.html#Deferred-Operation">Deferred Operation</a>.</p>
</body>

126
dot-local/share/doc/stow/manual-split/Deleting-Packages.html
View file

@ -1,126 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Deleting Packages (Stow)</title>
<meta name="description" content="Deleting Packages (Stow)">
<meta name="keywords" content="Deleting Packages (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Conflicts.html" rel="next" title="Conflicts">
<link href="Installing-Packages.html" rel="prev" title="Installing Packages">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Deleting-Packages">
<div class="nav-panel">
<p>
Next: <a href="Conflicts.html" accesskey="n" rel="next">Conflicts</a>, Previous: <a href="Installing-Packages.html" accesskey="p" rel="prev">Installing Packages</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Deleting-Packages-1"><span>6 Deleting Packages<a class="copiable-link" href="#Deleting-Packages-1"> &para;</a></span></h2>
<a class="index-entry-id" id="index-deletion"></a>
<p>When the <samp class="option">-D</samp> option is given, the action of Stow is to
delete a package from the target tree. Note that Stow will not
delete anything it doesn&rsquo;t &ldquo;own&rdquo;. Deleting a package does <em class="emph">not</em>
mean removing it from the stow directory or discarding the package
tree.
</p>
<p>To delete a package, Stow recursively scans the target tree, skipping over any
directory that is not included in the installation image.<a class="footnote" id="DOCF7" href="#FOOT7"><sup>7</sup></a>
For example, if the target directory is <samp class="file">/usr/local</samp> and the
installation image for the package being deleted has only a <samp class="file">bin</samp>
directory and a <samp class="file">man</samp> directory at the top level, then we only scan
<samp class="file">/usr/local/bin</samp> and <samp class="file">/usr/local/man</samp>, and not
<samp class="file">/usr/local/lib</samp> or <samp class="file">/usr/local/share</samp>, or for that matter
<samp class="file">/usr/local/stow</samp>. Any symlink it finds that points into the package
being deleted is removed. Any directory that contained only symlinks to the
package being deleted is removed.
</p>
<a class="anchor" id="tree-refolding"></a><ul class="mini-toc">
<li><a href="#Refolding-_0060_0060foldable_0027_0027-trees_002e" accesskey="1">Refolding &ldquo;foldable&rdquo; trees.</a></li>
</ul>
<div class="section-level-extent" id="Refolding-_0060_0060foldable_0027_0027-trees_002e">
<h3 class="section"><span>6.1 Refolding &ldquo;foldable&rdquo; trees.<a class="copiable-link" href="#Refolding-_0060_0060foldable_0027_0027-trees_002e"> &para;</a></span></h3>
<a class="index-entry-id" id="index-refolding-trees"></a>
<a class="index-entry-id" id="index-tree-refolding"></a>
<p>After removing symlinks and empty subdirectories, any directory that
contains only symlinks to a single other package is considered to be a
previously &ldquo;folded&rdquo; tree that was &ldquo;split open.&rdquo; Stow will refold
the tree by removing the symlinks to the surviving package, removing
the directory, then linking the directory back to the surviving
package. However, this behaviour can be prevented via the
<samp class="option">--no-folding</samp> option; see <a class="pxref" href="Invoking-Stow.html">Invoking Stow</a>.
</p>
</div>
</div>
<div class="footnotes-segment">
<hr>
<h4 class="footnotes-heading">Footnotes</h4>
<h5 class="footnote-body-heading"><a id="FOOT7" href="#DOCF7">(7)</a></h5>
<p>This
approach was introduced in version 2 of GNU Stow. Previously, the whole
target tree was scanned and stow directories were explicitly omitted. This
became problematic when dealing with very large installations. The only
situation where this is useful is if you accidentally delete a directory in
the package tree, leaving you with a whole bunch of dangling links. Note that
you can enable the old approach with the <samp class="option">-p</samp> option. Alternatively, you can
use the <samp class="option">--badlinks</samp> option get stow to search for dangling links in your target tree and remove the offenders manually.</p>
</div>
</body>
</html>

112
dot-local/share/doc/stow/manual-split/GNU-Emacs.html
View file

@ -1,112 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>GNU Emacs (Stow)</title>
<meta name="description" content="GNU Emacs (Stow)">
<meta name="keywords" content="GNU Emacs (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Compile_002dtime-vs-Install_002dtime.html" rel="up" title="Compile-time vs Install-time">
<link href="Other-FSF-Software.html" rel="next" title="Other FSF Software">
<link href="Compile_002dtime-vs-Install_002dtime.html" rel="prev" title="Compile-time vs Install-time">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="section-level-extent" id="GNU-Emacs">
<div class="nav-panel">
<p>
Next: <a href="Other-FSF-Software.html" accesskey="n" rel="next">Other FSF Software</a>, Previous: <a href="Compile_002dtime-vs-Install_002dtime.html" accesskey="p" rel="prev">Compile-time vs Install-time</a>, Up: <a href="Compile_002dtime-vs-Install_002dtime.html" accesskey="u" rel="up">Compile-time vs Install-time</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="GNU-Emacs-1"><span>12.2 GNU Emacs<a class="copiable-link" href="#GNU-Emacs-1"> &para;</a></span></h3>
<p>Although the Free Software Foundation has many enlightened practices
regarding Makefiles and software installation (see see <a class="pxref" href="Other-FSF-Software.html">Other FSF Software</a>), Emacs, its flagship program, doesn&rsquo;t quite follow the
rules. In particular, most GNU software allows you to write:
</p>
<div class="example">
<pre class="example-preformatted">make
make install prefix=/usr/local/stow/<var class="var">package</var>
</pre></div>
<p>If you try this with Emacs, then the new value for <var class="var">prefix</var> in the
&lsquo;<samp class="samp">make install</samp>&rsquo; step will cause some files to get recompiled with
the new value of <var class="var">prefix</var> wired into them. In Emacs 19.23 and
later,<a class="footnote" id="DOCF8" href="#FOOT8"><sup>8</sup></a>
the way to work around this problem is:
</p>
<div class="example">
<pre class="example-preformatted">make
make install-arch-dep install-arch-indep prefix=/usr/local/stow/emacs
</pre></div>
<p>In 19.22 and some prior versions of Emacs, the workaround was:
</p>
<div class="example">
<pre class="example-preformatted">make
make do-install prefix=/usr/local/stow/emacs
</pre></div>
</div>
<div class="footnotes-segment">
<hr>
<h4 class="footnotes-heading">Footnotes</h4>
<h5 class="footnote-body-heading"><a id="FOOT8" href="#DOCF8">(8)</a></h5>
<p>As I write this, the current version of Emacs is 19.31.</p>
</div>
</body>
</html>

786
dot-local/share/doc/stow/manual-split/GNU-General-Public-License.html
View file

@ -1,786 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>GNU General Public License (Stow)</title>
<meta name="description" content="GNU General Public License (Stow)">
<meta name="keywords" content="GNU General Public License (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Index.html" rel="next" title="Index">
<link href="Known-Bugs.html" rel="prev" title="Known Bugs">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.center {text-align:center}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
pre.display-preformatted {font-family: inherit}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="unnumbered-level-extent" id="GNU-General-Public-License">
<div class="nav-panel">
<p>
Next: <a href="Index.html" accesskey="n" rel="next">Index</a>, Previous: <a href="Known-Bugs.html" accesskey="p" rel="prev">Known Bugs</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="unnumbered" id="GNU-General-Public-License-1"><span>GNU General Public License<a class="copiable-link" href="#GNU-General-Public-License-1"> &para;</a></span></h2>
<div class="center">Version 3, 29 June 2007
</div>
<div class="display">
<pre class="display-preformatted">Copyright &copy; 2007 Free Software Foundation, Inc. <a class="url" href="https://fsf.org/">https://fsf.org/</a>
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
</pre></div>
<h3 class="heading" id="Preamble"><span>Preamble<a class="copiable-link" href="#Preamble"> &para;</a></span></h3>
<p>The GNU General Public License is a free, copyleft license for
software and other kinds of works.
</p>
<p>The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom
to share and change all versions of a program&mdash;to make sure it remains
free software for all its users. We, the Free Software Foundation,
use the GNU General Public License for most of our software; it
applies also to any other work released this way by its authors. You
can apply it to your programs, too.
</p>
<p>When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
</p>
<p>To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you
have certain responsibilities if you distribute copies of the
software, or if you modify it: responsibilities to respect the freedom
of others.
</p>
<p>For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too,
receive or can get the source code. And you must show them these
terms so they know their rights.
</p>
<p>Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
</p>
<p>For the developers&rsquo; and authors&rsquo; protection, the GPL clearly explains
that there is no warranty for this free software. For both users&rsquo; and
authors&rsquo; sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
</p>
<p>Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the
manufacturer can do so. This is fundamentally incompatible with the
aim of protecting users&rsquo; freedom to change the software. The
systematic pattern of such abuse occurs in the area of products for
individuals to use, which is precisely where it is most unacceptable.
Therefore, we have designed this version of the GPL to prohibit the
practice for those products. If such problems arise substantially in
other domains, we stand ready to extend this provision to those
domains in future versions of the GPL, as needed to protect the
freedom of users.
</p>
<p>Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish
to avoid the special danger that patents applied to a free program
could make it effectively proprietary. To prevent this, the GPL
assures that patents cannot be used to render the program non-free.
</p>
<p>The precise terms and conditions for copying, distribution and
modification follow.
</p>
<h3 class="heading" id="TERMS-AND-CONDITIONS"><span>TERMS AND CONDITIONS<a class="copiable-link" href="#TERMS-AND-CONDITIONS"> &para;</a></span></h3>
<ol class="enumerate" start="0">
<li> Definitions.
<p>&ldquo;This License&rdquo; refers to version 3 of the GNU General Public License.
</p>
<p>&ldquo;Copyright&rdquo; also means copyright-like laws that apply to other kinds
of works, such as semiconductor masks.
</p>
<p>&ldquo;The Program&rdquo; refers to any copyrightable work licensed under this
License. Each licensee is addressed as &ldquo;you&rdquo;. &ldquo;Licensees&rdquo; and
&ldquo;recipients&rdquo; may be individuals or organizations.
</p>
<p>To &ldquo;modify&rdquo; a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of
an exact copy. The resulting work is called a &ldquo;modified version&rdquo; of
the earlier work or a work &ldquo;based on&rdquo; the earlier work.
</p>
<p>A &ldquo;covered work&rdquo; means either the unmodified Program or a work based
on the Program.
</p>
<p>To &ldquo;propagate&rdquo; a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
</p>
<p>To &ldquo;convey&rdquo; a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user
through a computer network, with no transfer of a copy, is not
conveying.
</p>
<p>An interactive user interface displays &ldquo;Appropriate Legal Notices&rdquo; to
the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
</p>
</li><li> Source Code.
<p>The &ldquo;source code&rdquo; for a work means the preferred form of the work for
making modifications to it. &ldquo;Object code&rdquo; means any non-source form
of a work.
</p>
<p>A &ldquo;Standard Interface&rdquo; means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
</p>
<p>The &ldquo;System Libraries&rdquo; of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
&ldquo;Major Component&rdquo;, in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
</p>
<p>The &ldquo;Corresponding Source&rdquo; for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work&rsquo;s
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
</p>
<p>The Corresponding Source need not include anything that users can
regenerate automatically from other parts of the Corresponding Source.
</p>
<p>The Corresponding Source for a work in source code form is that same
work.
</p>
</li><li> Basic Permissions.
<p>All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
</p>
<p>You may make, run and propagate covered works that you do not convey,
without conditions so long as your license otherwise remains in force.
You may convey covered works to others for the sole purpose of having
them make modifications exclusively for you, or provide you with
facilities for running those works, provided that you comply with the
terms of this License in conveying all material for which you do not
control copyright. Those thus making or running the covered works for
you must do so exclusively on your behalf, under your direction and
control, on terms that prohibit them from making any copies of your
copyrighted material outside their relationship with you.
</p>
<p>Conveying under any other circumstances is permitted solely under the
conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
</p>
</li><li> Protecting Users&rsquo; Legal Rights From Anti-Circumvention Law.
<p>No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
</p>
<p>When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such
circumvention is effected by exercising rights under this License with
respect to the covered work, and you disclaim any intention to limit
operation or modification of the work as a means of enforcing, against
the work&rsquo;s users, your or third parties&rsquo; legal rights to forbid
circumvention of technological measures.
</p>
</li><li> Conveying Verbatim Copies.
<p>You may convey verbatim copies of the Program&rsquo;s source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
</p>
<p>You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
</p>
</li><li> Conveying Modified Source Versions.
<p>You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these
conditions:
</p>
<ol class="enumerate" type="a" start="1">
<li> The work must carry prominent notices stating that you modified it,
and giving a relevant date.
</li><li> The work must carry prominent notices stating that it is released
under this License and any conditions added under section 7. This
requirement modifies the requirement in section 4 to &ldquo;keep intact all
notices&rdquo;.
</li><li> You must license the entire work, as a whole, under this License to
anyone who comes into possession of a copy. This License will
therefore apply, along with any applicable section 7 additional terms,
to the whole of the work, and all its parts, regardless of how they
are packaged. This License gives no permission to license the work in
any other way, but it does not invalidate such permission if you have
separately received it.
</li><li> If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your work
need not make them do so.
</li></ol>
<p>A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
&ldquo;aggregate&rdquo; if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation&rsquo;s users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
</p>
</li><li> Conveying Non-Source Forms.
<p>You may convey a covered work in object code form under the terms of
sections 4 and 5, provided that you also convey the machine-readable
Corresponding Source under the terms of this License, in one of these
ways:
</p>
<ol class="enumerate" type="a" start="1">
<li> Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium customarily
used for software interchange.
</li><li> Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a written
offer, valid for at least three years and valid for as long as you
offer spare parts or customer support for that product model, to give
anyone who possesses the object code either (1) a copy of the
Corresponding Source for all the software in the product that is
covered by this License, on a durable physical medium customarily used
for software interchange, for a price no more than your reasonable
cost of physically performing this conveying of source, or (2) access
to copy the Corresponding Source from a network server at no charge.
</li><li> Convey individual copies of the object code with a copy of the written
offer to provide the Corresponding Source. This alternative is
allowed only occasionally and noncommercially, and only if you
received the object code with such an offer, in accord with subsection
6b.
</li><li> Convey the object code by offering access from a designated place
(gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to copy
the object code is a network server, the Corresponding Source may be
on a different server (operated by you or a third party) that supports
equivalent copying facilities, provided you maintain clear directions
next to the object code saying where to find the Corresponding Source.
Regardless of what server hosts the Corresponding Source, you remain
obligated to ensure that it is available for as long as needed to
satisfy these requirements.
</li><li> Convey the object code using peer-to-peer transmission, provided you
inform other peers where the object code and Corresponding Source of
the work are being offered to the general public at no charge under
subsection 6d.
</li></ol>
<p>A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
</p>
<p>A &ldquo;User Product&rdquo; is either (1) a &ldquo;consumer product&rdquo;, which means any
tangible personal property which is normally used for personal,
family, or household purposes, or (2) anything designed or sold for
incorporation into a dwelling. In determining whether a product is a
consumer product, doubtful cases shall be resolved in favor of
coverage. For a particular product received by a particular user,
&ldquo;normally used&rdquo; refers to a typical or common use of that class of
product, regardless of the status of the particular user or of the way
in which the particular user actually uses, or expects or is expected
to use, the product. A product is a consumer product regardless of
whether the product has substantial commercial, industrial or
non-consumer uses, unless such uses represent the only significant
mode of use of the product.
</p>
<p>&ldquo;Installation Information&rdquo; for a User Product means any methods,
procedures, authorization keys, or other information required to
install and execute modified versions of a covered work in that User
Product from a modified version of its Corresponding Source. The
information must suffice to ensure that the continued functioning of
the modified object code is in no case prevented or interfered with
solely because modification has been made.
</p>
<p>If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
</p>
<p>The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or
updates for a work that has been modified or installed by the
recipient, or for the User Product in which it has been modified or
installed. Access to a network may be denied when the modification
itself materially and adversely affects the operation of the network
or violates the rules and protocols for communication across the
network.
</p>
<p>Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
</p>
</li><li> Additional Terms.
<p>&ldquo;Additional permissions&rdquo; are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
</p>
<p>When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
</p>
<p>Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders
of that material) supplement the terms of this License with terms:
</p>
<ol class="enumerate" type="a" start="1">
<li> Disclaiming warranty or limiting liability differently from the terms
of sections 15 and 16 of this License; or
</li><li> Requiring preservation of specified reasonable legal notices or author
attributions in that material or in the Appropriate Legal Notices
displayed by works containing it; or
</li><li> Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
</li><li> Limiting the use for publicity purposes of names of licensors or
authors of the material; or
</li><li> Declining to grant rights under trademark law for use of some trade
names, trademarks, or service marks; or
</li><li> Requiring indemnification of licensors and authors of that material by
anyone who conveys the material (or modified versions of it) with
contractual assumptions of liability to the recipient, for any
liability that these contractual assumptions directly impose on those
licensors and authors.
</li></ol>
<p>All other non-permissive additional terms are considered &ldquo;further
restrictions&rdquo; within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
</p>
<p>If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
</p>
<p>Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions; the
above requirements apply either way.
</p>
</li><li> Termination.
<p>You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
</p>
<p>However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
</p>
<p>Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
</p>
<p>Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
</p>
</li><li> Acceptance Not Required for Having Copies.
<p>You are not required to accept this License in order to receive or run
a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
</p>
</li><li> Automatic Licensing of Downstream Recipients.
<p>Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
</p>
<p>An &ldquo;entity transaction&rdquo; is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party&rsquo;s predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
</p>
<p>You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
</p>
</li><li> Patents.
<p>A &ldquo;contributor&rdquo; is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor&rsquo;s &ldquo;contributor version&rdquo;.
</p>
<p>A contributor&rsquo;s &ldquo;essential patent claims&rdquo; are all patent claims owned
or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, &ldquo;control&rdquo; includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
</p>
<p>Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor&rsquo;s essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
</p>
<p>In the following three paragraphs, a &ldquo;patent license&rdquo; is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To &ldquo;grant&rdquo; such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
</p>
<p>If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. &ldquo;Knowingly relying&rdquo; means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient&rsquo;s use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
</p>
<p>If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
</p>
<p>A patent license is &ldquo;discriminatory&rdquo; if it does not include within the
scope of its coverage, prohibits the exercise of, or is conditioned on
the non-exercise of one or more of the rights that are specifically
granted under this License. You may not convey a covered work if you
are a party to an arrangement with a third party that is in the
business of distributing software, under which you make payment to the
third party based on the extent of your activity of conveying the
work, and under which the third party grants, to any of the parties
who would receive the covered work from you, a discriminatory patent
license (a) in connection with copies of the covered work conveyed by
you (or copies made from those copies), or (b) primarily for and in
connection with specific products or compilations that contain the
covered work, unless you entered into that arrangement, or that patent
license was granted, prior to 28 March 2007.
</p>
<p>Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
</p>
</li><li> No Surrender of Others&rsquo; Freedom.
<p>If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey
a covered work so as to satisfy simultaneously your obligations under
this License and any other pertinent obligations, then as a
consequence you may not convey it at all. For example, if you agree
to terms that obligate you to collect a royalty for further conveying
from those to whom you convey the Program, the only way you could
satisfy both those terms and this License would be to refrain entirely
from conveying the Program.
</p>
</li><li> Use with the GNU Affero General Public License.
<p>Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
</p>
</li><li> Revised Versions of this License.
<p>The Free Software Foundation may publish revised and/or new versions
of the GNU General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
</p>
<p>Each version is given a distinguishing version number. If the Program
specifies that a certain numbered version of the GNU General Public
License &ldquo;or any later version&rdquo; applies to it, you have the option of
following the terms and conditions either of that numbered version or
of any later version published by the Free Software Foundation. If
the Program does not specify a version number of the GNU General
Public License, you may choose any version ever published by the Free
Software Foundation.
</p>
<p>If the Program specifies that a proxy can decide which future versions
of the GNU General Public License can be used, that proxy&rsquo;s public
statement of acceptance of a version permanently authorizes you to
choose that version for the Program.
</p>
<p>Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
</p>
</li><li> Disclaimer of Warranty.
<p>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM &ldquo;AS IS&rdquo; WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
</p>
</li><li> Limitation of Liability.
<p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
</p>
</li><li> Interpretation of Sections 15 and 16.
<p>If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
</p>
</li></ol>
<h3 class="heading" id="END-OF-TERMS-AND-CONDITIONS"><span>END OF TERMS AND CONDITIONS<a class="copiable-link" href="#END-OF-TERMS-AND-CONDITIONS"> &para;</a></span></h3>
<h3 class="heading" id="How-to-Apply-These-Terms-to-Your-New-Programs"><span>How to Apply These Terms to Your New Programs<a class="copiable-link" href="#How-to-Apply-These-Terms-to-Your-New-Programs"> &para;</a></span></h3>
<p>If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
</p>
<p>To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the &ldquo;copyright&rdquo; line and a pointer to where the full notice is found.
</p>
<div class="example smallexample">
<pre class="example-preformatted"><var class="var">one line to give the program's name and a brief idea of what it does.</var>
Copyright (C) <var class="var">year</var> <var class="var">name of author</var>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <a class="url" href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.
</pre></div>
<p>Also add information on how to contact you by electronic and paper mail.
</p>
<p>If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
</p>
<div class="example smallexample">
<pre class="example-preformatted"><var class="var">program</var> Copyright (C) <var class="var">year</var> <var class="var">name of author</var>
This program comes with ABSOLUTELY NO WARRANTY; for details type &lsquo;<samp class="samp">show w</samp>&rsquo;.
This is free software, and you are welcome to redistribute it
under certain conditions; type &lsquo;<samp class="samp">show c</samp>&rsquo; for details.
</pre></div>
<p>The hypothetical commands &lsquo;<samp class="samp">show w</samp>&rsquo; and &lsquo;<samp class="samp">show c</samp>&rsquo; should show
the appropriate parts of the General Public License. Of course, your
program&rsquo;s commands might be different; for a GUI interface, you would
use an &ldquo;about box&rdquo;.
</p>
<p>You should also get your employer (if you work as a programmer) or school,
if any, to sign a &ldquo;copyright disclaimer&rdquo; for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<a class="url" href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.
</p>
<p>The GNU General Public License does not permit incorporating your
program into proprietary programs. If your program is a subroutine
library, you may consider it more useful to permit linking proprietary
applications with the library. If this is what you want to do, use
the GNU Lesser General Public License instead of this License. But
first, please read <a class="url" href="https://www.gnu.org/licenses/why-not-lgpl.html">https://www.gnu.org/licenses/why-not-lgpl.html</a>.
</p>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Index.html">Index</a>, Previous: <a href="Known-Bugs.html">Known Bugs</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>

86
dot-local/share/doc/stow/manual-split/Ignore-Lists.html
View file

@ -1,86 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Ignore Lists (Stow)</title>
<meta name="description" content="Ignore Lists (Stow)">
<meta name="keywords" content="Ignore Lists (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Installing-Packages.html" rel="next" title="Installing Packages">
<link href="Invoking-Stow.html" rel="prev" title="Invoking Stow">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Ignore-Lists">
<div class="nav-panel">
<p>
Next: <a href="Installing-Packages.html" accesskey="n" rel="next">Installing Packages</a>, Previous: <a href="Invoking-Stow.html" accesskey="p" rel="prev">Invoking Stow</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Ignore-Lists-1"><span>4 Ignore Lists<a class="copiable-link" href="#Ignore-Lists-1"> &para;</a></span></h2>
<a class="index-entry-id" id="index-ignore-lists"></a>
<a class="index-entry-id" id="index-ignoring-files-and-directories"></a>
<ul class="mini-toc">
<li><a href="Motivation-For-Ignore-Lists.html" accesskey="1">Motivation For Ignore Lists</a></li>
<li><a href="Types-And-Syntax-Of-Ignore-Lists.html" accesskey="2">Types And Syntax Of Ignore Lists</a></li>
<li><a href="Justification-For-Yet-Another-Set-Of-Ignore-Files.html" accesskey="3">Justification For Yet Another Set Of Ignore Files</a></li>
</ul>
</div>
</body>
</html>

187
dot-local/share/doc/stow/manual-split/Installing-Packages.html
View file

@ -1,187 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Installing Packages (Stow)</title>
<meta name="description" content="Installing Packages (Stow)">
<meta name="keywords" content="Installing Packages (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Deleting-Packages.html" rel="next" title="Deleting Packages">
<link href="Ignore-Lists.html" rel="prev" title="Ignore Lists">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Installing-Packages">
<div class="nav-panel">
<p>
Next: <a href="Deleting-Packages.html" accesskey="n" rel="next">Deleting Packages</a>, Previous: <a href="Ignore-Lists.html" accesskey="p" rel="prev">Ignore Lists</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Installing-Packages-1"><span>5 Installing Packages<a class="copiable-link" href="#Installing-Packages-1"> &para;</a></span></h2>
<a class="index-entry-id" id="index-installation"></a>
<p>The default action of Stow is to install a package. This means creating
symlinks in the target tree that point into the package tree. Stow
attempts to do this with as few symlinks as possible; in other words, if
Stow can create a single symlink that points to an entire subtree within
the package tree, it will choose to do that rather than create a
directory in the target tree and populate it with symlinks.
</p>
<a class="anchor" id="tree-folding"></a><ul class="mini-toc">
<li><a href="#Tree-folding" accesskey="1">Tree folding</a></li>
<li><a href="#Tree-unfolding-1" accesskey="2">Tree unfolding</a></li>
<li><a href="#Ownership" accesskey="3">Ownership</a></li>
<li><a href="#Conflicts-during-installation" accesskey="4">Conflicts during installation</a></li>
</ul>
<div class="section-level-extent" id="Tree-folding">
<h3 class="section"><span>5.1 Tree folding<a class="copiable-link" href="#Tree-folding"> &para;</a></span></h3>
<a class="index-entry-id" id="index-tree-folding"></a>
<a class="index-entry-id" id="index-directory-folding"></a>
<a class="index-entry-id" id="index-folding-trees"></a>
<p>For example, suppose that no packages have yet been installed in
<samp class="file">/usr/local</samp>; it&rsquo;s completely empty (except for the <samp class="file">stow</samp>
subdirectory, of course). Now suppose the Perl package is installed.
Recall that it includes the following directories in its installation
image: <samp class="file">bin</samp>; <samp class="file">info</samp>; <samp class="file">lib/perl</samp>; <samp class="file">man/man1</samp>.
Rather than creating the directory <samp class="file">/usr/local/bin</samp> and populating
it with symlinks to <samp class="file">../stow/perl/bin/perl</samp> and
<samp class="file">../stow/perl/bin/a2p</samp> (and so on), Stow will create a
single symlink, <samp class="file">/usr/local/bin</samp>, which points to
<samp class="file">stow/perl/bin</samp>. In this way, it still works to refer to
<samp class="file">/usr/local/bin/perl</samp> and <samp class="file">/usr/local/bin/a2p</samp>, and fewer
symlinks have been created. This is called <em class="dfn">tree folding</em>, since an
entire subtree is &ldquo;folded&rdquo; into a single symlink.
</p>
<p>To complete this example, Stow will also create the symlink
<samp class="file">/usr/local/info</samp> pointing to <samp class="file">stow/perl/info</samp>; the symlink
<samp class="file">/usr/local/lib</samp> pointing to <samp class="file">stow/perl/lib</samp>; and the symlink
<samp class="file">/usr/local/man</samp> pointing to <samp class="file">stow/perl/man</samp>.
</p>
<p>Now suppose that instead of installing the Perl package into an empty
target tree, the target tree is not empty to begin with. Instead, it
contains several files and directories installed under a different
system-administration philosophy. In particular, <samp class="file">/usr/local/bin</samp>
already exists and is a directory, as are <samp class="file">/usr/local/lib</samp> and
<samp class="file">/usr/local/man/man1</samp>. In this case, Stow will descend into
<samp class="file">/usr/local/bin</samp> and create symlinks to
<samp class="file">../stow/perl/bin/perl</samp> and <samp class="file">../stow/perl/bin/a2p</samp> (etc.),
and it will descend into <samp class="file">/usr/local/lib</samp> and create the
tree-folding symlink <samp class="file">perl</samp> pointing to
<samp class="file">../stow/perl/lib/perl</samp>, and so on. As a rule, Stow only
descends as far as necessary into the target tree when it can create a
tree-folding symlink. However, this behaviour can be changed via
the <samp class="option">--no-folding</samp> option; see <a class="pxref" href="Invoking-Stow.html">Invoking Stow</a>.
</p>
<a class="anchor" id="Tree-unfolding"></a></div>
<div class="section-level-extent" id="Tree-unfolding-1">
<h3 class="section"><span>5.2 Tree unfolding<a class="copiable-link" href="#Tree-unfolding-1"> &para;</a></span></h3>
<a class="index-entry-id" id="index-splitting-open-folded-trees"></a>
<a class="index-entry-id" id="index-unfolding-trees"></a>
<a class="index-entry-id" id="index-tree-unfolding"></a>
<a class="index-entry-id" id="index-tree-unsplitting"></a>
<p>The time often comes when a tree-folding symlink has to be undone
because another package uses one or more of the folded subdirectories in
its installation image. This operation is called <em class="dfn">splitting open</em> or
<em class="dfn">unfolding</em> a folded tree. It involves removing the original symlink from
the target tree, creating a true directory in its place, and then populating the
new directory with symlinks to the newly-installed package <em class="emph">and</em> to
the old package that used the old symlink. For example, suppose that
after installing Perl into an empty <samp class="file">/usr/local</samp>, we wish to
install Emacs. Emacs&rsquo;s installation image includes a <samp class="file">bin</samp>
directory containing the <samp class="file">emacs</samp> and <samp class="file">etags</samp> executables,
among others. Stow must make these files appear to be installed
in <samp class="file">/usr/local/bin</samp>, but presently <samp class="file">/usr/local/bin</samp> is a
symlink to <samp class="file">stow/perl/bin</samp>. Stow therefore takes the
following steps: the symlink <samp class="file">/usr/local/bin</samp> is deleted; the
directory <samp class="file">/usr/local/bin</samp> is created; links are made from
<samp class="file">/usr/local/bin</samp> to <samp class="file">../stow/emacs/bin/emacs</samp> and
<samp class="file">../stow/emacs/bin/etags</samp>; and links are made from
<samp class="file">/usr/local/bin</samp> to <samp class="file">../stow/perl/bin/perl</samp> and
<samp class="file">../stow/perl/bin/a2p</samp>.
</p>
</div>
<div class="section-level-extent" id="Ownership">
<h3 class="section"><span>5.3 Ownership<a class="copiable-link" href="#Ownership"> &para;</a></span></h3>
<a class="index-entry-id" id="index-ownership"></a>
<p>When splitting open a folded tree, Stow makes sure that the
symlink it is about to remove points inside a valid package in the
current stow directory. <em class="emph">Stow will never delete anything
that it doesn&rsquo;t own</em>. Stow &ldquo;owns&rdquo; everything living in the
target tree that points into a package in the stow directory. Anything
Stow owns, it can recompute if lost: symlinks that point into a package in
the stow directory, or directories that only contain symlinks that stow
&ldquo;owns&rdquo;. Note that by this definition, Stow doesn&rsquo;t &ldquo;own&rdquo; anything
<em class="emph">in</em> the stow directory or in any of the packages.
</p>
</div>
<div class="section-level-extent" id="Conflicts-during-installation">
<h3 class="section"><span>5.4 Conflicts during installation<a class="copiable-link" href="#Conflicts-during-installation"> &para;</a></span></h3>
<a class="index-entry-id" id="index-conflicts"></a>
<a class="index-entry-id" id="index-installation-conflicts"></a>
<p>If Stow needs to create a directory or a symlink in the target
tree and it cannot because that name is already in use and is not owned
by Stow, then a <em class="dfn">conflict</em> has arisen. See <a class="xref" href="Conflicts.html">Conflicts</a>.
</p>
</div>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Deleting-Packages.html">Deleting Packages</a>, Previous: <a href="Ignore-Lists.html">Ignore Lists</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>

170
dot-local/share/doc/stow/manual-split/Introduction.html
View file

@ -1,170 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Introduction (Stow)</title>
<meta name="description" content="Introduction (Stow)">
<meta name="keywords" content="Introduction (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Terminology.html" rel="next" title="Terminology">
<link href="index.html" rel="prev" title="Top">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Introduction">
<div class="nav-panel">
<p>
Next: <a href="Terminology.html" accesskey="n" rel="next">Terminology</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Introduction-1"><span>1 Introduction<a class="copiable-link" href="#Introduction-1"> &para;</a></span></h2>
<p>GNU Stow is a symlink farm manager 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.
</p>
<p>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
<samp class="file">/usr/local</samp>. When one does so, one winds up with the following
files<a class="footnote" id="DOCF1" href="#FOOT1"><sup>1</sup></a> in
<samp class="file">/usr/local/man/man1</samp>:
</p>
<div class="example">
<pre class="example-preformatted">a2p.1
ctags.1
emacs.1
etags.1
h2ph.1
perl.1
s2p.1
</pre></div>
<p>Now suppose it&rsquo;s time to uninstall Perl. Which man pages
get removed? Obviously <samp class="file">perl.1</samp> is one of them, but it should not
be the administrator&rsquo;s responsibility to memorize the ownership of
individual files by separate packages.
</p>
<p>The approach used by Stow is to install each package into its own
tree, then use symbolic links to make it appear as though the files are
installed in the common tree. Administration can be performed in the
package&rsquo;s private tree in isolation from clutter from other packages.
Stow can then be used to update the symbolic links. The structure
of each private tree should reflect the desired structure in the common
tree; i.e. (in the typical case) there should be a <samp class="file">bin</samp> directory
containing executables, a <samp class="file">man/man1</samp> directory containing section 1
man pages, and so on.
</p>
<p>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
<a class="uref" href="https://en.wikipedia.org/wiki/Rpm_(software)"><code class="command">rpm</code></a>,
<a class="uref" href="https://en.wikipedia.org/wiki/Dpkg"><code class="command">dpkg</code></a>, and
<a class="uref" href="https://en.wikipedia.org/wiki/Nix_package_manager">Nix</a> /
<a class="uref" href="https://en.wikipedia.org/wiki/GNU_Guix">GNU Guix</a>, or
language-native package managers such as
<a class="uref" href="https://en.wikipedia.org/wiki/RubyGems">Ruby&rsquo;s <code class="command">gem</code></a>,
<a class="uref" href="https://en.wikipedia.org/wiki/Pip_(package_manager)">Python&rsquo;s
<code class="command">pip</code></a>, <a class="uref" href="https://en.wikipedia.org/wiki/Npm_(software)">Javascript&rsquo;s <code class="command">npm</code></a>, and so on.
</p>
<p>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&rsquo;s home
directory<a class="footnote" id="DOCF2" href="#FOOT2"><sup>2</sup></a>,
especially when coupled with version control
systems<a class="footnote" id="DOCF3" href="#FOOT3"><sup>3</sup></a>.
</p>
<p>Stow was inspired by Carnegie Mellon&rsquo;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&rsquo;s no danger (as there was in Depot) of mangling directories
when file hierarchies don&rsquo;t match the database. Also unlike Depot,
Stow will never delete any files, directories, or links that appear in
a Stow directory (e.g., <samp class="file">/usr/local/stow/emacs</samp>), so it&rsquo;s always
possible to rebuild the target tree (e.g., <samp class="file">/usr/local</samp>).
</p>
<p>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.
</p>
<p>For information about the latest version of Stow, you can refer to
<a class="uref" href="http://www.gnu.org/software/stow/">http://www.gnu.org/software/stow/</a>.
</p>
</div>
<div class="footnotes-segment">
<hr>
<h4 class="footnotes-heading">Footnotes</h4>
<h5 class="footnote-body-heading"><a id="FOOT1" href="#DOCF1">(1)</a></h5>
<p>As of Perl 4.036 and Emacs 19.22. These are now
ancient releases but the example still holds valid.</p>
<h5 class="footnote-body-heading"><a id="FOOT2" href="#DOCF2">(2)</a></h5>
<p><a class="uref" href="http://brandon.invergo.net/news/2012-05-26-using-gnu-stow-to-manage-your-dotfiles.html">http://brandon.invergo.net/news/2012-05-26-using-gnu-stow-to-manage-your-dotfiles.html</a></p>
<h5 class="footnote-body-heading"><a id="FOOT3" href="#DOCF3">(3)</a></h5>
<p><a class="uref" href="http://lists.gnu.org/archive/html/info-stow/2011-12/msg00000.html">http://lists.gnu.org/archive/html/info-stow/2011-12/msg00000.html</a></p>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Terminology.html">Terminology</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>

290
dot-local/share/doc/stow/manual-split/Invoking-Stow.html
View file

@ -1,290 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Invoking Stow (Stow)</title>
<meta name="description" content="Invoking Stow (Stow)">
<meta name="keywords" content="Invoking Stow (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Ignore-Lists.html" rel="next" title="Ignore Lists">
<link href="Terminology.html" rel="prev" title="Terminology">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Invoking-Stow">
<div class="nav-panel">
<p>
Next: <a href="Ignore-Lists.html" accesskey="n" rel="next">Ignore Lists</a>, Previous: <a href="Terminology.html" accesskey="p" rel="prev">Terminology</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Invoking-Stow-1"><span>3 Invoking Stow<a class="copiable-link" href="#Invoking-Stow-1"> &para;</a></span></h2>
<p>The syntax of the <code class="command">stow</code> command is:
</p>
<div class="example">
<pre class="example-preformatted">stow [<var class="var">options</var>] [<var class="var">action flag</var>] <var class="var">package ...</var>
</pre></div>
<p>Each <var class="var">package</var> is the name of a package (e.g., &lsquo;<samp class="samp">perl</samp>&rsquo;) in the stow
directory that we wish to install into (or delete from) the target directory.
The default action is to install the given packages, although alternate actions
may be specified by preceding the package name(s) with an <var class="var">action flag</var>.
</p>
<p>The following options are supported:
</p>
<dl class="table">
<dt>&lsquo;<samp class="samp">-d <var class="var">dir</var></samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--dir=<var class="var">dir</var></samp>&rsquo;</dt>
<dd><p>Set the stow directory to <var class="var">dir</var>. Defaults to the value of the environment
variable <code class="env">STOW_DIR</code> if set, or the current directory otherwise.
</p>
</dd>
<dt>&lsquo;<samp class="samp">-t <var class="var">dir</var></samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--target=<var class="var">dir</var></samp>&rsquo;</dt>
<dd><p>Set the target directory to <var class="var">dir</var> instead of the parent of the stow
directory. Defaults to the parent of the stow directory, so it is typical to
execute <code class="command">stow</code> from the directory <samp class="file">/usr/local/stow</samp>.
</p>
</dd>
<dt>&lsquo;<samp class="samp">--ignore=<var class="var">regexp</var></samp>&rsquo;</dt>
<dd><p>This (repeatable) option lets you suppress acting on files that match the
given Perl regular expression. For example, using the options
</p>
<div class="example">
<pre class="example-preformatted">--ignore='.*\.orig' --ignore='.*\.dist'
</pre></div>
<p>will cause stow to ignore files ending in <samp class="file">.orig</samp> or <samp class="file">.dist</samp>.
</p>
<p>Note that the regular expression is anchored to the end of the filename,
because this is what you will want to do most of the time.
</p>
<p>Also note that by default Stow automatically ignores a &ldquo;sensible&rdquo;
built-in list of files and directories such as <samp class="file">CVS</samp>, editor
backup files, and so on. See <a class="xref" href="Ignore-Lists.html">Ignore Lists</a>, for more details.
</p>
</dd>
<dt>&lsquo;<samp class="samp">--defer=<var class="var">regexp</var></samp>&rsquo;</dt>
<dd><p>This (repeatable) option avoids stowing a file matching the given
regular expression, if that file is already stowed by another package.
This is effectively the opposite of <samp class="option">--override</samp>.
</p>
<p>(N.B. the name <samp class="option">--defer</samp> was chosen in the sense that the package
currently being stowed is treated with lower precedence than any
already installed package, not in the sense that the operation is
being postponed to be run at a later point in time; do not confuse
this nomenclature with the wording used in <a class="ref" href="Conflicts.html#Deferred-Operation">Deferred Operation</a>.)
</p>
<p>For example, the following options
</p>
<div class="example">
<pre class="example-preformatted">--defer=man --defer=info
</pre></div>
<p>will cause stow to skip over pre-existing man and info pages.
</p>
<p>Equivalently, you could use &lsquo;<samp class="samp">--defer='man|info'</samp>&rsquo; since the
argument is just a Perl regular expression.
</p>
<p>Note that the regular expression is anchored to the beginning of the path
relative to the target directory, because this is what you will want to do most
of the time.
</p>
</dd>
<dt>&lsquo;<samp class="samp">--override=<var class="var">regexp</var></samp>&rsquo;</dt>
<dd><p>This (repeatable) option forces any file matching the regular expression to be
stowed, even if the file is already stowed to another package. For example,
the following options
</p>
<div class="example">
<pre class="example-preformatted">--override=man --override=info
</pre></div>
<p>will permit stow to overwrite links that point to pre-existing man and info
pages that are owned by stow and would otherwise cause a conflict.
</p>
<p>The regular expression is anchored to the beginning of the path relative to
the target directory, because this is what you will want to do most of the time.
</p>
</dd>
<dt><a id="index-dotfiles"></a><span>&lsquo;<samp class="samp">--dotfiles</samp>&rsquo;<a class="copiable-link" href="#index-dotfiles"> &para;</a></span></dt>
<dd>
<p>Enable special handling for <em class="emph">dotfiles</em> (files or folders whose
name begins with a period) in the package directory. If this option is
enabled, Stow will add a preprocessing step for each file or folder
whose name begins with &lsquo;<samp class="samp">dot-</samp>&rsquo;, and replace the &lsquo;<samp class="samp">dot-</samp>&rsquo; prefix
in the name by a period &lsquo;<samp class="samp">.</samp>&rsquo;. This is useful when Stow is used to
manage collections of dotfiles, to avoid having a package directory
full of hidden files.
</p>
<p>For example, suppose we have a package containing two files,
<samp class="file">stow/dot-bashrc</samp> and <samp class="file">stow/dot-emacs.d/init.el</samp>. With this
option, Stow will create symlinks from <samp class="file">.bashrc</samp> to
<samp class="file">stow/dot-bashrc</samp> and from <samp class="file">.emacs.d/init.el</samp> to
<samp class="file">stow/dot-emacs.d/init.el</samp>. Any other files, whose name does not
begin with &lsquo;<samp class="samp">dot-</samp>&rsquo;, will be processed as usual.
</p>
</dd>
<dt>&lsquo;<samp class="samp">--no-folding</samp>&rsquo;</dt>
<dd>
<p>This disables any further tree folding (see <a class="pxref" href="Installing-Packages.html#tree-folding">tree folding</a>) or
refolding (see <a class="pxref" href="Deleting-Packages.html#tree-refolding">tree refolding</a>). If a new subdirectory is
encountered whilst stowing a new package, the subdirectory is created
within the target, and its contents are symlinked, rather than just
creating a symlink for the directory. If removal of symlinks whilst
unstowing a package causes a subtree to be foldable (i.e. only
containing symlinks to a single package), that subtree will not be
removed and replaced with a symlink.
</p>
</dd>
<dt><a id="index-adopting-existing-files"></a><span>&lsquo;<samp class="samp">--adopt</samp>&rsquo;<a class="copiable-link" href="#index-adopting-existing-files"> &para;</a></span></dt>
<dd><p><strong class="strong">Warning!</strong> This behaviour is specifically intended to alter the
contents of your stow directory. If you do not want that, this option
is not for you.
</p>
<p>When stowing, if a target is encountered which already exists but is a
plain file (and hence not owned by any existing stow package), then
normally Stow will register this as a conflict and refuse to proceed.
This option changes that behaviour so that the file is moved to the
same relative place within the package&rsquo;s installation image within the
stow directory, and then stowing proceeds as before. So effectively,
the file becomes adopted by the stow package, without its contents
changing.
</p>
<p>This is particularly useful when the stow package is under the control
of a version control system, because it allows files in the target
tree, with potentially different contents to the equivalent versions
in the stow package&rsquo;s installation image, to be adopted into the
package, then compared by running something like &lsquo;<samp class="samp">git diff ...</samp>&rsquo;
inside the stow package, and finally either kept (e.g. via &lsquo;<samp class="samp">git
commit ...</samp>&rsquo;) or discarded (&lsquo;<samp class="samp">git checkout HEAD ...</samp>&rsquo;).
</p>
</dd>
<dt><a class="index-entry-id" id="index-simulated-run"></a>
<a id="index-dry-run"></a><span>&lsquo;<samp class="samp">-n</samp>&rsquo;<a class="copiable-link" href="#index-dry-run"> &para;</a></span></dt>
<dt>&lsquo;<samp class="samp">--no</samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--simulate</samp>&rsquo;</dt>
<dd><p>Do not perform any operations that modify the file system; in combination with
<samp class="option">-v</samp> can be used to merely show what would happen.
</p>
</dd>
<dt><a id="index-verbosity-levels"></a><span>&lsquo;<samp class="samp">-v</samp>&rsquo;<a class="copiable-link" href="#index-verbosity-levels"> &para;</a></span></dt>
<dt>&lsquo;<samp class="samp">--verbose[=<var class="var">n</var>]</samp>&rsquo;</dt>
<dd><p>Send verbose output to standard error describing what Stow is
doing. Verbosity levels are from 0 to 5; 0 is the default. Using
<samp class="option">-v</samp> or <samp class="option">--verbose</samp> increases the verbosity by one; using
&lsquo;<samp class="samp">--verbose=<var class="var">n</var></samp>&rsquo; sets it to <var class="var">n</var>.
</p>
</dd>
<dt>&lsquo;<samp class="samp">-p</samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--compat</samp>&rsquo;</dt>
<dd><p>Scan the whole target tree when unstowing. By default, only
directories specified in the <em class="dfn">installation image</em> are scanned
during an unstow operation. Scanning the whole tree can be
prohibitive if your target tree is very large. This option restores
the legacy behaviour; however, the <samp class="option">--badlinks</samp> option to the
<code class="command">chkstow</code> utility may be a better way of ensuring that your
installation does not have any dangling symlinks (see <a class="pxref" href="Target-Maintenance.html">Target Maintenance</a>).
</p>
</dd>
<dt>&lsquo;<samp class="samp">-V</samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--version</samp>&rsquo;</dt>
<dd><p>Show Stow version number, and exit.
</p>
</dd>
<dt>&lsquo;<samp class="samp">-h</samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--help</samp>&rsquo;</dt>
<dd><p>Show Stow command syntax, and exit.
</p></dd>
</dl>
<p>The following <var class="var">action flags</var> are supported:
</p>
<dl class="table">
<dt>&lsquo;<samp class="samp">-D</samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--delete</samp>&rsquo;</dt>
<dd><p>Delete (unstow) the package name(s) that follow this option from the <em class="dfn">target
directory</em>. This option may be repeated any number of times.
</p>
</dd>
<dt>&lsquo;<samp class="samp">-R</samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--restow</samp>&rsquo;</dt>
<dd><p>Restow (first unstow, then stow again) the package names that follow this
option. This is useful for pruning obsolete symlinks from the target tree
after updating the software in a package. This option may be repeated any
number of times.
</p>
</dd>
<dt>&lsquo;<samp class="samp">-S</samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--stow</samp>&rsquo;</dt>
<dd><p>explictly stow the package name(s) that follow this option. May be
omitted if you are not using the <samp class="option">-D</samp> or <samp class="option">-R</samp> options in the
same invocation. See <a class="xref" href="Mixing-Operations.html">Mixing Operations</a>, for details of when you
might like to use this feature. This option may be repeated any number
of times.
</p></dd>
</dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Ignore-Lists.html">Ignore Lists</a>, Previous: <a href="Terminology.html">Terminology</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>

101
dot-local/share/doc/stow/manual-split/Justification-For-Yet-Another-Set-Of-Ignore-Files.html
View file

@ -1,101 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Justification For Yet Another Set Of Ignore Files (Stow)</title>
<meta name="description" content="Justification For Yet Another Set Of Ignore Files (Stow)">
<meta name="keywords" content="Justification For Yet Another Set Of Ignore Files (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Ignore-Lists.html" rel="up" title="Ignore Lists">
<link href="Types-And-Syntax-Of-Ignore-Lists.html" rel="prev" title="Types And Syntax Of Ignore Lists">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="section-level-extent" id="Justification-For-Yet-Another-Set-Of-Ignore-Files">
<div class="nav-panel">
<p>
Previous: <a href="Types-And-Syntax-Of-Ignore-Lists.html" accesskey="p" rel="prev">Types And Syntax Of Ignore Lists</a>, Up: <a href="Ignore-Lists.html" accesskey="u" rel="up">Ignore Lists</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="Justification-For-Yet-Another-Set-Of-Ignore-Files-1"><span>4.3 Justification For Yet Another Set Of Ignore Files<a class="copiable-link" href="#Justification-For-Yet-Another-Set-Of-Ignore-Files-1"> &para;</a></span></h3>
<p>The reader may note that this format is very similar to existing
ignore list file formats, such as those for <code class="command">cvs</code>, <code class="command">git</code>,
<code class="command">rsync</code> etc., and wonder if another set of ignore lists is
justified. However there are good reasons why Stow does not simply
check for the presence of say, <samp class="file">.cvsignore</samp>, and use that if it
exists. Firstly, there is no guarantee that a stow package would
contain any version control meta-data, or permit introducing this if
it didn&rsquo;t already exist.
</p>
<p>Secondly even if it did, version control system ignore lists generally
reflect <em class="emph">build-time</em> ignores rather than <em class="emph">install-time</em>, and
there may be some intermediate or temporary files on those ignore
lists generated during development or at build-time which it would be
inappropriate to stow, even though many files generated at build-time
(binaries, libraries, documentation etc.) certainly do need to be
stowed. Similarly, if a file is <em class="emph">not</em> in the version control
system&rsquo;s ignore list, there is no way of knowing whether the file is
intended for end use, let alone whether the version control system is
tracking it or not.
</p>
<p>Therefore it seems clear that ignore lists provided by version control
systems do not provide sufficient information for Stow to determine
which files and directories to stow, and so it makes sense for Stow to
support independent ignore lists.
</p>
</div>
</body>
</html>

81
dot-local/share/doc/stow/manual-split/Known-Bugs.html
View file

@ -1,81 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Known Bugs (Stow)</title>
<meta name="description" content="Known Bugs (Stow)">
<meta name="keywords" content="Known Bugs (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="GNU-General-Public-License.html" rel="next" title="GNU General Public License">
<link href="Reporting-Bugs.html" rel="prev" title="Reporting Bugs">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Known-Bugs">
<div class="nav-panel">
<p>
Next: <a href="GNU-General-Public-License.html" accesskey="n" rel="next">GNU General Public License</a>, Previous: <a href="Reporting-Bugs.html" accesskey="p" rel="prev">Reporting Bugs</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Known-Bugs-1"><span>15 Known Bugs<a class="copiable-link" href="#Known-Bugs-1"> &para;</a></span></h2>
<p>There are no known bugs in Stow version 2.3.2-fixbug56727!
If you think you have found one, please see <a class="pxref" href="Reporting-Bugs.html">Reporting Bugs</a>.
</p>
</div>
</body>
</html>

104
dot-local/share/doc/stow/manual-split/Mixing-Operations.html
View file

@ -1,104 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Mixing Operations (Stow)</title>
<meta name="description" content="Mixing Operations (Stow)">
<meta name="keywords" content="Mixing Operations (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Multiple-Stow-Directories.html" rel="next" title="Multiple Stow Directories">
<link href="Conflicts.html" rel="prev" title="Conflicts">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Mixing-Operations">
<div class="nav-panel">
<p>
Next: <a href="Multiple-Stow-Directories.html" accesskey="n" rel="next">Multiple Stow Directories</a>, Previous: <a href="Conflicts.html" accesskey="p" rel="prev">Conflicts</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Mixing-Operations-1"><span>8 Mixing Operations<a class="copiable-link" href="#Mixing-Operations-1"> &para;</a></span></h2>
<a class="index-entry-id" id="index-mixing-operations"></a>
<p>Since version 2.0, multiple distinct actions can be specified in a single
invocation of GNU Stow. For example, to update an installation of Emacs from
version 21.3 to 21.4a you can now do the following:
</p>
<div class="example">
<pre class="example-preformatted">stow -D emacs-21.3 -S emacs-21.4a
</pre></div>
<p>which will replace emacs-21.3 with emacs-21.4a using a single invocation.
</p>
<a class="index-entry-id" id="index-deferred-operation-1"></a>
<p>This is much faster and cleaner than performing two separate
invocations of stow, because redundant folding/unfolding operations
can be factored out. In addition, all the operations are calculated
and merged before being executed (see <a class="pxref" href="Conflicts.html#Deferred-Operation">Deferred Operation</a>), so the
amount of of time in which GNU Emacs is unavailable is minimised.
</p>
<p>You can mix and match any number of actions, for example,
</p>
<div class="example">
<pre class="example-preformatted">stow -S pkg1 pkg2 -D pkg3 pkg4 -S pkg5 -R pkg6
</pre></div>
<p>will unstow pkg3, pkg4 and pkg6, then stow pkg1, pkg2, pkg5 and pkg6.
</p>
</div>
</body>
</html>

102
dot-local/share/doc/stow/manual-split/Motivation-For-Ignore-Lists.html
View file

@ -1,102 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Motivation For Ignore Lists (Stow)</title>
<meta name="description" content="Motivation For Ignore Lists (Stow)">
<meta name="keywords" content="Motivation For Ignore Lists (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Ignore-Lists.html" rel="up" title="Ignore Lists">
<link href="Types-And-Syntax-Of-Ignore-Lists.html" rel="next" title="Types And Syntax Of Ignore Lists">
<link href="Ignore-Lists.html" rel="prev" title="Ignore Lists">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="section-level-extent" id="Motivation-For-Ignore-Lists">
<div class="nav-panel">
<p>
Next: <a href="Types-And-Syntax-Of-Ignore-Lists.html" accesskey="n" rel="next">Types And Syntax Of Ignore Lists</a>, Previous: <a href="Ignore-Lists.html" accesskey="p" rel="prev">Ignore Lists</a>, Up: <a href="Ignore-Lists.html" accesskey="u" rel="up">Ignore Lists</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="Motivation-For-Ignore-Lists-1"><span>4.1 Motivation For Ignore Lists<a class="copiable-link" href="#Motivation-For-Ignore-Lists-1"> &para;</a></span></h3>
<p>In many situations, there will exist files under the package
directories which it would be undesirable to stow into the target
directory. For example, files related version control such as
<samp class="file">.gitignore</samp>, <samp class="file">CVS</samp>, <samp class="file">*,v</samp> (RCS files) should typically
not have symlinks from the target tree pointing to them. Also there
may be files or directories relating to the build of the package which
are not needed at run-time.
</p>
<p>In these cases, it can be rather cumbersome to specify a
<samp class="option">--ignore</samp> parameter for each file or directory to be ignored.
This could be worked around by ensuring the existence of
<samp class="file">~/.stowrc</samp> containing multiple <samp class="option">--ignore</samp> lines, or if a
different set of files/directories should be ignored depending on
which stow package is involved, a <samp class="file">.stowrc</samp> file for each stow
package, but this would require the user to ensure that they were in
the correct directory before invoking stow, which would be tedious and
error-prone. Furthermore, since Stow shifts parameters from
<samp class="file">.stowrc</samp> onto ARGV at run-time, it could clutter up the process
table with excessively long parameter lists, or even worse, exceed the
operating system&rsquo;s limit for process arguments.
</p>
<a class="index-entry-id" id="index-ignore-lists-1"></a>
<p>Therefore in addition to <samp class="option">--ignore</samp> parameters, Stow provides a
way to specify lists of files and directories to ignore.
</p>
</div>
</body>
</html>

94
dot-local/share/doc/stow/manual-split/Multiple-Stow-Directories.html
View file

@ -1,94 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Multiple Stow Directories (Stow)</title>
<meta name="description" content="Multiple Stow Directories (Stow)">
<meta name="keywords" content="Multiple Stow Directories (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Target-Maintenance.html" rel="next" title="Target Maintenance">
<link href="Mixing-Operations.html" rel="prev" title="Mixing Operations">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Multiple-Stow-Directories">
<div class="nav-panel">
<p>
Next: <a href="Target-Maintenance.html" accesskey="n" rel="next">Target Maintenance</a>, Previous: <a href="Mixing-Operations.html" accesskey="p" rel="prev">Mixing Operations</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Multiple-Stow-Directories-1"><span>9 Multiple Stow Directories<a class="copiable-link" href="#Multiple-Stow-Directories-1"> &para;</a></span></h2>
<p>If there are two or more system administrators who wish to maintain
software separately, or if there is any other reason to want two or more
stow directories, it can be done by creating a file named <samp class="file">.stow</samp>
in each stow directory. The presence of <samp class="file">/usr/local/foo/.stow</samp>
informs Stow that, though <samp class="file">foo</samp> is not the current stow
directory, even if it is a subdirectory of the target directory,
nevertheless it is <em class="emph">a</em> stow directory and as such Stow
doesn&rsquo;t &ldquo;own&rdquo; anything in it (see <a class="pxref" href="Installing-Packages.html">Installing Packages</a>). This will
protect the contents of <samp class="file">foo</samp> from a &lsquo;<samp class="samp">stow -D</samp>&rsquo;, for instance.
</p>
<p>When multiple stow directories share a target tree, if a tree-folding
symlink is encountered and needs to be split open during an
installation, as long as the top-level stow directory into which the
existing symlink points contains <samp class="file">.stow</samp>, Stow knows how to split
open the tree in the correct manner.
</p>
</div>
</body>
</html>

95
dot-local/share/doc/stow/manual-split/Other-FSF-Software.html
View file

@ -1,95 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Other FSF Software (Stow)</title>
<meta name="description" content="Other FSF Software (Stow)">
<meta name="keywords" content="Other FSF Software (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Compile_002dtime-vs-Install_002dtime.html" rel="up" title="Compile-time vs Install-time">
<link href="Cygnus-Software.html" rel="next" title="Cygnus Software">
<link href="GNU-Emacs.html" rel="prev" title="GNU Emacs">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="section-level-extent" id="Other-FSF-Software">
<div class="nav-panel">
<p>
Next: <a href="Cygnus-Software.html" accesskey="n" rel="next">Cygnus Software</a>, Previous: <a href="GNU-Emacs.html" accesskey="p" rel="prev">GNU Emacs</a>, Up: <a href="Compile_002dtime-vs-Install_002dtime.html" accesskey="u" rel="up">Compile-time vs Install-time</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="Other-FSF-Software-1"><span>12.3 Other FSF Software<a class="copiable-link" href="#Other-FSF-Software-1"> &para;</a></span></h3>
<p>The Free Software Foundation, the organization behind the GNU project,
has been unifying the build procedure for its tools for some time.
Thanks to its tools &lsquo;<samp class="samp">autoconf</samp>&rsquo; and &lsquo;<samp class="samp">automake</samp>&rsquo;, most packages
now respond well to these simple steps, with no other intervention
necessary:
</p>
<div class="example">
<pre class="example-preformatted">./configure <var class="var">options</var>
make
make install prefix=/usr/local/stow/<var class="var">package</var>
</pre></div>
<p>Hopefully, these tools can evolve to be aware of Stow-managed packages,
such that providing an option to &lsquo;<samp class="samp">configure</samp>&rsquo; can allow &lsquo;<samp class="samp">make</samp>&rsquo;
and &lsquo;<samp class="samp">make install</samp>&rsquo; steps to work correctly without needing to
&ldquo;fool&rdquo; the build process.
</p>
</div>
</body>
</html>

178
dot-local/share/doc/stow/manual-split/Perl-and-Perl-5-Modules.html
View file

@ -1,178 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Perl and Perl 5 Modules (Stow)</title>
<meta name="description" content="Perl and Perl 5 Modules (Stow)">
<meta name="keywords" content="Perl and Perl 5 Modules (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Compile_002dtime-vs-Install_002dtime.html" rel="up" title="Compile-time vs Install-time">
<link href="Cygnus-Software.html" rel="prev" title="Cygnus Software">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span.r {font-family: initial; font-weight: normal; font-style: normal}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="section-level-extent" id="Perl-and-Perl-5-Modules">
<div class="nav-panel">
<p>
Previous: <a href="Cygnus-Software.html" accesskey="p" rel="prev">Cygnus Software</a>, Up: <a href="Compile_002dtime-vs-Install_002dtime.html" accesskey="u" rel="up">Compile-time vs Install-time</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="Perl-and-Perl-5-Modules-1"><span>12.5 Perl and Perl 5 Modules<a class="copiable-link" href="#Perl-and-Perl-5-Modules-1"> &para;</a></span></h3>
<p>Perl 4.036 allows you to specify different locations for installation
and for run-time. It is the only widely-used package in this author&rsquo;s
experience that allows this, though hopefully more packages will adopt
this model.
</p>
<p>Unfortunately, the authors of Perl believed that only AFS sites need
this ability. The configuration instructions for Perl 4 misleadingly
state that some occult means are used under AFS to transport files from
their installation tree to their run-time tree. In fact, that confusion
arises from the fact that Depot, Stow&rsquo;s predecessor, originated at
Carnegie Mellon University, which was also the birthplace of AFS. CMU&rsquo;s
need to separate install-time and run-time trees stemmed from its use of
Depot, not from AFS.
</p>
<p>The result of this confusion is that Perl 5&rsquo;s configuration script
doesn&rsquo;t even offer the option of separating install-time and run-time
trees <em class="emph">unless</em> you&rsquo;re running AFS. Fortunately, after you&rsquo;ve
entered all the configuration settings, Perl&rsquo;s setup script gives you
the opportunity to edit those settings in a file called
<samp class="file">config.sh</samp>. When prompted, you should edit this file and replace
occurrences of
</p>
<div class="example">
<pre class="example-preformatted">inst<span class="r">...</span>/usr/local<span class="r">...</span>
</pre></div>
<p>with
</p>
<div class="example">
<pre class="example-preformatted">inst<span class="r">...</span>/usr/local/stow/perl<span class="r">...</span>
</pre></div>
<p>You can do this with the following Unix command:
</p>
<div class="example">
<pre class="example-preformatted">sed 's,^\(inst.*/usr/local\),\1/stow/perl,' config.sh &gt; config.sh.new
mv config.sh.new config.sh
</pre></div>
<p>Hopefully, the Perl authors will correct this deficiency in Perl 5&rsquo;s
configuration mechanism.
</p>
<p>Perl 5 modules&mdash;i.e., extensions to Perl 5&mdash;generally conform to a set
of standards for building and installing them. The standard says that
the package comes with a top-level <samp class="file">Makefile.PL</samp>, which is a Perl
script. When it runs, it generates a <samp class="file">Makefile</samp>.
</p>
<p>If you followed the instructions above for editing <samp class="file">config.sh</samp> when
Perl was built, then when you create a <samp class="file">Makefile</samp> from a
<samp class="file">Makefile.PL</samp>, it will contain separate locations for run-time
(<samp class="file">/usr/local</samp>) and install-time (<samp class="file">/usr/local/stow/perl</samp>).
Thus you can do
</p>
<div class="example">
<pre class="example-preformatted">perl Makefile.PL
make
make install
</pre></div>
<p>and the files will be installed into <samp class="file">/usr/local/stow/perl</samp>.
However, you might prefer each Perl module to be stowed separately. In
that case, you must edit the resulting Makefile, replacing
<samp class="file">/usr/local/stow/perl</samp> with <samp class="file">/usr/local/stow/<var class="var">module</var></samp>.
The best way to do this is:
</p>
<div class="example">
<pre class="example-preformatted">perl Makefile.PL
find . -name Makefile -print | \
xargs perl -pi~ -e 's,^(INST.*/stow)/perl,$1/<var class="var">module</var>,;'
make
make install
</pre></div>
<p>(The use of &lsquo;<samp class="samp">find</samp>&rsquo; and &lsquo;<samp class="samp">xargs</samp>&rsquo; ensures that all Makefiles in
the module&rsquo;s source tree, even those in subdirectories, get edited.) A
good convention to follow is to name the stow directory for a Perl
<var class="var">module</var> <samp class="file">cpan.<var class="var">module</var></samp>, where &lsquo;<samp class="samp">cpan</samp>&rsquo; stands for
Comprehensive Perl Archive Network, a collection of FTP sites that is
the source of most Perl 5 extensions. This way, it&rsquo;s easy to tell at a
glance which of the subdirectories of <samp class="file">/usr/local/stow</samp> are Perl 5
extensions.
</p>
<p>When you stow separate Perl 5 modules separately, you are likely to
encounter conflicts (see <a class="pxref" href="Conflicts.html">Conflicts</a>) with files named <samp class="file">.exists</samp>
and <samp class="file">perllocal.pod</samp>. One way to work around this is to remove
those files before stowing the module. If you use the
<samp class="file">cpan.<var class="var">module</var></samp> naming convention, you can simply do this:
</p>
<div class="example">
<pre class="example-preformatted">cd /usr/local/stow
find cpan.* \( -name .exists -o -name perllocal.pod \) -print | \
xargs rm
</pre></div>
</div>
<hr>
<div class="nav-panel">
<p>
Previous: <a href="Cygnus-Software.html">Cygnus Software</a>, Up: <a href="Compile_002dtime-vs-Install_002dtime.html">Compile-time vs Install-time</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>

107
dot-local/share/doc/stow/manual-split/Reporting-Bugs.html
View file

@ -1,107 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Reporting Bugs (Stow)</title>
<meta name="description" content="Reporting Bugs (Stow)">
<meta name="keywords" content="Reporting Bugs (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Known-Bugs.html" rel="next" title="Known Bugs">
<link href="Bootstrapping.html" rel="prev" title="Bootstrapping">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
ul.mark-bullet {list-style-type: disc}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Reporting-Bugs">
<div class="nav-panel">
<p>
Next: <a href="Known-Bugs.html" accesskey="n" rel="next">Known Bugs</a>, Previous: <a href="Bootstrapping.html" accesskey="p" rel="prev">Bootstrapping</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Reporting-Bugs-1"><span>14 Reporting Bugs<a class="copiable-link" href="#Reporting-Bugs-1"> &para;</a></span></h2>
<p>Please send bug reports to the current maintainers by electronic
mail. The address to use is &lsquo;<samp class="samp">&lt;bug-stow@gnu.org&gt;</samp>&rsquo;. Please
include:
</p>
<ul class="itemize mark-bullet">
<li>the version number of Stow (&lsquo;<samp class="samp">stow --version</samp>&rsquo;);
</li><li>the version number of Perl (&lsquo;<samp class="samp">perl -v</samp>&rsquo;);
</li><li>the system information, which can often be obtained with &lsquo;<samp class="samp">uname
-a</samp>&rsquo;;
</li><li>a description of the bug;
</li><li>the precise command you gave;
</li><li>the output from the command (preferably verbose output, obtained by
adding &lsquo;<samp class="samp">--verbose=3</samp>&rsquo; to the Stow command line).
</li></ul>
<p>If you are really keen, consider developing a minimal test case and
creating a new test. See the <samp class="file">t/</samp> directory in the source for
lots of examples.
</p>
<p>Before reporting a bug, please read the manual carefully, especially
<a class="ref" href="Known-Bugs.html">Known Bugs</a>, to see whether you&rsquo;re encountering
something that doesn&rsquo;t need reporting.
(see <a class="pxref" href="Conflicts.html">Conflicts</a>).
</p>
</div>
</body>
</html>

146
dot-local/share/doc/stow/manual-split/Resource-Files.html
View file

@ -1,146 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Resource Files (Stow)</title>
<meta name="description" content="Resource Files (Stow)">
<meta name="keywords" content="Resource Files (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Compile_002dtime-vs-Install_002dtime.html" rel="next" title="Compile-time vs Install-time">
<link href="Target-Maintenance.html" rel="prev" title="Target Maintenance">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Resource-Files">
<div class="nav-panel">
<p>
Next: <a href="Compile_002dtime-vs-Install_002dtime.html" accesskey="n" rel="next">Compile-time vs Install-time</a>, Previous: <a href="Target-Maintenance.html" accesskey="p" rel="prev">Target Maintenance</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Resource-Files-1"><span>11 Resource Files<a class="copiable-link" href="#Resource-Files-1"> &para;</a></span></h2>
<a class="index-entry-id" id="index-resource-files"></a>
<a class="index-entry-id" id="index-configuration-files"></a>
<p>Default command line options may be set in <samp class="file">.stowrc</samp> (current
directory) or <samp class="file">~/.stowrc</samp> (home directory). These are parsed in
that order, and are appended together if they both exist. The effect of
the options in the resource file is similar to simply prepending the
options to the command line. This feature can be used for some
interesting effects.
</p>
<p>For example, suppose your site uses more than one stow directory, perhaps in
order to share around responsibilities with a number of systems
administrators. One of the administrators might have the following in their
<samp class="file">~/.stowrc</samp> file:
</p>
<div class="example">
<pre class="example-preformatted">--dir=/usr/local/stow2
--target=/usr/local
--ignore='~'
--ignore='^CVS'
</pre></div>
<p>so that the <code class="command">stow</code> command will default to operating on the
<samp class="file">/usr/local/stow2</samp> directory, with <samp class="file">/usr/local</samp> as the
target, and ignoring vi backup files and CVS directories.
</p>
<p>If you had a stow directory <samp class="file">/usr/local/stow/perl-extras</samp> that
was only used for Perl modules, then you might place the following in
<samp class="file">/usr/local/stow/perl-extras/.stowrc</samp>:
</p>
<div class="example">
<pre class="example-preformatted">--dir=/usr/local/stow/perl-extras
--target=/usr/local
--override=bin
--override=man
--ignore='perllocal\.pod'
--ignore='\.packlist'
--ignore='\.bs'
</pre></div>
<p>so that when you are in the <samp class="file">/usr/local/stow/perl-extras</samp>
directory, <code class="command">stow</code> will regard any subdirectories as stow
packages, with <samp class="file">/usr/local</samp> as the target (rather than the
immediate parent directory <samp class="file">/usr/local/stow</samp>), overriding any
pre-existing links to bin files or man pages, and ignoring some cruft
that gets installed by default.
</p>
<p>If an option is provided both on the command line and in a resource file,
the command line option takes precedence. For options that provide a single
value, such as <code class="command">--target</code> or <code class="command">--dir</code>, the command line
option will overwrite any options in the resource file. For options that can
be given more than once, <code class="command">--ignore</code> for example, command line
options and resource options are appended together.
</p>
<p>For options that take a file path, environment variables and the tilde
character (<code class="command">~</code>) are expanded. An environment variable can be
given in either the <code class="command">$VAR</code> or <code class="command">${VAR}</code> form. To
prevent expansion, escape the <code class="command">$</code> or <code class="command">~</code> with a
backslash.
</p>
<p>The options <code class="command">-D</code>, <code class="command">-S</code>, and <code class="command">-R</code> are ignored in
resource files. This is also true of any package names given in the
resource file.
</p>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Compile_002dtime-vs-Install_002dtime.html">Compile-time vs Install-time</a>, Previous: <a href="Target-Maintenance.html">Target Maintenance</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>

122
dot-local/share/doc/stow/manual-split/Target-Maintenance.html
View file

@ -1,122 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Target Maintenance (Stow)</title>
<meta name="description" content="Target Maintenance (Stow)">
<meta name="keywords" content="Target Maintenance (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Resource-Files.html" rel="next" title="Resource Files">
<link href="Multiple-Stow-Directories.html" rel="prev" title="Multiple Stow Directories">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Target-Maintenance">
<div class="nav-panel">
<p>
Next: <a href="Resource-Files.html" accesskey="n" rel="next">Resource Files</a>, Previous: <a href="Multiple-Stow-Directories.html" accesskey="p" rel="prev">Multiple Stow Directories</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Target-Maintenance-1"><span>10 Target Maintenance<a class="copiable-link" href="#Target-Maintenance-1"> &para;</a></span></h2>
<a class="index-entry-id" id="index-maintenance"></a>
<p>From time to time you will need to clean up your target tree. Since
version 2, Stow provides a new utility <code class="command">chkstow</code> to help with
this. It includes three operational modes which performs checks that
would generally be too expensive to be performed during normal stow
execution.
</p>
<p>The syntax of the <code class="command">chkstow</code> command is:
</p>
<div class="example">
<pre class="example-preformatted">chkstow [<var class="var">options</var>]
</pre></div>
<p>The following options are supported:
</p>
<dl class="table">
<dt>&lsquo;<samp class="samp">-t <var class="var">dir</var></samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--target=<var class="var">dir</var></samp>&rsquo;</dt>
<dd><p>Set the target directory to <var class="var">dir</var> instead of the parent of the stow
directory. Defaults to the parent of the stow directory, so it is typical to
execute <code class="command">stow</code> from the directory <samp class="file">/usr/local/stow</samp>.
</p>
</dd>
<dt>&lsquo;<samp class="samp">-b</samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--badlinks</samp>&rsquo;</dt>
<dd><p>Checks target directory for bogus symbolic links. That is, links that point to
non-existent files.
</p>
</dd>
<dt>&lsquo;<samp class="samp">-a</samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--aliens</samp>&rsquo;</dt>
<dd><p>Checks for files in the target directory that are not symbolic links. The
target directory should be managed by stow alone, except for directories that
contain a <samp class="file">.stow</samp> file.
</p>
</dd>
<dt>&lsquo;<samp class="samp">-l</samp>&rsquo;</dt>
<dt>&lsquo;<samp class="samp">--list</samp>&rsquo;</dt>
<dd><p>Will display the target package for every symbolic link in the stow target
directory.
</p>
</dd>
</dl>
</div>
</body>
</html>

135
dot-local/share/doc/stow/manual-split/Terminology.html
View file

@ -1,135 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Terminology (Stow)</title>
<meta name="description" content="Terminology (Stow)">
<meta name="keywords" content="Terminology (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Invoking-Stow.html" rel="next" title="Invoking Stow">
<link href="Introduction.html" rel="prev" title="Introduction">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="chapter-level-extent" id="Terminology">
<div class="nav-panel">
<p>
Next: <a href="Invoking-Stow.html" accesskey="n" rel="next">Invoking Stow</a>, Previous: <a href="Introduction.html" accesskey="p" rel="prev">Introduction</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="chapter" id="Terminology-1"><span>2 Terminology<a class="copiable-link" href="#Terminology-1"> &para;</a></span></h2>
<a class="index-entry-id" id="index-package"></a>
<p>A <em class="dfn">package</em> is a related collection of files and directories that
you wish to administer as a unit &mdash; e.g., Perl or Emacs &mdash; and that needs
to be installed in a particular directory structure &mdash; e.g., with
<samp class="file">bin</samp>, <samp class="file">lib</samp>, and <samp class="file">man</samp> subdirectories.
</p>
<a class="index-entry-id" id="index-target-directory"></a>
<p>A <em class="dfn">target directory</em> is the root of a tree in which one or more
packages wish to <em class="emph">appear</em> to be installed. A common, but by no
means the only such location is <samp class="file">/usr/local</samp>. The examples in this
manual will use <samp class="file">/usr/local</samp> as the target directory.
</p>
<a class="index-entry-id" id="index-stow-directory"></a>
<p>A <em class="dfn">stow directory</em> is the root of a tree containing separate
packages in private subtrees. When Stow runs, it uses the current
directory as the default stow directory. The examples in this manual
will use <samp class="file">/usr/local/stow</samp> as the stow directory, so that
individual packages will be, for example, <samp class="file">/usr/local/stow/perl</samp>
and <samp class="file">/usr/local/stow/emacs</samp>.
</p>
<a class="index-entry-id" id="index-installation-image"></a>
<p>An <em class="dfn">installation image</em> is the layout of files and directories
required by a package, relative to the target directory. Thus, the
installation image for Perl includes: a <samp class="file">bin</samp> directory containing
<samp class="file">perl</samp> and <samp class="file">a2p</samp> (among others); an <samp class="file">info</samp> directory
containing Texinfo documentation; a <samp class="file">lib/perl</samp> directory containing
Perl libraries; and a <samp class="file">man/man1</samp> directory containing man pages.
</p>
<a class="index-entry-id" id="index-package-directory"></a>
<a class="index-entry-id" id="index-package-name"></a>
<p>A <em class="dfn">package directory</em> is the root of a tree containing the
installation image for a particular package. Each package directory
must reside in a stow directory &mdash; e.g., the package directory
<samp class="file">/usr/local/stow/perl</samp> must reside in the stow directory
<samp class="file">/usr/local/stow</samp>. The <em class="dfn">name</em> of a package is the name of its
directory within the stow directory &mdash; e.g., <samp class="file">perl</samp>.
</p>
<p>Thus, the Perl executable might reside in
<samp class="file">/usr/local/stow/perl/bin/perl</samp>, where <samp class="file">/usr/local</samp> is the
target directory, <samp class="file">/usr/local/stow</samp> is the stow directory,
<samp class="file">/usr/local/stow/perl</samp> is the package directory, and
<samp class="file">bin/perl</samp> within is part of the installation image.
</p>
<a class="index-entry-id" id="index-symlink"></a>
<a class="index-entry-id" id="index-relative-symlink"></a>
<a class="index-entry-id" id="index-absolute-symlink"></a>
<p>A <em class="dfn">symlink</em> is a symbolic link. A symlink can be <em class="dfn">relative</em> or
<em class="dfn">absolute</em>. An absolute symlink names a full path; that is, one
starting from <samp class="file">/</samp>. A relative symlink names a relative path; that
is, one not starting from <samp class="file">/</samp>. The target of a relative symlink is
computed starting from the symlink&rsquo;s own directory. Stow only
creates relative symlinks.
</p>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Invoking-Stow.html">Invoking Stow</a>, Previous: <a href="Introduction.html">Introduction</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>

55
dot-local/share/doc/stow/manual-split/Tree-unfolding.html
View file

@ -1,55 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<!-- This file redirects to the location of a node or anchor -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Tree unfolding (Stow)</title>
<meta name="description" content="Tree unfolding (Stow)">
<meta name="keywords" content="Tree unfolding (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Refresh" content="0; url=Installing-Packages.html#Tree-unfolding">
<meta name="viewport" content="width=device-width,initial-scale=1">
</head>
<body lang="en">
<p>The node you are looking for is at <a href="Installing-Packages.html#Tree-unfolding">Tree unfolding</a>.</p>
</body>

182
dot-local/share/doc/stow/manual-split/Types-And-Syntax-Of-Ignore-Lists.html
View file

@ -1,182 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Types And Syntax Of Ignore Lists (Stow)</title>
<meta name="description" content="Types And Syntax Of Ignore Lists (Stow)">
<meta name="keywords" content="Types And Syntax Of Ignore Lists (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Ignore-Lists.html" rel="up" title="Ignore Lists">
<link href="Justification-For-Yet-Another-Set-Of-Ignore-Files.html" rel="next" title="Justification For Yet Another Set Of Ignore Files">
<link href="Motivation-For-Ignore-Lists.html" rel="prev" title="Motivation For Ignore Lists">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="section-level-extent" id="Types-And-Syntax-Of-Ignore-Lists">
<div class="nav-panel">
<p>
Next: <a href="Justification-For-Yet-Another-Set-Of-Ignore-Files.html" accesskey="n" rel="next">Justification For Yet Another Set Of Ignore Files</a>, Previous: <a href="Motivation-For-Ignore-Lists.html" accesskey="p" rel="prev">Motivation For Ignore Lists</a>, Up: <a href="Ignore-Lists.html" accesskey="u" rel="up">Ignore Lists</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="Types-And-Syntax-Of-Ignore-Lists-1"><span>4.2 Types And Syntax Of Ignore Lists<a class="copiable-link" href="#Types-And-Syntax-Of-Ignore-Lists-1"> &para;</a></span></h3>
<p>If you put Perl regular expressions, one per line, in a
<samp class="file">.stow-local-ignore</samp> file within any top level package directory,
in which case any file or directory within that package matching any
of these regular expressions will be ignored. In the absence of this
package-specific ignore list, Stow will instead use the contents of
<samp class="file">~/.stow-global-ignore</samp>, if it exists. If neither the
package-local or global ignore list exist, Stow will use its own
built-in default ignore list, which serves as a useful example of the
format of these ignore list files:
</p>
<div class="example">
<pre class="verbatim"># Comments and blank lines are allowed.
RCS
.+,v
CVS
\.\#.+ # CVS conflict files / emacs lock files
\.cvsignore
\.svn
_darcs
\.hg
\.git
\.gitignore
.+~ # emacs backup files
\#.*\# # emacs autosave files
^/README.*
^/LICENSE.*
^/COPYING
</pre></div>
<p>Stow first iterates through the chosen ignore list (built-in, global,
or package-local) as per above, stripping out comments (if you want to
include the &lsquo;<samp class="samp">#</samp>&rsquo; symbol in a regular expression, escape it with a
blackslash) and blank lines, placing each regular expressions into one
of two sets depending on whether it contains the &lsquo;<samp class="samp">/</samp>&rsquo; forward
slash symbol.
</p>
<p>Then in order to determine whether a file or directory should be
ignored:
</p>
<ol class="enumerate">
<li> Stow calculates its path relative to the top-level package directory,
prefixing that with &lsquo;<samp class="samp">/</samp>&rsquo;. If any of the regular expressions
containing a &lsquo;<samp class="samp">/</samp>&rsquo; <em class="emph">exactly</em><a class="footnote" id="DOCF4" href="#FOOT4"><sup>4</sup></a> match
a subpath<a class="footnote" id="DOCF5" href="#FOOT5"><sup>5</sup></a> of this relative path, then the file or
directory will be ignored.
</li><li> If none of the regular expressions containing a &lsquo;<samp class="samp">/</samp>&rsquo; match in the
manner described above, Stow checks whether the
<em class="emph">basename</em><a class="footnote" id="DOCF6" href="#FOOT6"><sup>6</sup></a> of the file or directory matches
<em class="emph">exactly</em> against the remaining regular expressions which do not
contain a &lsquo;<samp class="samp">/</samp>&rsquo;, and if so, ignores the file or directory.
</li><li> Otherwise, the file or directory is not ignored.
</li></ol>
<p>For example, if a file <samp class="file">bazqux</samp> is in the <samp class="file">foo/bar</samp>
subdirectory of the package directory, Stow would use
&lsquo;<samp class="samp">/foo/bar/bazqux</samp>&rsquo; as the text for matching against regular
expressions which contain &lsquo;<samp class="samp">/</samp>&rsquo;, and &lsquo;<samp class="samp">bazqux</samp>&rsquo; as the text for
matching against regular expressions which don&rsquo;t contain &lsquo;<samp class="samp">/</samp>&rsquo;.
Then regular expressions &lsquo;<samp class="samp">bazqux</samp>&rsquo;, &lsquo;<samp class="samp">baz.*</samp>&rsquo;, &lsquo;<samp class="samp">.*qux</samp>&rsquo;,
&lsquo;<samp class="samp">bar/.*x</samp>&rsquo;, and &lsquo;<samp class="samp">^/foo/.*qux</samp>&rsquo; would all match (causing the
file to be ignored), whereas &lsquo;<samp class="samp">bar</samp>&rsquo;, &lsquo;<samp class="samp">baz</samp>&rsquo;, &lsquo;<samp class="samp">qux</samp>&rsquo;, and
&lsquo;<samp class="samp">o/bar/b</samp>&rsquo; would not (although &lsquo;<samp class="samp">bar</samp>&rsquo; would cause its parent
directory to be ignored and prevent Stow from recursing into that
anyway, in which case the file <samp class="file">bazqux</samp> would not even be
considered for stowing).
</p>
<p>As a special exception to the above algorithm, any
<samp class="file">.stow-local-ignore</samp> present in the top-level package directory
is <em class="emph">always</em> ignored, regardless of the contents of any ignore
list, because this file serves no purpose outside the stow directory.
</p>
</div>
<div class="footnotes-segment">
<hr>
<h4 class="footnotes-heading">Footnotes</h4>
<h5 class="footnote-body-heading"><a id="FOOT4" href="#DOCF4">(4)</a></h5>
<p>Exact matching means the
regular expression is anchored at the beginning and end, in contrast
to unanchored regular expressions which will match a substring.</p>
<h5 class="footnote-body-heading"><a id="FOOT5" href="#DOCF5">(5)</a></h5>
<p>In this context, &ldquo;subpath&rdquo; means a contiguous
subset of path segments; e.g for the relative path
<samp class="file">one/two/three</samp>, there are six valid subpaths: <samp class="file">one</samp>,
<samp class="file">two</samp>, <samp class="file">three</samp>, <samp class="file">one/two</samp>, <samp class="file">two/three</samp>,
<samp class="file">one/two/three</samp>.</p>
<h5 class="footnote-body-heading"><a id="FOOT6" href="#DOCF6">(6)</a></h5>
<p>The &ldquo;basename&rdquo; is the name of the file or
directory itself, excluding any directory path prefix - as returned by
the <code class="command">basename</code> command.</p>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Justification-For-Yet-Another-Set-Of-Ignore-Files.html">Justification For Yet Another Set Of Ignore Files</a>, Previous: <a href="Motivation-For-Ignore-Lists.html">Motivation For Ignore Lists</a>, Up: <a href="Ignore-Lists.html">Ignore Lists</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>

211
dot-local/share/doc/stow/manual-split/index.html
View file

@ -1,211 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>Index (Stow)</title>
<meta name="description" content="Index (Stow)">
<meta name="keywords" content="Index (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="#Index" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="GNU-General-Public-License.html" rel="prev" title="GNU General Public License">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
a.summary-letter-printindex {text-decoration: none}
span:hover a.copiable-link {visibility: visible}
td.printindex-index-entry {vertical-align: top}
td.printindex-index-section {vertical-align: top; padding-left: 1em}
th.entries-header-printindex {text-align:left}
th.sections-header-printindex {text-align:left; padding-left: 1em}
-->
</style>
</head>
<body lang="en">
<div class="unnumbered-level-extent" id="Index">
<div class="nav-panel">
<p>
Previous: <a href="GNU-General-Public-License.html" accesskey="p" rel="prev">GNU General Public License</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h2 class="unnumbered" id="Index-1"><span>Index<a class="copiable-link" href="#Index-1"> &para;</a></span></h2>
<div class="printindex cp-printindex">
<table class="cp-letters-header-printindex"><tr><th>Jump to: &nbsp; </th><td><a class="summary-letter-printindex" href="#Index_cp_letter-A"><b>A</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-C"><b>C</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-D"><b>D</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-F"><b>F</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-I"><b>I</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-M"><b>M</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-O"><b>O</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-P"><b>P</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-R"><b>R</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-S"><b>S</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-T"><b>T</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-U"><b>U</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-V"><b>V</b></a>
&nbsp;
</td></tr></table>
<table class="cp-entries-printindex" border="0">
<tr><td></td><th class="entries-header-printindex">Index Entry</th><th class="sections-header-printindex">Section</th></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-A">A</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Terminology.html#index-absolute-symlink">absolute symlink</a></td><td class="printindex-index-section"><a href="Terminology.html">Terminology</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Invoking-Stow.html#index-adopting-existing-files">adopting existing files</a></td><td class="printindex-index-section"><a href="Invoking-Stow.html">Invoking Stow</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-C">C</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Resource-Files.html#index-configuration-files">configuration files</a></td><td class="printindex-index-section"><a href="Resource-Files.html">Resource Files</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Installing-Packages.html#index-conflicts">conflicts</a></td><td class="printindex-index-section"><a href="Installing-Packages.html">Installing Packages</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Conflicts.html#index-conflicts-1">conflicts</a></td><td class="printindex-index-section"><a href="Conflicts.html">Conflicts</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-D">D</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Conflicts.html#index-deferred-operation">deferred operation</a></td><td class="printindex-index-section"><a href="Conflicts.html">Conflicts</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Mixing-Operations.html#index-deferred-operation-1">deferred operation</a></td><td class="printindex-index-section"><a href="Mixing-Operations.html">Mixing Operations</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Deleting-Packages.html#index-deletion">deletion</a></td><td class="printindex-index-section"><a href="Deleting-Packages.html">Deleting Packages</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Installing-Packages.html#index-directory-folding">directory folding</a></td><td class="printindex-index-section"><a href="Installing-Packages.html">Installing Packages</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Invoking-Stow.html#index-dotfiles">dotfiles</a></td><td class="printindex-index-section"><a href="Invoking-Stow.html">Invoking Stow</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Invoking-Stow.html#index-dry-run">dry run</a></td><td class="printindex-index-section"><a href="Invoking-Stow.html">Invoking Stow</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-F">F</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Installing-Packages.html#index-folding-trees">folding trees</a></td><td class="printindex-index-section"><a href="Installing-Packages.html">Installing Packages</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-I">I</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Ignore-Lists.html#index-ignore-lists">ignore lists</a></td><td class="printindex-index-section"><a href="Ignore-Lists.html">Ignore Lists</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Motivation-For-Ignore-Lists.html#index-ignore-lists-1">ignore lists</a></td><td class="printindex-index-section"><a href="Motivation-For-Ignore-Lists.html">Motivation For Ignore Lists</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Ignore-Lists.html#index-ignoring-files-and-directories">ignoring files and directories</a></td><td class="printindex-index-section"><a href="Ignore-Lists.html">Ignore Lists</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Installing-Packages.html#index-installation">installation</a></td><td class="printindex-index-section"><a href="Installing-Packages.html">Installing Packages</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Installing-Packages.html#index-installation-conflicts">installation conflicts</a></td><td class="printindex-index-section"><a href="Installing-Packages.html">Installing Packages</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Terminology.html#index-installation-image">installation image</a></td><td class="printindex-index-section"><a href="Terminology.html">Terminology</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-M">M</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Target-Maintenance.html#index-maintenance">maintenance</a></td><td class="printindex-index-section"><a href="Target-Maintenance.html">Target Maintenance</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Mixing-Operations.html#index-mixing-operations">mixing operations</a></td><td class="printindex-index-section"><a href="Mixing-Operations.html">Mixing Operations</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-O">O</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Installing-Packages.html#index-ownership">ownership</a></td><td class="printindex-index-section"><a href="Installing-Packages.html">Installing Packages</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-P">P</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Terminology.html#index-package">package</a></td><td class="printindex-index-section"><a href="Terminology.html">Terminology</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Terminology.html#index-package-directory">package directory</a></td><td class="printindex-index-section"><a href="Terminology.html">Terminology</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Terminology.html#index-package-name">package name</a></td><td class="printindex-index-section"><a href="Terminology.html">Terminology</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-R">R</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Deleting-Packages.html#index-refolding-trees">refolding trees</a></td><td class="printindex-index-section"><a href="Deleting-Packages.html">Deleting Packages</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Terminology.html#index-relative-symlink">relative symlink</a></td><td class="printindex-index-section"><a href="Terminology.html">Terminology</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Resource-Files.html#index-resource-files">resource files</a></td><td class="printindex-index-section"><a href="Resource-Files.html">Resource Files</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-S">S</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Invoking-Stow.html#index-simulated-run">simulated run</a></td><td class="printindex-index-section"><a href="Invoking-Stow.html">Invoking Stow</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Installing-Packages.html#index-splitting-open-folded-trees">splitting open folded trees</a></td><td class="printindex-index-section"><a href="Installing-Packages.html">Installing Packages</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Terminology.html#index-stow-directory">stow directory</a></td><td class="printindex-index-section"><a href="Terminology.html">Terminology</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Terminology.html#index-symlink">symlink</a></td><td class="printindex-index-section"><a href="Terminology.html">Terminology</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-T">T</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Terminology.html#index-target-directory">target directory</a></td><td class="printindex-index-section"><a href="Terminology.html">Terminology</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Installing-Packages.html#index-tree-folding">tree folding</a></td><td class="printindex-index-section"><a href="Installing-Packages.html">Installing Packages</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Deleting-Packages.html#index-tree-refolding">tree refolding</a></td><td class="printindex-index-section"><a href="Deleting-Packages.html">Deleting Packages</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Installing-Packages.html#index-tree-unfolding">tree unfolding</a></td><td class="printindex-index-section"><a href="Installing-Packages.html">Installing Packages</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Installing-Packages.html#index-tree-unsplitting">tree unsplitting</a></td><td class="printindex-index-section"><a href="Installing-Packages.html">Installing Packages</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-U">U</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Installing-Packages.html#index-unfolding-trees">unfolding trees</a></td><td class="printindex-index-section"><a href="Installing-Packages.html">Installing Packages</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
<tr><th id="Index_cp_letter-V">V</th></tr>
<tr><td></td><td class="printindex-index-entry"><a href="Invoking-Stow.html#index-verbosity-levels">verbosity levels</a></td><td class="printindex-index-section"><a href="Invoking-Stow.html">Invoking Stow</a></td></tr>
<tr><td colspan="3"><hr></td></tr>
</table>
<table class="cp-letters-footer-printindex"><tr><th>Jump to: &nbsp; </th><td><a class="summary-letter-printindex" href="#Index_cp_letter-A"><b>A</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-C"><b>C</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-D"><b>D</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-F"><b>F</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-I"><b>I</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-M"><b>M</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-O"><b>O</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-P"><b>P</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-R"><b>R</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-S"><b>S</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-T"><b>T</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-U"><b>U</b></a>
&nbsp;
<a class="summary-letter-printindex" href="#Index_cp_letter-V"><b>V</b></a>
&nbsp;
</td></tr></table>
</div>
</div>
<hr>
<div class="nav-panel">
<p>
Previous: <a href="GNU-General-Public-License.html">GNU General Public License</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>

55
dot-local/share/doc/stow/manual-split/tree-folding.html
View file

@ -1,55 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<!-- This file redirects to the location of a node or anchor -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>tree folding (Stow)</title>
<meta name="description" content="tree folding (Stow)">
<meta name="keywords" content="tree folding (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Refresh" content="0; url=Installing-Packages.html#tree-folding">
<meta name="viewport" content="width=device-width,initial-scale=1">
</head>
<body lang="en">
<p>The node you are looking for is at <a href="Installing-Packages.html#tree-folding">tree folding</a>.</p>
</body>

55
dot-local/share/doc/stow/manual-split/tree-refolding.html
View file

@ -1,55 +0,0 @@
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<!-- This file redirects to the location of a node or anchor -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual describes GNU Stow version 2.3.2-fixbug56727
(23 October 2023), a program for managing farms of symbolic links.
Software and documentation is copyrighted by the following:
© 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
© 2000, 2001 Guillaume Morin <gmorin@gnu.org>
© 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
© 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled "GNU General Public License" is included with the
modified manual, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation. -->
<title>tree refolding (Stow)</title>
<meta name="description" content="tree refolding (Stow)">
<meta name="keywords" content="tree refolding (Stow)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Refresh" content="0; url=Deleting-Packages.html#tree-refolding">
<meta name="viewport" content="width=device-width,initial-scale=1">
</head>
<body lang="en">
<p>The node you are looking for is at <a href="Deleting-Packages.html#tree-refolding">tree refolding</a>.</p>
</body>

BIN
dot-local/share/doc/stow/manual.pdf
View file

Binary file not shown.

4
dot-local/share/doc/stow/version.texi
View file

@ -1,4 +0,0 @@
@set UPDATED 23 October 2023
@set UPDATED-MONTH October 2023
@set EDITION 2.3.2-fixbug56727
@set VERSION 2.3.2-fixbug56727

2008
dot-local/share/info/stow.info
View file

File diff suppressed because it is too large Load diff

21
dot-local/bin/chkstow → local/bin/chkstow
View file

@ -1,19 +1,4 @@
#!/usr/local/bin/perl
#
# This file is part of GNU Stow.
#
# GNU Stow is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# GNU Stow is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see https://www.gnu.org/licenses/.
#!/usr/bin/perl
use strict;
use warnings;
@ -23,7 +8,7 @@ require 5.006_001;
use File::Find;
use Getopt::Long;
my $DEFAULT_TARGET = $ENV{STOW_DIR} || '/usr/local/';
my $DEFAULT_TARGET = '/usr/local/';
our $Wanted = \&bad_links;
our %Package = ();
@ -108,7 +93,7 @@ sub aliens {
!-l && !-d && print "Unstowed file: $File::Find::name\n";
}
# just list the packages in the target directory
# just list the packages in the the target directory
# FIXME: what if the stow dir is not called 'stow'?
sub list {
if (-l) {

323
dot-local/bin/stow → local/bin/stow
View file

@ -1,29 +1,27 @@
#!/usr/local/bin/perl
#!/usr/bin/perl
# GNU Stow - manage farms of symbolic links
# GNU Stow - manage the installation of multiple software packages
# Copyright (C) 1993, 1994, 1995, 1996 by Bob Glickstein
# Copyright (C) 2000, 2001 Guillaume Morin
# Copyright (C) 2007 Kahlil Hodgson
# Copyright (C) 2011 Adam Spiers
#
# This file is part of GNU Stow.
#
# GNU Stow is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# GNU Stow is distributed in the hope that it will be useful, but
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see https://www.gnu.org/licenses/.
# along with this program; if not, see <http://www.gnu.org/licenses/>.
=head1 NAME
stow - manage farms of symbolic links
stow - software package installation manager
=head1 SYNOPSIS
@ -31,34 +29,33 @@ stow [ options ] package ...
=head1 DESCRIPTION
This manual page describes GNU Stow 2.3.2-fixbug56727. This is not the
definitive documentation for Stow; for that, see the accompanying info
manual, e.g. by typing C<info stow>.
This manual page describes GNU Stow 2.2.2, a program for managing
the installation of software packages. This is not the definitive
documentation for stow; for that, see the info manual.
Stow is a symlink farm manager 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.
Stow is a tool for managing the installation of multiple software
packages in the same run-time directory tree. One historical
difficulty of this task has been the need to administer, upgrade,
install, and remove files in independent packages without confusing
them with other files sharing the same filesystem space. For instance,
it is common to install Perl and Emacs in F</usr/local>. When one
does so, one winds up (as of Perl 4.036 and Emacs 19.22) with the
following files in F</usr/local/man/man1>: F<a2p.1>; F<ctags.1>;
F<emacs.1>; F<etags.1>; F<h2ph.1>; F<perl.1>; and F<s2p.1>. Now
suppose it's time to uninstall Perl. Which man pages get removed?
Obviously F<perl.1> is one of them, but it should not be the
administrator's responsibility to memorize the ownership of individual
files by separate packages.
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. By using Stow, F</usr/local/bin>
could contain symlinks to files within F</usr/local/stow/emacs/bin>,
F</usr/local/stow/perl/bin> etc., and likewise recursively for any
other subdirectories such as F<.../share>, F<.../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.
The approach used by Stow is to install each package into its own
tree, then use symbolic links to make it appear as though the files
are installed in the common tree. Administration can be performed in
the package's private tree in isolation from clutter from other
packages. Stow can then be used to update the symbolic links. The
structure of each private tree should reflect the desired structure in
the common tree; i.e. (in the typical case) there should be a F<bin>
directory containing executables, a F<man/man1> directory containing
section 1 man pages, and so on.
Stow was inspired by Carnegie Mellon's Depot program, but is
substantially simpler and safer. Whereas Depot required database files
@ -69,9 +66,6 @@ will never delete any files, directories, or links that appear in a
Stow directory (e.g., F</usr/local/stow/emacs>), so it's always
possible to rebuild the target tree (e.g., F</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.
=head1 TERMINOLOGY
A "package" is a related collection of files and directories that
@ -135,8 +129,6 @@ C<-D>).
=item --no
=item --simulate
Do not perform any operations that modify the filesystem; merely show
what would happen.
@ -160,7 +152,7 @@ directory.
=item --verbose[=N]
Send verbose output to standard error describing what Stow is
doing. Verbosity levels are from 0 to 5; 0 is the default.
doing. Verbosity levels are 0, 1, 2, 3, and 4; 0 is the default.
Using C<-v> or C<--verbose> increases the verbosity by one; using
`--verbose=N' sets it to N.
@ -222,22 +214,6 @@ stowed to another package.
Force stowing files beginning with this Perl regex if the file is
already stowed to another package.
=item --dotfiles
Enable special handling for "dotfiles" (files or folders whose name
begins with a period) in the package directory. If this option is
enabled, Stow will add a preprocessing step for each file or folder
whose name begins with "dot-", and replace the "dot-" prefix in the
name by a period (.). This is useful when Stow is used to manage
collections of dotfiles, to avoid having a package directory full of
hidden files.
For example, suppose we have a package containing two files,
F<stow/dot-bashrc> and F<stow/dot-emacs.d/init.el>. With this option,
Stow will create symlinks from F<.bashrc> to F<stow/dot-bashrc> and
from F<.emacs.d/init.el> to F<stow/dot-emacs.d/init.el>. Any other
files, whose name does not begin with "dot-", will be processed as usual.
=item -V
=item --version
@ -347,28 +323,6 @@ Stow will re-fold the tree by removing the symlinks to the surviving
package, removing the directory, then linking the directory back to
the surviving package.
=head1 RESOURCE FILES
F<Stow> searches for default command line options at F<.stowrc> (current
directory) and F<~/.stowrc> (home directory) in that order. If both
locations are present, the files are effectively appended together.
The effect of options in the resource file is similar to simply prepending
the options to the command line. For options that provide a single value,
such as F<--target> or F<--dir>, the command line option will overwrite any
options in the resource file. For options that can be given more than once,
F<--ignore> for example, command line options and resource options are
appended together.
Environment variables and the tilde character (F<~>) will be expanded for
options that take a file path.
The options F<-D>, F<-R>, F<-S>, and any packages listed in the resource
file are ignored.
See the info manual for more information on how stow handles resource
file.
=head1 SEE ALSO
The full documentation for F<stow> is maintained as a Texinfo manual.
@ -458,10 +412,11 @@ use warnings;
require 5.006_001;
use POSIX qw(getcwd);
use Getopt::Long qw(GetOptionsFromArray);
use Scalar::Util qw(reftype);
use Getopt::Long;
use FindBin; use lib "$FindBin::Bin/../lib/perl";
use Cwd qw(abs_path);
use File::Basename qw(dirname);
use lib dirname(dirname(abs_path($0))) . '/share/perl';
use Stow;
use Stow::Util qw(parent error);
@ -508,75 +463,27 @@ sub main {
#===== SUBROUTINE ===========================================================
# Name : process_options()
# Purpose : Parse and process command line and .stowrc file options
# Purpose : parse command line options
# Parameters: none
# Returns : (\%options, \@pkgs_to_unstow, \@pkgs_to_stow)
# Throws : a fatal error if a bad option is given
# Throws : a fatal error if a bad command line option is given
# Comments : checks @ARGV for valid package names
#============================================================================
sub process_options {
# Get cli options.
my ($cli_options,
$pkgs_to_unstow,
$pkgs_to_stow) = parse_options(@ARGV);
# Get the .stowrc options.
# Note that rc_pkgs_to_unstow and rc_pkgs_to_stow are ignored.
my ($rc_options,
$rc_pkgs_to_unstow,
$rc_pkgs_to_stow) = get_config_file_options();
# Merge .stowrc and command line options.
# Preference is given to cli options.
my %options = %$rc_options;
foreach my $option (keys %$cli_options) {
my $rc_value = $rc_options->{$option};
my $cli_value = $cli_options->{$option};
my $type = reftype($cli_value);
if (defined $type && $type eq 'ARRAY' && defined $rc_value) {
# rc options come first in merged arrays.
$options{$option} = [@{$rc_value}, @{$cli_value}];
} else {
# cli options overwrite conflicting rc options.
$options{$option} = $cli_value;
}
}
# Run checks on the merged options.
sanitize_path_options(\%options);
check_packages($pkgs_to_unstow, $pkgs_to_stow);
# Return merged and processed options.
return (\%options, $pkgs_to_unstow, $pkgs_to_stow);
}
#===== SUBROUTINE ===========================================================
# Name : parse_options()
# Purpose : parse command line options
# Parameters: @arg_array => array of options to parse
# Example: parse_options(@ARGV)
# Returns : (\%options, \@pkgs_to_unstow, \@pkgs_to_stow)
# Throws : a fatal error if a bad command line option is given
# Comments : Used for parsing both command line options and rc file. Used
# for parsing only. Sanity checks and post-processing belong in
# process_options().
#============================================================================
sub parse_options {
my %options = ();
my @pkgs_to_unstow = ();
my @pkgs_to_stow = ();
my $action = 'stow';
#$,="\n"; print @_,"\n"; # for debugging rc file
unshift @ARGV, get_config_file_options();
#$,="\n"; print @ARGV,"\n"; # for debugging rc file
Getopt::Long::config('no_ignore_case', 'bundling', 'permute');
GetOptionsFromArray(
\@_,
GetOptions(
\%options,
'verbose|v:+', 'help|h', 'simulate|n|no',
'version|V', 'compat|p', 'dir|d=s', 'target|t=s',
'adopt', 'no-folding', 'dotfiles',
'adopt', 'no-folding',
# clean and pre-compile any regex's at parse time
'ignore=s' =>
@ -618,27 +525,31 @@ sub parse_options {
push @pkgs_to_stow, $_[0];
}
},
) or usage('');
) or usage();
usage() if $options{help};
version() if $options{version};
sanitize_path_options(\%options);
check_packages(\@pkgs_to_unstow, \@pkgs_to_stow);
return (\%options, \@pkgs_to_unstow, \@pkgs_to_stow);
}
sub sanitize_path_options {
my ($options) = @_;
unless (exists $options->{dir}) {
$options->{dir} = length $ENV{STOW_DIR} ? $ENV{STOW_DIR} : getcwd();
if (exists $options->{dir}) {
$options->{dir} =~ s/\A +//;
$options->{dir} =~ s/ +\z//;
}
else {
$options->{dir} = exists $ENV{STOW_DIR} ? $ENV{STOW_DIR} : getcwd();
}
usage("--dir value '$options->{dir}' is not a valid directory")
unless -d $options->{dir};
if (exists $options->{target}) {
usage("--target value '$options->{target}' is not a valid directory")
unless -d $options->{target};
$options->{target} =~ s/\A +//;
$options->{target} =~ s/ +\z//;
}
else {
$options->{target} = parent($options->{dir}) || '.';
@ -661,25 +572,22 @@ sub check_packages {
}
}
#===== SUBROUTINE ============================================================
# Name : get_config_file_options()
# Purpose : search for default settings in any .stowrc files
# Parameters: none
# Returns : (\%rc_options, \@rc_pkgs_to_unstow, \@rc_pkgs_to_stow)
# Throws : a fatal error if a bad option is given
# Comments : Parses the contents of '~/.stowrc' and '.stowrc' with the same
# parser as the command line options. Additionally expands any
# environment variables or ~ character in --target or --dir
# options.
# Returns : a list of default options
# Throws : no exceptions
# Comments : prepends the contents of '~/.stowrc' and '.stowrc' to the command
# : line so they get parsed just like normal arguments. (This was
# : hacked in so that Emil and I could set different preferences).
#=============================================================================
sub get_config_file_options {
my @defaults = ();
my @dirlist = ('.stowrc');
if (defined($ENV{HOME})) {
unshift(@dirlist, "$ENV{HOME}/.stowrc");
}
for my $file (@dirlist) {
for my $file ("$ENV{HOME}/.stowrc", '.stowrc') {
if (-r $file) {
warn "Loading defaults from $file\n";
open my $FILE, '<', $file
or die "Could not open $file for reading\n";
while (my $line = <$FILE>){
@ -689,102 +597,9 @@ sub get_config_file_options {
close $FILE or die "Could not close open file: $file\n";
}
}
# Parse the options
my ($rc_options, $rc_pkgs_to_unstow, $rc_pkgs_to_stow) = parse_options(@defaults);
# Expand environment variables and glob characters.
if (exists $rc_options->{target}) {
$rc_options->{target} =
expand_filepath($rc_options->{target}, '--target option');
}
if (exists $rc_options->{dir}) {
$rc_options->{dir} =
expand_filepath($rc_options->{dir}, '--dir option');
}
return ($rc_options, $rc_pkgs_to_unstow, $rc_pkgs_to_stow);
return @defaults;
}
#===== SUBROUTINE ============================================================
# Name : expand_filepath()
# Purpose : Handles expansions that need to be applied to
# : file paths. Currently expands environment
# : variables and the tilde.
# Parameters: $path => string to perform expansion on.
# : $source => where the string came from
# Returns : String with replacements performed.
# Throws : n/a
# Comments : n/a
#=============================================================================
sub expand_filepath {
my ($path, $source) = @_;
$path = expand_environment($path, $source);
$path = expand_tilde($path);
return $path;
}
#===== SUBROUTINE ============================================================
# Name : expand_environment()
# Purpose : Expands evironment variables.
# Parameters: $path => string to perform expansion on.
# : $source => where the string came from
# Returns : String with replacements performed.
# Throws : n/a
# Comments : Variable replacement mostly based on SO answer
# : http://stackoverflow.com/a/24675093/558820
#=============================================================================
sub expand_environment {
my ($path, $source) = @_;
# Replace non-escaped $VAR and ${VAR} with $ENV{VAR}
# If $ENV{VAR} does not exist, perl will raise a warning
# and then happily treat it as an empty string.
$path =~ s/(?<!\\)\$\{((?:\w|\s)+)\}/
_safe_expand_env_var($1, $source)
/ge;
$path =~ s/(?<!\\)\$(\w+)/
_safe_expand_env_var($1, $source)
/ge;
# Remove \$ escapes.
$path =~ s/\\\$/\$/g;
return $path;
}
sub _safe_expand_env_var {
my ($var, $source) = @_;
unless (exists $ENV{$var}) {
die "$source references undefined environment variable \$$var; " .
"aborting!\n";
}
return $ENV{$var};
}
#===== SUBROUTINE ============================================================
# Name : expand_tilde()
# Purpose : Expands tilde to user's home directory path.
# Parameters: $path => string to perform expansion on.
# Returns : String with replacements performed.
# Throws : n/a
# Comments : http://docstore.mik.ua/orelly/perl4/cook/ch07_04.htm
#=============================================================================
sub expand_tilde {
my ($path) = @_;
# Replace tilde with home path.
$path =~ s{ ^ ~ ( [^/]* ) }
{ $1
? (getpwnam($1))[7]
: ( $ENV{HOME} || $ENV{LOGDIR}
|| (getpwuid($<))[7]
)
}ex;
# Replace espaced tilde with regular tilde.
$path =~ s/\\~/~/g;
return $path
}
#===== SUBROUTINE ===========================================================
# Name : usage()
# Purpose : print program usage message and exit
@ -797,7 +612,7 @@ sub usage {
my ($msg) = @_;
if ($msg) {
warn "$ProgramName: $msg\n\n";
print "$ProgramName: $msg\n\n";
}
print <<"EOT";
@ -823,12 +638,10 @@ OPTIONS:
if the file is already stowed to another package
--adopt (Use with care!) Import existing files into stow package
from target. Please read docs before using.
--dotfiles Enables special handling for dotfiles that are
Stow packages that start with "dot-" and not "."
-p, --compat Use legacy algorithm for unstowing
-n, --no, --simulate Do not actually make any filesystem changes
-v, --verbose[=N] Increase verbosity (levels are from 0 to 5;
-v, --verbose[=N] Increase verbosity (levels are 0,1,2,3;
-v or --verbose adds 1; --verbose=N sets level)
-V, --version Show stow version number
-h, --help Show this help

1980
local/share/doc/stow/ChangeLog Normal file
View file

File diff suppressed because it is too large Load diff

0
dot-local/share/doc/stow/ChangeLog.OLD → local/share/doc/stow/ChangeLog.OLD
View file

53
local/share/doc/stow/README Normal file
View file

@ -0,0 +1,53 @@
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).

2534
local/share/doc/stow/manual-single.html Normal file
View file

File diff suppressed because it is too large Load diff

89
local/share/doc/stow/manual-split/Bootstrapping.html Normal file
View file

@ -0,0 +1,89 @@
<html lang="en">
<head>
<title>Bootstrapping - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime" title="Compile-time vs Install-time">
<link rel="next" href="Reporting-Bugs.html#Reporting-Bugs" title="Reporting Bugs">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Bootstrapping"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Reporting-Bugs.html#Reporting-Bugs">Reporting Bugs</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime">Compile-time vs Install-time</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">13 Bootstrapping</h2>
<p>Suppose you have a stow directory all set up and ready to go:
<samp><span class="file">/usr/local/stow/perl</span></samp> contains the Perl installation,
<samp><span class="file">/usr/local/stow/stow</span></samp> contains Stow itself, and perhaps you have
other packages waiting to be stowed. You'd like to be able to do this:
<pre class="example"> cd /usr/local/stow
stow -vv *
</pre>
<p class="noindent">but <samp><span class="command">stow</span></samp> is not yet in your <samp><span class="env">PATH</span></samp>. Nor can you do this:
<pre class="example"> cd /usr/local/stow
stow/bin/stow -vv *
</pre>
<p class="noindent">because the &lsquo;<samp><span class="samp">#!</span></samp>&rsquo; line at the beginning of <samp><span class="command">stow</span></samp> tries to
locate Perl (usually in <samp><span class="file">/usr/local/bin/perl</span></samp>), and that won't be
found. The solution you must use is:
<pre class="example"> cd /usr/local/stow
perl/bin/perl stow/bin/stow -vv *
</pre>
<!-- =========================================================================== -->
</body></html>

144
local/share/doc/stow/manual-split/Compile_002dtime-vs-Install_002dtime.html Normal file
View file

@ -0,0 +1,144 @@
<html lang="en">
<head>
<title>Compile-time vs Install-time - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Resource-Files.html#Resource-Files" title="Resource Files">
<link rel="next" href="Bootstrapping.html#Bootstrapping" title="Bootstrapping">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Compile-time-vs-Install-time"></a>
<a name="Compile_002dtime-vs-Install_002dtime"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Bootstrapping.html#Bootstrapping">Bootstrapping</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Resource-Files.html#Resource-Files">Resource Files</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">12 Compile-time vs Install-time</h2>
<p>Software whose installation is managed with Stow needs to be installed
in one place (the package directory, e.g. <samp><span class="file">/usr/local/stow/perl</span></samp>)
but needs to appear to run in another place (the target tree, e.g.,
<samp><span class="file">/usr/local</span></samp>). Why is this important? What's wrong with Perl, for
instance, looking for its files in <samp><span class="file">/usr/local/stow/perl</span></samp> instead
of in <samp><span class="file">/usr/local</span></samp>?
<p>The answer is that there may be another package, e.g.,
<samp><span class="file">/usr/local/stow/perl-extras</span></samp>, stowed under <samp><span class="file">/usr/local</span></samp>. If
Perl is configured to find its files in <samp><span class="file">/usr/local/stow/perl</span></samp>, it
will never find the extra files in the &lsquo;<samp><span class="samp">perl-extras</span></samp>&rsquo; package, even
though they're intended to be found by Perl. On the other hand, if Perl
looks for its files in <samp><span class="file">/usr/local</span></samp>, then it will find the
intermingled Perl and &lsquo;<samp><span class="samp">perl-extras</span></samp>&rsquo; files.
<p>This means that when you compile a package, you must tell it the
location of the run-time, or target tree; but when you install it, you
must place it in the stow tree.
<h3 class="section">12.1 Advice on changing compilation and installation parameters</h3>
<p>Some software packages allow you to specify, at compile-time, separate
locations for installation and for run-time. Perl is one such package;
see <a href="Perl-and-Perl-5-Modules.html#Perl-and-Perl-5-Modules">Perl and Perl 5 Modules</a>. Others allow you to compile the
package, then give a different destination in the &lsquo;<samp><span class="samp">make install</span></samp>&rsquo;
step without causing the binaries or other files to get rebuilt. Most
GNU software falls into this category; Emacs is a notable exception.
See <a href="GNU-Emacs.html#GNU-Emacs">GNU Emacs</a>, and <a href="Other-FSF-Software.html#Other-FSF-Software">Other FSF Software</a>.
<p>Still other software packages cannot abide the idea of separate
installation and run-time locations at all. If you try to &lsquo;<samp><span class="samp">make
install prefix=/usr/local/stow/</span><var>foo</var></samp>&rsquo;, then first the whole package
will be recompiled to hardwire the <samp><span class="file">/usr/local/stow/</span><var>foo</var></samp>
path. With these packages, it is best to compile normally, then run
&lsquo;<samp><span class="samp">make -n install</span></samp>&rsquo;, which should report all the steps needed to
install the just-built software. Place this output into a file, edit
the commands in the file to remove recompilation steps and to reflect
the Stow-based installation location, and execute the edited file as a
shell script in place of &lsquo;<samp><span class="samp">make install</span></samp>&rsquo;. Be sure to execute the
script using the same shell that &lsquo;<samp><span class="samp">make install</span></samp>&rsquo; would have used.
<p>(If you use GNU Make and a shell [such as GNU bash] that understands
<samp><span class="command">pushd</span></samp> and <samp><span class="command">popd</span></samp>, you can do the following:
<ol type=1 start=1>
<li>Replace all lines matching &lsquo;<samp><span class="samp">make[</span><var>n</var><span class="samp">]: Entering directory
</span><var>dir</var></samp>&rsquo; with &lsquo;<samp><span class="samp">pushd </span><var>dir</var></samp>&rsquo;.
<li>Replace all lines matching &lsquo;<samp><span class="samp">make[</span><var>n</var><span class="samp">]: Leaving directory
</span><var>dir</var></samp>&rsquo; with &lsquo;<samp><span class="samp">popd</span></samp>&rsquo;.
<li>Delete all lines matching &lsquo;<samp><span class="samp">make[</span><var>n</var><span class="samp">]: Nothing to be done for
</span><var>rule</var></samp>&rsquo;.
</ol>
<p>Then find other lines in the output containing <samp><span class="command">cd</span></samp> or <samp><span class="command">make</span></samp>
commands and rewrite or delete them. In particular, you should be able
to delete sections of the script that resemble this:
<pre class="example"> for i in <var>dir_1</var> <var>dir_2</var> <span class="roman">...</span>; do \
(cd $i; make <var>args</var> <span class="roman">...</span>) \
done
</pre>
<p class="noindent">Note, that's &ldquo;should be able to,&rdquo; not &ldquo;can.&rdquo; Be sure to modulate
these guidelines with plenty of your own intelligence.
<p>The details of stowing some specific packages are described in the
following sections.
<ul class="menu">
<li><a accesskey="1" href="GNU-Emacs.html#GNU-Emacs">GNU Emacs</a>
<li><a accesskey="2" href="Other-FSF-Software.html#Other-FSF-Software">Other FSF Software</a>
<li><a accesskey="3" href="Cygnus-Software.html#Cygnus-Software">Cygnus Software</a>
<li><a accesskey="4" href="Perl-and-Perl-5-Modules.html#Perl-and-Perl-5-Modules">Perl and Perl 5 Modules</a>
</ul>
<!-- -->
</body></html>

100
local/share/doc/stow/manual-split/Conflicts.html Normal file
View file

@ -0,0 +1,100 @@
<html lang="en">
<head>
<title>Conflicts - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Deleting-Packages.html#Deleting-Packages" title="Deleting Packages">
<link rel="next" href="Mixing-Operations.html#Mixing-Operations" title="Mixing Operations">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Conflicts"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Mixing-Operations.html#Mixing-Operations">Mixing Operations</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Deleting-Packages.html#Deleting-Packages">Deleting Packages</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">7 Conflicts</h2>
<p><a name="index-conflicts-31"></a>If, during installation, a file or symlink exists in the target tree and
has the same name as something Stow needs to create, and if the
existing name is not a folded tree that can be split open, then a
<dfn>conflict</dfn> has arisen. A conflict also occurs if a directory exists
where Stow needs to place a symlink to a non-directory. On the
other hand, if the existing name is merely a symlink that already points
where Stow needs it to, then no conflict has occurred. (Thus it
is harmless to install a package that has already been installed.)
<p>For complex packages, scanning the stow and target trees in tandem,
and deciding whether to make directories or links, split-open or fold
directories, can actually take a long time (a number of seconds).
Moreover, an accurate analysis of potential conflicts requires us to
take into account all of these operations.
<p><a name="Deferred-Operation"></a>
<h3 class="section">7.1 Deferred Operation</h3>
<p><a name="index-deferred-operation-32"></a>
Since version 2.0, Stow now adopts a two-phase algorithm, first
scanning for any potential conflicts before any stowing or unstowing
operations are performed. If any conflicts are found, they are
displayed and then Stow terminates without making any modifications to
the filesystem. This means that there is much less risk of a package
being partially stowed or unstowed due to conflicts.
<p>Prior to version 2.0, if a conflict was discovered, the stow or unstow
operation could be aborted mid-flow, leaving the target tree in an
inconsistent state.
<!-- =========================================================================== -->
</body></html>

95
local/share/doc/stow/manual-split/Cygnus-Software.html Normal file
View file

@ -0,0 +1,95 @@
<html lang="en">
<head>
<title>Cygnus Software - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime" title="Compile-time vs Install-time">
<link rel="prev" href="Other-FSF-Software.html#Other-FSF-Software" title="Other FSF Software">
<link rel="next" href="Perl-and-Perl-5-Modules.html#Perl-and-Perl-5-Modules" title="Perl and Perl 5 Modules">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Cygnus-Software"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Perl-and-Perl-5-Modules.html#Perl-and-Perl-5-Modules">Perl and Perl 5 Modules</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Other-FSF-Software.html#Other-FSF-Software">Other FSF Software</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime">Compile-time vs Install-time</a>
<hr>
</div>
<h3 class="section">12.4 Cygnus Software</h3>
<p>Cygnus is a commercial supplier and supporter of GNU software. It has
also written several of its own packages, released under the terms of
the GNU General Public License; and it has taken over the maintenance of
other packages. Among the packages released by Cygnus are &lsquo;<samp><span class="samp">gdb</span></samp>&rsquo;,
&lsquo;<samp><span class="samp">gnats</span></samp>&rsquo;, and &lsquo;<samp><span class="samp">dejagnu</span></samp>&rsquo;.
<p>Cygnus packages have the peculiarity that each one unpacks into a
directory tree with a generic top-level Makefile, which is set up to
compile <em>all</em> of Cygnus' packages, any number of which may reside
under the top-level directory. In other words, even if you're only
building &lsquo;<samp><span class="samp">gnats</span></samp>&rsquo;, the top-level Makefile will look for, and try to
build, <samp><span class="file">gdb</span></samp> and <samp><span class="file">dejagnu</span></samp> subdirectories, among many others.
<p>The result is that if you try &lsquo;<samp><span class="samp">make -n install
prefix=/usr/local/stow/</span><var>package</var></samp>&rsquo; at the top level of a Cygnus
package, you'll get a bewildering amount of output. It will then be
very difficult to visually scan the output to see whether the install
will proceed correctly. Unfortunately, it's not always clear how to
invoke an install from the subdirectory of interest.
<p>In cases like this, the best approach is to run your &lsquo;<samp><span class="samp">make install
prefix=...</span></samp>&rsquo;, but be ready to interrupt it if you detect that it
is recompiling files. Usually it will work just fine; otherwise,
install manually.
<!-- -->
</body></html>

1
local/share/doc/stow/manual-split/Deferred-Operation.html Normal file
View file

@ -0,0 +1 @@
<meta http-equiv="refresh" content="0; url=Conflicts.html#Deferred%20Operation">

112
local/share/doc/stow/manual-split/Deleting-Packages.html Normal file
View file

@ -0,0 +1,112 @@
<html lang="en">
<head>
<title>Deleting Packages - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Installing-Packages.html#Installing-Packages" title="Installing Packages">
<link rel="next" href="Conflicts.html#Conflicts" title="Conflicts">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Deleting-Packages"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Conflicts.html#Conflicts">Conflicts</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Installing-Packages.html#Installing-Packages">Installing Packages</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">6 Deleting Packages</h2>
<p><a name="index-deletion-28"></a>When the <samp><span class="option">-D</span></samp> option is given, the action of Stow is to
delete a package from the target tree. Note that Stow will not
delete anything it doesn't &ldquo;own&rdquo;. Deleting a package does <em>not</em>
mean removing it from the stow directory or discarding the package
tree.
<p>To delete a package, Stow recursively scans the target tree, skipping over any
directory that is not included in the installation image.<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a>
For example, if the target directory is <samp><span class="file">/usr/local</span></samp> and the
installation image for the package being deleted has only a <samp><span class="file">bin</span></samp>
directory and a <samp><span class="file">man</span></samp> directory at the top level, then we only scan
<samp><span class="file">/usr/local/bin</span></samp> and <samp><span class="file">/usr/local/bin/man</span></samp>, and not
<samp><span class="file">/usr/local/lib</span></samp> or <samp><span class="file">/usr/local/share</span></samp>, or for that matter
<samp><span class="file">/usr/local/stow</span></samp>. Any symlink it finds that points into the package
being deleted is removed. Any directory that contained only symlinks to the
package being deleted is removed.
<p><a name="tree-refolding"></a>
<h3 class="section">6.1 Refolding &ldquo;foldable&rdquo; trees.</h3>
<p><a name="index-refolding-trees-29"></a><a name="index-tree-refolding-30"></a>
After removing symlinks and empty subdirectories, any directory that
contains only symlinks to a single other package is considered to be a
previously &ldquo;folded&rdquo; tree that was &ldquo;split open.&rdquo; Stow will refold
the tree by removing the symlinks to the surviving package, removing
the directory, then linking the directory back to the surviving
package. However, this behaviour can be prevented via the
<samp><span class="option">--no-folding</span></samp> option; see <a href="Invoking-Stow.html#Invoking-Stow">Invoking Stow</a>.
<!-- =========================================================================== -->
<div class="footnote">
<hr>
<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> This
approach was introduced in version 2 of GNU Stow. Previously, the whole
target tree was scanned and stow directories were explicitly omitted. This
became problematic when dealing with very large installations. The only
situation where this is useful is if you accidentally delete a directory in
the package tree, leaving you with a whole bunch of dangling links. Note that
you can enable the old approach with the <samp><span class="option">-p</span></samp> option. Alternatively, you can
use the <samp><span class="option">--badlinks</span></samp> option get stow to search for dangling links in your target tree and remove the offenders manually.</p>
<hr></div>
</body></html>

97
local/share/doc/stow/manual-split/GNU-Emacs.html Normal file
View file

@ -0,0 +1,97 @@
<html lang="en">
<head>
<title>GNU Emacs - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime" title="Compile-time vs Install-time">
<link rel="prev" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime" title="Compile-time vs Install-time">
<link rel="next" href="Other-FSF-Software.html#Other-FSF-Software" title="Other FSF Software">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="GNU-Emacs"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Other-FSF-Software.html#Other-FSF-Software">Other FSF Software</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime">Compile-time vs Install-time</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime">Compile-time vs Install-time</a>
<hr>
</div>
<h3 class="section">12.2 GNU Emacs</h3>
<p>Although the Free Software Foundation has many enlightened practices
regarding Makefiles and software installation (see see <a href="Other-FSF-Software.html#Other-FSF-Software">Other FSF Software</a>), Emacs, its flagship program, doesn't quite follow the
rules. In particular, most GNU software allows you to write:
<pre class="example"> make
make install prefix=/usr/local/stow/<var>package</var>
</pre>
<p class="noindent">If you try this with Emacs, then the new value for <var>prefix</var> in the
&lsquo;<samp><span class="samp">make install</span></samp>&rsquo; step will cause some files to get recompiled with
the new value of <var>prefix</var> wired into them. In Emacs 19.23 and
later,<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a>
the way to work around this problem is:
<pre class="example"> make
make install-arch-dep install-arch-indep prefix=/usr/local/stow/emacs
</pre>
<p>In 19.22 and some prior versions of Emacs, the workaround was:
<pre class="example"> make
make do-install prefix=/usr/local/stow/emacs
</pre>
<!-- -->
<div class="footnote">
<hr>
<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> As I write this, the current version of Emacs is 19.31.</p>
<hr></div>
</body></html>

411
local/share/doc/stow/manual-split/GNU-General-Public-License.html Normal file
View file

@ -0,0 +1,411 @@
<html lang="en">
<head>
<title>GNU General Public License - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Known-Bugs.html#Known-Bugs" title="Known Bugs">
<link rel="next" href="Index.html#Index" title="Index">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="GNU-General-Public-License"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Index.html#Index">Index</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Known-Bugs.html#Known-Bugs">Known Bugs</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="unnumbered">GNU General Public License</h2>
<div align="center">Version 2, June 1991</div>
<pre class="display"> Copyright &copy; 1989, 1991 Free Software Foundation, Inc.
675 Mass Ave, Cambridge, MA 02139, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre>
<h3 class="unnumberedsec">Preamble</h3>
<p>The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software&mdash;to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
<p>When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
<p>To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
<p>For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
<p>We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
<p>Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
<p>Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
<p>The precise terms and conditions for copying, distribution and
modification follow.
<ol type=1 start=0>
<li>This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The &ldquo;Program&rdquo;, below,
refers to any such program or work, and a &ldquo;work based on the Program&rdquo;
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term &ldquo;modification&rdquo;.) Each licensee is addressed as &ldquo;you&rdquo;.
<p>Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
<li>You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
<p>You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
<li>You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
<ol type=a start=1>
<li>You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
<li>You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
<li>If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
</ol>
<p>These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
<p>Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
<p>In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
<li>You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
<ol type=a start=1>
<li>Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
<li>Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
<li>Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
</ol>
<p>The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
<p>If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
<li>You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
<li>You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
<li>Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
<li>If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
<p>If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
<p>It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
<p>This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
<li>If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
<li>The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
<p>Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and &ldquo;any
later version&rdquo;, you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
<li>If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
<li>BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM &ldquo;AS IS&rdquo; WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
<li>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
</ol>
<h3 class="unnumberedsec">How to Apply These Terms to Your New Programs</h3>
<p>If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
<p>To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the &ldquo;copyright&rdquo; line and a pointer to where the full notice is found.
<pre class="smallexample"> <var>one line to give the program's name and an idea of what it does.</var>
Copyright (C) 19<var>yy</var> <var>name of author</var>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
</pre>
<p>Also add information on how to contact you by electronic and paper mail.
<p>If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
<pre class="smallexample"> Gnomovision version 69, Copyright (C) 19<var>yy</var> <var>name of author</var>
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
type `show w'. This is free software, and you are welcome
to redistribute it under certain conditions; type `show c'
for details.
</pre>
<p>The hypothetical commands &lsquo;<samp><span class="samp">show w</span></samp>&rsquo; and &lsquo;<samp><span class="samp">show c</span></samp>&rsquo; should show
the appropriate parts of the General Public License. Of course, the
commands you use may be called something other than &lsquo;<samp><span class="samp">show w</span></samp>&rsquo; and
&lsquo;<samp><span class="samp">show c</span></samp>&rsquo;; they could even be mouse-clicks or menu items&mdash;whatever
suits your program.
<p>You should also get your employer (if you work as a programmer) or your
school, if any, to sign a &ldquo;copyright disclaimer&rdquo; for the program, if
necessary. Here is a sample; alter the names:
<pre class="smallexample"> Yoyodyne, Inc., hereby disclaims all copyright
interest in the program `Gnomovision'
(which makes passes at compilers) written
by James Hacker.
<var>signature of Ty Coon</var>, 1 April 1989
Ty Coon, President of Vice
</pre>
<p>This General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications
with the library. If this is what you want to do, use the GNU Library
General Public License instead of this License.
</body></html>

77
local/share/doc/stow/manual-split/Ignore-Lists.html Normal file
View file

@ -0,0 +1,77 @@
<html lang="en">
<head>
<title>Ignore Lists - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Invoking-Stow.html#Invoking-Stow" title="Invoking Stow">
<link rel="next" href="Installing-Packages.html#Installing-Packages" title="Installing Packages">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Ignore-Lists"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Installing-Packages.html#Installing-Packages">Installing Packages</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Invoking-Stow.html#Invoking-Stow">Invoking Stow</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">4 Ignore Lists</h2>
<p><a name="index-ignore-lists-14"></a><a name="index-ignoring-files-and-directories-15"></a>
<ul class="menu">
<li><a accesskey="1" href="Motivation-For-Ignore-Lists.html#Motivation-For-Ignore-Lists">Motivation For Ignore Lists</a>
<li><a accesskey="2" href="Types-And-Syntax-Of-Ignore-Lists.html#Types-And-Syntax-Of-Ignore-Lists">Types And Syntax Of Ignore Lists</a>
<li><a accesskey="3" href="Justification-For-Yet-Another-Set-Of-Ignore-Files.html#Justification-For-Yet-Another-Set-Of-Ignore-Files">Justification For Yet Another Set Of Ignore Files</a>
</ul>
<!-- =========================================================================== -->
</body></html>

156
local/share/doc/stow/manual-split/Installing-Packages.html Normal file
View file

@ -0,0 +1,156 @@
<html lang="en">
<head>
<title>Installing Packages - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Ignore-Lists.html#Ignore-Lists" title="Ignore Lists">
<link rel="next" href="Deleting-Packages.html#Deleting-Packages" title="Deleting Packages">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Installing-Packages"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Deleting-Packages.html#Deleting-Packages">Deleting Packages</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Ignore-Lists.html#Ignore-Lists">Ignore Lists</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">5 Installing Packages</h2>
<p><a name="index-installation-17"></a>The default action of Stow is to install a package. This means creating
symlinks in the target tree that point into the package tree. Stow
attempts to do this with as few symlinks as possible; in other words, if
Stow can create a single symlink that points to an entire subtree within
the package tree, it will choose to do that rather than create a
directory in the target tree and populate it with symlinks.
<p><a name="tree-folding"></a>
<h3 class="section">5.1 Tree folding</h3>
<p><a name="index-tree-folding-18"></a><a name="index-directory-folding-19"></a><a name="index-folding-trees-20"></a>For example, suppose that no packages have yet been installed in
<samp><span class="file">/usr/local</span></samp>; it's completely empty (except for the <samp><span class="file">stow</span></samp>
subdirectory, of course). Now suppose the Perl package is installed.
Recall that it includes the following directories in its installation
image: <samp><span class="file">bin</span></samp>; <samp><span class="file">info</span></samp>; <samp><span class="file">lib/perl</span></samp>; <samp><span class="file">man/man1</span></samp>.
Rather than creating the directory <samp><span class="file">/usr/local/bin</span></samp> and populating
it with symlinks to <samp><span class="file">../stow/perl/bin/perl</span></samp> and
<samp><span class="file">../stow/perl/bin/a2p</span></samp> (and so on), Stow will create a
single symlink, <samp><span class="file">/usr/local/bin</span></samp>, which points to
<samp><span class="file">stow/perl/bin</span></samp>. In this way, it still works to refer to
<samp><span class="file">/usr/local/bin/perl</span></samp> and <samp><span class="file">/usr/local/bin/a2p</span></samp>, and fewer
symlinks have been created. This is called <dfn>tree folding</dfn>, since an
entire subtree is &ldquo;folded&rdquo; into a single symlink.
<p>To complete this example, Stow will also create the symlink
<samp><span class="file">/usr/local/info</span></samp> pointing to <samp><span class="file">stow/perl/info</span></samp>; the symlink
<samp><span class="file">/usr/local/lib</span></samp> pointing to <samp><span class="file">stow/perl/lib</span></samp>; and the symlink
<samp><span class="file">/usr/local/man</span></samp> pointing to <samp><span class="file">stow/perl/man</span></samp>.
<p>Now suppose that instead of installing the Perl package into an empty
target tree, the target tree is not empty to begin with. Instead, it
contains several files and directories installed under a different
system-administration philosophy. In particular, <samp><span class="file">/usr/local/bin</span></samp>
already exists and is a directory, as are <samp><span class="file">/usr/local/lib</span></samp> and
<samp><span class="file">/usr/local/man/man1</span></samp>. In this case, Stow will descend into
<samp><span class="file">/usr/local/bin</span></samp> and create symlinks to
<samp><span class="file">../stow/perl/bin/perl</span></samp> and <samp><span class="file">../stow/perl/bin/a2p</span></samp> (etc.),
and it will descend into <samp><span class="file">/usr/local/lib</span></samp> and create the
tree-folding symlink <samp><span class="file">perl</span></samp> pointing to
<samp><span class="file">../stow/perl/lib/perl</span></samp>, and so on. As a rule, Stow only
descends as far as necessary into the target tree when it can create a
tree-folding symlink. However, this behaviour can be changed via
the <samp><span class="option">--no-folding</span></samp> option; see <a href="Invoking-Stow.html#Invoking-Stow">Invoking Stow</a>.
<p><a name="Tree-unfolding"></a>
<h3 class="section">5.2 Tree unfolding</h3>
<p><a name="index-splitting-open-folded-trees-21"></a><a name="index-unfolding-trees-22"></a><a name="index-tree-unfolding-23"></a><a name="index-tree-unsplitting-24"></a>The time often comes when a tree-folding symlink has to be undone
because another package uses one or more of the folded subdirectories in
its installation image. This operation is called <dfn>splitting open</dfn> or
<dfn>unfolding</dfn> a folded tree. It involves removing the original symlink from
the target tree, creating a true directory in its place, and then populating the
new directory with symlinks to the newly-installed package <em>and</em> to
the old package that used the old symlink. For example, suppose that
after installing Perl into an empty <samp><span class="file">/usr/local</span></samp>, we wish to
install Emacs. Emacs's installation image includes a <samp><span class="file">bin</span></samp>
directory containing the <samp><span class="file">emacs</span></samp> and <samp><span class="file">etags</span></samp> executables,
among others. Stow must make these files appear to be installed
in <samp><span class="file">/usr/local/bin</span></samp>, but presently <samp><span class="file">/usr/local/bin</span></samp> is a
symlink to <samp><span class="file">stow/perl/bin</span></samp>. Stow therefore takes the
following steps: the symlink <samp><span class="file">/usr/local/bin</span></samp> is deleted; the
directory <samp><span class="file">/usr/local/bin</span></samp> is created; links are made from
<samp><span class="file">/usr/local/bin</span></samp> to <samp><span class="file">../stow/emacs/bin/emacs</span></samp> and
<samp><span class="file">../stow/emacs/bin/etags</span></samp>; and links are made from
<samp><span class="file">/usr/local/bin</span></samp> to <samp><span class="file">../stow/perl/bin/perl</span></samp> and
<samp><span class="file">../stow/perl/bin/a2p</span></samp>.
<h3 class="section">5.3 Ownership</h3>
<p><a name="index-ownership-25"></a>When splitting open a folded tree, Stow makes sure that the
symlink it is about to remove points inside a valid package in the
current stow directory. <em>Stow will never delete anything
that it doesn't own</em>. Stow &ldquo;owns&rdquo; everything living in the
target tree that points into a package in the stow directory. Anything
Stow owns, it can recompute if lost: symlinks that point into a package in
the stow directory, or directories that only contain symlinks that stow
&ldquo;owns&rdquo;. Note that by this definition, Stow doesn't &ldquo;own&rdquo; anything
<em>in</em> the stow directory or in any of the packages.
<h3 class="section">5.4 Conflicts during installation</h3>
<p><a name="index-conflicts-26"></a><a name="index-installation-conflicts-27"></a>If Stow needs to create a directory or a symlink in the target
tree and it cannot because that name is already in use and is not owned
by Stow, then a <dfn>conflict</dfn> has arisen. See <a href="Conflicts.html#Conflicts">Conflicts</a>.
<!-- =========================================================================== -->
</body></html>

119
local/share/doc/stow/manual-split/Introduction.html Normal file
View file

@ -0,0 +1,119 @@
<html lang="en">
<head>
<title>Introduction - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="index.html#Top" title="Top">
<link rel="next" href="Terminology.html#Terminology" title="Terminology">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Introduction"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Terminology.html#Terminology">Terminology</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="index.html#Top">Top</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">1 Introduction</h2>
<p>Stow is a tool for managing the installation of multiple software
packages in the same run-time directory tree. One historical difficulty
of this task has been the need to administer, upgrade, install, and
remove files in independent packages without confusing them with other
files sharing the same file system space. For instance, it is common to
install Perl and Emacs in <samp><span class="file">/usr/local</span></samp>. When one does so, one
winds up with the following files<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a> in <samp><span class="file">/usr/local/man/man1</span></samp>:
<pre class="example"> a2p.1
ctags.1
emacs.1
etags.1
h2ph.1
perl.1
s2p.1
</pre>
<p class="noindent">Now suppose it's time to uninstall Perl. Which man pages
get removed? Obviously <samp><span class="file">perl.1</span></samp> is one of them, but it should not
be the administrator's responsibility to memorize the ownership of
individual files by separate packages.
<p>The approach used by Stow is to install each package into its own
tree, then use symbolic links to make it appear as though the files are
installed in the common tree. Administration can be performed in the
package's private tree in isolation from clutter from other packages.
Stow can then be used to update the symbolic links. The structure
of each private tree should reflect the desired structure in the common
tree; i.e. (in the typical case) there should be a <samp><span class="file">bin</span></samp> directory
containing executables, a <samp><span class="file">man/man1</span></samp> directory containing section 1
man pages, and so on.
<p>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., <samp><span class="file">/usr/local/stow/emacs</span></samp>), so it's always possible
to rebuild the target tree (e.g., <samp><span class="file">/usr/local</span></samp>).
<p>For information about the latest version of Stow, you can refer to
<a href="http://www.gnu.org/software/stow/">http://www.gnu.org/software/stow/</a>.
<!-- =========================================================================== -->
<div class="footnote">
<hr>
<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> As of Perl 4.036 and Emacs
19.22.</p>
<hr></div>
</body></html>

206
local/share/doc/stow/manual-split/Invoking-Stow.html Normal file
View file

@ -0,0 +1,206 @@
<html lang="en">
<head>
<title>Invoking Stow - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Terminology.html#Terminology" title="Terminology">
<link rel="next" href="Ignore-Lists.html#Ignore-Lists" title="Ignore Lists">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Invoking-Stow"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Ignore-Lists.html#Ignore-Lists">Ignore Lists</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Terminology.html#Terminology">Terminology</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">3 Invoking Stow</h2>
<p>The syntax of the <samp><span class="command">stow</span></samp> command is:
<pre class="example"> stow [<var>options</var>] [<var>action flag</var>] <var>package <small class="dots">...</small></var>
</pre>
<p class="noindent">Each <var>package</var> is the name of a package (e.g., &lsquo;<samp><span class="samp">perl</span></samp>&rsquo;) in the stow
directory that we wish to install into (or delete from) the target directory.
The default action is to install the given packages, although alternate actions
may be specified by preceding the package name(s) with an <var>action flag</var>.
<p class="noindent">The following options are supported:
<dl>
<dt>&lsquo;<samp><span class="samp">-d </span><var>dir</var></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--dir=</span><var>dir</var></samp>&rsquo;<dd>Set the stow directory to <var>dir</var>. Defaults to the value of the environment
variable <samp><span class="env">STOW_DIR</span></samp> if set, or the current directory otherwise.
<br><dt>&lsquo;<samp><span class="samp">-t </span><var>dir</var></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--target=</span><var>dir</var></samp>&rsquo;<dd>Set the target directory to <var>dir</var> instead of the parent of the stow
directory. Defaults to the parent of the stow directory, so it is typical to
execute <samp><span class="command">stow</span></samp> from the directory <samp><span class="file">/usr/local/stow</span></samp>.
<br><dt>&lsquo;<samp><span class="samp">--ignore=</span><var>regexp</var></samp>&rsquo;<dd>This (repeatable) option lets you suppress acting on files that match the
given perl regular expression. For example, using the options
<pre class="example"> --ignore='*.orig' --ignore='*.dist'
</pre>
<p class="noindent">will cause stow to ignore files ending in <samp><span class="file">.orig</span></samp> or <samp><span class="file">.dist</span></samp>.
<p>Note that the regular expression is anchored to the end of the filename,
because this is what you will want to do most of the time.
<p>Also note that by default Stow automatically ignores a &ldquo;sensible&rdquo;
built-in list of files and directories such as <samp><span class="file">CVS</span></samp>, editor
backup files, and so on. See <a href="Ignore-Lists.html#Ignore-Lists">Ignore Lists</a>, for more details.
<br><dt>&lsquo;<samp><span class="samp">--defer=</span><var>regexp</var></samp>&rsquo;<dd>This (repeatable) option avoids stowing a file matching the given
regular expression, if that file is already stowed by another package.
This is effectively the opposite of <samp><span class="option">--override</span></samp>.
<p>(N.B. the name <samp><span class="option">--defer</span></samp> was chosen in the sense that the package
currently being stowed is treated with lower precedence than any
already installed package, not in the sense that the operation is
being postponed to be run at a later point in time; do not confuse
this nomenclature with the wording used in <a href="Deferred-Operation.html#Deferred-Operation">Deferred Operation</a>.)
<p>For example, the following options
<pre class="example"> --defer=man --defer=info
</pre>
<p class="noindent">will cause stow to skip over pre-existing man and info pages.
<p>Equivalently, you could use &lsquo;<samp><span class="samp">--defer='man|info'</span></samp>&rsquo; since the
argument is just a Perl regex.
<p>Note that the regular expression is anchored to the beginning of the path
relative to the target directory, because this is what you will want to do most
of the time.
<br><dt>&lsquo;<samp><span class="samp">--override=</span><var>regexp</var></samp>&rsquo;<dd>This (repeatable) option forces any file matching the regular expression to be
stowed, even if the file is already stowed to another package. For example,
the following options
<pre class="example"> --override=man --override=info
</pre>
<p class="noindent">will permit stow to overwrite links that point to pre-existing man and info
pages that are owned by stow and would otherwise cause a conflict.
<p>The regular expression is anchored to the beginning of the path relative to
the target directory, because this is what you will want to do most of the time.
<br><dt>&lsquo;<samp><span class="samp">--no-folding</span></samp>&rsquo;<dd>
This disables any further <a href="tree-folding.html#tree-folding">tree folding</a> or <a href="tree-refolding.html#tree-refolding">tree refolding</a>.
If a new subdirectory is encountered whilst stowing a new package, the
subdirectory is created within the target, and its contents are
symlinked, rather than just creating a symlink for the directory. If
removal of symlinks whilst unstowing a package causes a subtree to be
foldable (i.e. only containing symlinks to a single package), that
subtree will not be removed and replaced with a symlink.
<p><a name="index-adopting-existing-files-10"></a><br><dt>&lsquo;<samp><span class="samp">--adopt</span></samp>&rsquo;<dd><strong>Warning!</strong> This behaviour is specifically intended to alter the
contents of your stow directory. If you do not want that, this option
is not for you.
<p>When stowing, if a target is encountered which already exists but is a
plain file (and hence not owned by any existing stow package), then
normally Stow will register this as a conflict and refuse to proceed.
This option changes that behaviour so that the file is moved to the
same relative place within the package's installation image within the
stow directory, and then stowing proceeds as before. So effectively,
the file becomes adopted by the stow package, without its contents
changing.
<p>This is particularly useful when the stow package is under the control
of a version control system, because it allows files in the target
tree, with potentially different contents to the equivalent versions
in the stow package's installation image, to be adopted into the
package, then compared by running something like &lsquo;<samp><span class="samp">git diff ...</span></samp>&rsquo;
inside the stow package, and finally either kept (e.g. via &lsquo;<samp><span class="samp">git
commit ...</span></samp>&rsquo;) or discarded (&lsquo;<samp><span class="samp">git checkout HEAD ...</span></samp>&rsquo;).
<p><a name="index-dry-run-11"></a><a name="index-simulated-run-12"></a><br><dt>&lsquo;<samp><span class="samp">-n</span></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--no</span></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--simulate</span></samp>&rsquo;<dd>Do not perform any operations that modify the file system; in combination with
<samp><span class="option">-v</span></samp> can be used to merely show what would happen.
<p><a name="index-verbosity-levels-13"></a><br><dt>&lsquo;<samp><span class="samp">-v</span></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--verbose[=</span><var>n</var><span class="samp">]</span></samp>&rsquo;<dd>Send verbose output to standard error describing what Stow is
doing. Verbosity levels are 0, 1, 2, and 3; 0 is the default. Using
<samp><span class="option">-v</span></samp> or <samp><span class="option">--verbose</span></samp> increases the verbosity by one; using
&lsquo;<samp><span class="samp">--verbose=</span><var>n</var></samp>&rsquo; sets it to <var>n</var>.
<br><dt>&lsquo;<samp><span class="samp">-p</span></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--compat</span></samp>&rsquo;<dd>Scan the whole target tree when unstowing. By default, only
directories specified in the <dfn>installation image</dfn> are scanned
during an unstow operation. Scanning the whole tree can be
prohibitive if your target tree is very large. This option restores
the legacy behaviour; however, the <samp><span class="option">--badlinks</span></samp> option to the
<samp><span class="command">chkstow</span></samp> utility may be a better way of ensuring that your
installation does not have any dangling symlinks (see <a href="Target-Maintenance.html#Target-Maintenance">Target Maintenance</a>).
<br><dt>&lsquo;<samp><span class="samp">-V</span></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--version</span></samp>&rsquo;<dd>Show Stow version number, and exit.
<br><dt>&lsquo;<samp><span class="samp">-h</span></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--help</span></samp>&rsquo;<dd>Show Stow command syntax, and exit.
</dl>
<p>The following <var>action flags</var> are supported:
<dl>
<dt>&lsquo;<samp><span class="samp">-D</span></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--delete</span></samp>&rsquo;<dd>Delete (unstow) the package name(s) that follow this option from the <dfn>target
directory</dfn>. This option may be repeated any number of times.
<br><dt>&lsquo;<samp><span class="samp">-R</span></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--restow</span></samp>&rsquo;<dd>Restow (first unstow, then stow again) the package names that follow this
option. This is useful for pruning obsolete symlinks from the target tree
after updating the software in a package. This option may be repeated any
number of times.
<br><dt>&lsquo;<samp><span class="samp">-S</span></samp>&rsquo;<br><dt>&lsquo;<samp><span class="samp">--stow</span></samp>&rsquo;<dd>explictly stow the package name(s) that follow this option. May be
omitted if you are not using the <samp><span class="option">-D</span></samp> or <samp><span class="option">-R</span></samp> options in the
same invocation. See <a href="Mixing-Operations.html#Mixing-Operations">Mixing Operations</a>, for details of when you
might like to use this feature. This option may be repeated any number
of times.
</dl>
<!-- =========================================================================== -->
</body></html>

93
local/share/doc/stow/manual-split/Justification-For-Yet-Another-Set-Of-Ignore-Files.html Normal file
View file

@ -0,0 +1,93 @@
<html lang="en">
<head>
<title>Justification For Yet Another Set Of Ignore Files - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Ignore-Lists.html#Ignore-Lists" title="Ignore Lists">
<link rel="prev" href="Types-And-Syntax-Of-Ignore-Lists.html#Types-And-Syntax-Of-Ignore-Lists" title="Types And Syntax Of Ignore Lists">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Justification-For-Yet-Another-Set-Of-Ignore-Files"></a>
<p>
Previous:&nbsp;<a rel="previous" accesskey="p" href="Types-And-Syntax-Of-Ignore-Lists.html#Types-And-Syntax-Of-Ignore-Lists">Types And Syntax Of Ignore Lists</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Ignore-Lists.html#Ignore-Lists">Ignore Lists</a>
<hr>
</div>
<h3 class="section">4.3 Justification For Yet Another Set Of Ignore Files</h3>
<p>The reader may note that this format is very similar to existing
ignore list file formats, such as those for <samp><span class="command">cvs</span></samp>, <samp><span class="command">git</span></samp>,
<samp><span class="command">rsync</span></samp> etc., and wonder if another set of ignore lists is
justified. However there are good reasons why Stow does not simply
check for the presence of say, <samp><span class="file">.cvsignore</span></samp>, and use that if it
exists. Firstly, there is no guarantee that a stow package would
contain any version control meta-data, or permit introducing this if
it didn't already exist.
<p>Secondly even if it did, version control system ignore lists generally
reflect <em>build-time</em> ignores rather than <em>install-time</em>, and
there may be some intermediate or temporary files on those ignore
lists generated during development or at build-time which it would be
inappropriate to stow, even though many files generated at build-time
(binaries, libraries, documentation etc.) certainly do need to be
stowed. Similarly, if a file is <em>not</em> in the version control
system's ignore list, there is no way of knowing whether the file is
intended for end use, let alone whether the version control system is
tracking it or not.
<p>Therefore it seems clear that ignore lists provided by version control
systems do not provide sufficient information for Stow to determine
which files and directories to stow, and so it makes sense for Stow to
support independent ignore lists.
<!-- =========================================================================== -->
</body></html>

76
local/share/doc/stow/manual-split/Known-Bugs.html Normal file
View file

@ -0,0 +1,76 @@
<html lang="en">
<head>
<title>Known Bugs - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Reporting-Bugs.html#Reporting-Bugs" title="Reporting Bugs">
<link rel="next" href="GNU-General-Public-License.html#GNU-General-Public-License" title="GNU General Public License">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Known-Bugs"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="GNU-General-Public-License.html#GNU-General-Public-License">GNU General Public License</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Reporting-Bugs.html#Reporting-Bugs">Reporting Bugs</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">15 Known Bugs</h2>
<p>There are no known bugs in Stow version 2.2.2!
If you think you have found one, please see <a href="Reporting-Bugs.html#Reporting-Bugs">Reporting Bugs</a>.
<!-- @itemize @bullet -->
<!-- @item -->
<!-- Put known bugs here -->
<!-- @end itemize -->
<!-- =========================================================================== -->
</body></html>

90
local/share/doc/stow/manual-split/Mixing-Operations.html Normal file
View file

@ -0,0 +1,90 @@
<html lang="en">
<head>
<title>Mixing Operations - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Conflicts.html#Conflicts" title="Conflicts">
<link rel="next" href="Multiple-Stow-Directories.html#Multiple-Stow-Directories" title="Multiple Stow Directories">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Mixing-Operations"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Multiple-Stow-Directories.html#Multiple-Stow-Directories">Multiple Stow Directories</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Conflicts.html#Conflicts">Conflicts</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">8 Mixing Operations</h2>
<p><a name="index-mixing-operations-33"></a>
Since version 2.0, multiple distinct actions can be specified in a single
invocation of GNU Stow. For example, to update an installation of Emacs from
version 21.3 to 21.4a you can now do the following:
<pre class="example"> stow -D emacs-21.3 -S emacs-21.4a
</pre>
<p class="noindent">which will replace emacs-21.3 with emacs-21.4a using a single invocation.
<p><a name="index-deferred-operation-34"></a>This is much faster and cleaner than performing two separate
invocations of stow, because redundant folding/unfolding operations
can be factored out. In addition, all the operations are calculated
and merged before being executed (see <a href="Deferred-Operation.html#Deferred-Operation">Deferred Operation</a>), so the
amount of of time in which GNU Emacs is unavailable is minimised.
<p>You can mix and match any number of actions, for example,
<pre class="example"> stow -S pkg1 pkg2 -D pkg3 pkg4 -S pkg5 -R pkg6
</pre>
<p class="noindent">will unstow pkg3, pkg4 and pkg6, then stow pkg1, pkg2, pkg5 and pkg6.
<!-- =========================================================================== -->
</body></html>

94
local/share/doc/stow/manual-split/Motivation-For-Ignore-Lists.html Normal file
View file

@ -0,0 +1,94 @@
<html lang="en">
<head>
<title>Motivation For Ignore Lists - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Ignore-Lists.html#Ignore-Lists" title="Ignore Lists">
<link rel="prev" href="Ignore-Lists.html#Ignore-Lists" title="Ignore Lists">
<link rel="next" href="Types-And-Syntax-Of-Ignore-Lists.html#Types-And-Syntax-Of-Ignore-Lists" title="Types And Syntax Of Ignore Lists">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Motivation-For-Ignore-Lists"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Types-And-Syntax-Of-Ignore-Lists.html#Types-And-Syntax-Of-Ignore-Lists">Types And Syntax Of Ignore Lists</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Ignore-Lists.html#Ignore-Lists">Ignore Lists</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Ignore-Lists.html#Ignore-Lists">Ignore Lists</a>
<hr>
</div>
<h3 class="section">4.1 Motivation For Ignore Lists</h3>
<p>In many situations, there will exist files under the package
directories which it would be undesirable to stow into the target
directory. For example, files related version control such as
<samp><span class="file">.gitignore</span></samp>, <samp><span class="file">CVS</span></samp>, <samp><span class="file">*,v</span></samp> (RCS files) should typically
not have symlinks from the target tree pointing to them. Also there
may be files or directories relating to the build of the package which
are not needed at run-time.
<p>In these cases, it can be rather cumbersome to specify a
<samp><span class="option">--ignore</span></samp> parameter for each file or directory to be ignored.
This could be worked around by ensuring the existence of
<samp><span class="file">~/.stowrc</span></samp> containing multiple <samp><span class="option">--ignore</span></samp> lines, or if a
different set of files/directories should be ignored depending on
which stow package is involved, a <samp><span class="file">.stowrc</span></samp> file for each stow
package, but this would require the user to ensure that they were in
the correct directory before invoking stow, which would be tedious and
error-prone. Furthermore, since Stow shifts parameters from
<samp><span class="file">.stowrc</span></samp> onto ARGV at run-time, it could clutter up the process
table with excessively long parameter lists, or even worse, exceed the
operating system's limit for process arguments.
<p><a name="index-ignore-lists-16"></a>Therefore in addition to <samp><span class="option">--ignore</span></samp> parameters, Stow provides a
way to specify lists of files and directories to ignore.
<!-- =========================================================================== -->
</body></html>

86
local/share/doc/stow/manual-split/Multiple-Stow-Directories.html Normal file
View file

@ -0,0 +1,86 @@
<html lang="en">
<head>
<title>Multiple Stow Directories - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Mixing-Operations.html#Mixing-Operations" title="Mixing Operations">
<link rel="next" href="Target-Maintenance.html#Target-Maintenance" title="Target Maintenance">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Multiple-Stow-Directories"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Target-Maintenance.html#Target-Maintenance">Target Maintenance</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Mixing-Operations.html#Mixing-Operations">Mixing Operations</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">9 Multiple Stow Directories</h2>
<p>If there are two or more system administrators who wish to maintain
software separately, or if there is any other reason to want two or more
stow directories, it can be done by creating a file named <samp><span class="file">.stow</span></samp>
in each stow directory. The presence of <samp><span class="file">/usr/local/foo/.stow</span></samp>
informs Stow that, though <samp><span class="file">foo</span></samp> is not the current stow
directory, even if it is a subdirectory of the target directory,
nevertheless it is <em>a</em> stow directory and as such Stow
doesn't &ldquo;own&rdquo; anything in it (see <a href="Installing-Packages.html#Installing-Packages">Installing Packages</a>). This will
protect the contents of <samp><span class="file">foo</span></samp> from a &lsquo;<samp><span class="samp">stow -D</span></samp>&rsquo;, for instance.
<!-- There is a test for the following case in t/examples.t: -->
<p>When multiple stow directories share a target tree, if a tree-folding
symlink is encountered and needs to be split open during an
installation, as long as the top-level stow directory into which the
existing symlink points contains <samp><span class="file">.stow</span></samp>, Stow knows how to split
open the tree in the correct manner.
<!-- =========================================================================== -->
</body></html>

85
local/share/doc/stow/manual-split/Other-FSF-Software.html Normal file
View file

@ -0,0 +1,85 @@
<html lang="en">
<head>
<title>Other FSF Software - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime" title="Compile-time vs Install-time">
<link rel="prev" href="GNU-Emacs.html#GNU-Emacs" title="GNU Emacs">
<link rel="next" href="Cygnus-Software.html#Cygnus-Software" title="Cygnus Software">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Other-FSF-Software"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Cygnus-Software.html#Cygnus-Software">Cygnus Software</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="GNU-Emacs.html#GNU-Emacs">GNU Emacs</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime">Compile-time vs Install-time</a>
<hr>
</div>
<h3 class="section">12.3 Other FSF Software</h3>
<p>The Free Software Foundation, the organization behind the GNU project,
has been unifying the build procedure for its tools for some time.
Thanks to its tools &lsquo;<samp><span class="samp">autoconf</span></samp>&rsquo; and &lsquo;<samp><span class="samp">automake</span></samp>&rsquo;, most packages
now respond well to these simple steps, with no other intervention
necessary:
<pre class="example"> ./configure <var>options</var>
make
make install prefix=/usr/local/stow/<var>package</var>
</pre>
<p>Hopefully, these tools can evolve to be aware of Stow-managed packages,
such that providing an option to &lsquo;<samp><span class="samp">configure</span></samp>&rsquo; can allow &lsquo;<samp><span class="samp">make</span></samp>&rsquo;
and &lsquo;<samp><span class="samp">make install</span></samp>&rsquo; steps to work correctly without needing to
&ldquo;fool&rdquo; the build process.
<!-- -->
</body></html>

150
local/share/doc/stow/manual-split/Perl-and-Perl-5-Modules.html Normal file
View file

@ -0,0 +1,150 @@
<html lang="en">
<head>
<title>Perl and Perl 5 Modules - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime" title="Compile-time vs Install-time">
<link rel="prev" href="Cygnus-Software.html#Cygnus-Software" title="Cygnus Software">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Perl-and-Perl-5-Modules"></a>
<p>
Previous:&nbsp;<a rel="previous" accesskey="p" href="Cygnus-Software.html#Cygnus-Software">Cygnus Software</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime">Compile-time vs Install-time</a>
<hr>
</div>
<h3 class="section">12.5 Perl and Perl 5 Modules</h3>
<p>Perl 4.036 allows you to specify different locations for installation
and for run-time. It is the only widely-used package in this author's
experience that allows this, though hopefully more packages will adopt
this model.
<p>Unfortunately, the authors of Perl believed that only AFS sites need
this ability. The configuration instructions for Perl 4 misleadingly
state that some occult means are used under AFS to transport files from
their installation tree to their run-time tree. In fact, that confusion
arises from the fact that Depot, Stow's predecessor, originated at
Carnegie Mellon University, which was also the birthplace of AFS. CMU's
need to separate install-time and run-time trees stemmed from its use of
Depot, not from AFS.
<p>The result of this confusion is that Perl 5's configuration script
doesn't even offer the option of separating install-time and run-time
trees <em>unless</em> you're running AFS. Fortunately, after you've
entered all the configuration settings, Perl's setup script gives you
the opportunity to edit those settings in a file called
<samp><span class="file">config.sh</span></samp>. When prompted, you should edit this file and replace
occurrences of
<pre class="example"> inst<span class="roman">...</span>/usr/local<span class="roman">...</span>
</pre>
<p class="noindent">with
<pre class="example"> inst<span class="roman">...</span>/usr/local/stow/perl<span class="roman">...</span>
</pre>
<p class="noindent">You can do this with the following Unix command:
<pre class="example"> sed 's,^\(inst.*/usr/local\),\1/stow/perl,' config.sh &gt; config.sh.new
mv config.sh.new config.sh
</pre>
<p>Hopefully, the Perl authors will correct this deficiency in Perl 5's
configuration mechanism.
<p>Perl 5 modules&mdash;i.e., extensions to Perl 5&mdash;generally conform to a set
of standards for building and installing them. The standard says that
the package comes with a top-level <samp><span class="file">Makefile.PL</span></samp>, which is a Perl
script. When it runs, it generates a <samp><span class="file">Makefile</span></samp>.
<p>If you followed the instructions above for editing <samp><span class="file">config.sh</span></samp> when
Perl was built, then when you create a <samp><span class="file">Makefile</span></samp> from a
<samp><span class="file">Makefile.PL</span></samp>, it will contain separate locations for run-time
(<samp><span class="file">/usr/local</span></samp>) and install-time (<samp><span class="file">/usr/local/stow/perl</span></samp>).
Thus you can do
<pre class="example"> perl Makefile.PL
make
make install
</pre>
<p class="noindent">and the files will be installed into <samp><span class="file">/usr/local/stow/perl</span></samp>.
However, you might prefer each Perl module to be stowed separately. In
that case, you must edit the resulting Makefile, replacing
<samp><span class="file">/usr/local/stow/perl</span></samp> with <samp><span class="file">/usr/local/stow/</span><var>module</var></samp>.
The best way to do this is:
<pre class="example"> perl Makefile.PL
find . -name Makefile -print | \
xargs perl -pi~ -e 's,^(INST.*/stow)/perl,$1/<var>module</var>,;'
make
make install
</pre>
<p class="noindent">(The use of &lsquo;<samp><span class="samp">find</span></samp>&rsquo; and &lsquo;<samp><span class="samp">xargs</span></samp>&rsquo; ensures that all Makefiles in
the module's source tree, even those in subdirectories, get edited.) A
good convention to follow is to name the stow directory for a Perl
<var>module</var> <samp><span class="file">cpan.</span><var>module</var></samp>, where &lsquo;<samp><span class="samp">cpan</span></samp>&rsquo; stands for
Comprehensive Perl Archive Network, a collection of FTP sites that is
the source of most Perl 5 extensions. This way, it's easy to tell at a
glance which of the subdirectories of <samp><span class="file">/usr/local/stow</span></samp> are Perl 5
extensions.
<p>When you stow separate Perl 5 modules separately, you are likely to
encounter conflicts (see <a href="Conflicts.html#Conflicts">Conflicts</a>) with files named <samp><span class="file">.exists</span></samp>
and <samp><span class="file">perllocal.pod</span></samp>. One way to work around this is to remove
those files before stowing the module. If you use the
<samp><span class="file">cpan.</span><var>module</var></samp> naming convention, you can simply do this:
<pre class="example"> cd /usr/local/stow
find cpan.* \( -name .exists -o -name perllocal.pod \) -print | \
xargs rm
</pre>
<!-- -->
</body></html>

98
local/share/doc/stow/manual-split/Reporting-Bugs.html Normal file
View file

@ -0,0 +1,98 @@
<html lang="en">
<head>
<title>Reporting Bugs - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Bootstrapping.html#Bootstrapping" title="Bootstrapping">
<link rel="next" href="Known-Bugs.html#Known-Bugs" title="Known Bugs">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Reporting-Bugs"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Known-Bugs.html#Known-Bugs">Known Bugs</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Bootstrapping.html#Bootstrapping">Bootstrapping</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">14 Reporting Bugs</h2>
<p>Please send bug reports to the current maintainers by electronic
mail. The address to use is &lsquo;<samp><span class="samp">&lt;bug-stow@gnu.org&gt;</span></samp>&rsquo;. Please
include:
<ul>
<li>the version number of Stow (&lsquo;<samp><span class="samp">stow --version</span></samp>&rsquo;);
<li>the version number of Perl (&lsquo;<samp><span class="samp">perl -v</span></samp>&rsquo;);
<li>the system information, which can often be obtained with &lsquo;<samp><span class="samp">uname
-a</span></samp>&rsquo;;
<li>a description of the bug;
<li>the precise command you gave;
<li>the output from the command (preferably verbose output, obtained by
adding &lsquo;<samp><span class="samp">--verbose=3</span></samp>&rsquo; to the Stow command line).
</ul>
<p>If you are really keen, consider developing a minimal test case and
creating a new test. See the <samp><span class="file">t/</span></samp> directory in the source for
lots of examples.
<p>Before reporting a bug, please read the manual carefully, especially
<a href="Known-Bugs.html#Known-Bugs">Known Bugs</a>, to see whether you're encountering
something that doesn't need reporting.
(see <a href="Conflicts.html#Conflicts">Conflicts</a>).
<!-- =========================================================================== -->
</body></html>

108
local/share/doc/stow/manual-split/Resource-Files.html Normal file
View file

@ -0,0 +1,108 @@
<html lang="en">
<head>
<title>Resource Files - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Target-Maintenance.html#Target-Maintenance" title="Target Maintenance">
<link rel="next" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime" title="Compile-time vs Install-time">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Resource-Files"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime">Compile-time vs Install-time</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Target-Maintenance.html#Target-Maintenance">Target Maintenance</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">11 Resource Files</h2>
<p><a name="index-resource-files-36"></a><a name="index-configuration-files-37"></a>
Default command line options may be set in <samp><span class="file">.stowrc</span></samp> (current directory) or
<samp><span class="file">~/.stowrc</span></samp> (home directory). These are parsed in that order, and effectively
prepended to you command line. This feature can be used for some interesting
effects.
<p>For example, suppose your site uses more than one stow directory, perhaps in
order to share around responsibilities with a number of systems
administrators. One of the administrators might have the following in their
<samp><span class="file">~/.stowrc</span></samp> file:
<pre class="example"> --dir=/usr/local/stow2
--target=/usr/local
--ignore='~'
--ignore='^CVS'
</pre>
<p>so that the <samp><span class="command">stow</span></samp> command will default to operating on the
<samp><span class="file">/usr/local/stow2</span></samp> directory, with <samp><span class="file">/usr/local</span></samp> as the
target, and ignoring vi backup files and CVS directories.
<p>If you had a stow directory <samp><span class="file">/usr/local/stow/perl-extras</span></samp> that
was only used for Perl modules, then you might place the following in
<samp><span class="file">/usr/local/stow/perl-extras/.stowrc</span></samp>:
<pre class="example"> --dir=/usr/local/stow/perl-extras
--target=/usr/local
--override=bin
--override=man
--ignore='perllocal\.pod'
--ignore='\.packlist'
--ignore='\.bs'
</pre>
<p>so that when you are in the <samp><span class="file">/usr/local/stow/perl-extras</span></samp>
directory, <samp><span class="command">stow</span></samp> will regard any subdirectories as stow
packages, with <samp><span class="file">/usr/local</span></samp> as the target (rather than the
immediate parent directory <samp><span class="file">/usr/local/stow</span></samp>), overriding any
pre-existing links to bin files or man pages, and ignoring some cruft
that gets installed by default.
<!-- =========================================================================== -->
</body></html>

98
local/share/doc/stow/manual-split/Target-Maintenance.html Normal file
View file

@ -0,0 +1,98 @@
<html lang="en">
<head>
<title>Target Maintenance - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Multiple-Stow-Directories.html#Multiple-Stow-Directories" title="Multiple Stow Directories">
<link rel="next" href="Resource-Files.html#Resource-Files" title="Resource Files">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Target-Maintenance"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Resource-Files.html#Resource-Files">Resource Files</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Multiple-Stow-Directories.html#Multiple-Stow-Directories">Multiple Stow Directories</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">10 Target Maintenance</h2>
<p><a name="index-maintenance-35"></a>From time to time you will need to clean up your target tree. Since
version 2, Stow provides a new utility <samp><span class="command">chkstow</span></samp> to help with
this. It includes three operational modes which performs checks that
would generally be too expensive to be performed during normal stow
execution.
<p>The syntax of the <samp><span class="command">chkstow</span></samp> command is:
<pre class="example"> chkstow [<var>options</var>]
</pre>
<p class="noindent">The following options are supported:
<dl>
<dt>&lsquo;<samp><span class="samp">-t </span><var>dir</var></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--target=</span><var>dir</var></samp>&rsquo;<dd>Set the target directory to <var>dir</var> instead of the parent of the stow
directory. Defaults to the parent of the stow directory, so it is typical to
execute <samp><span class="command">stow</span></samp> from the directory <samp><span class="file">/usr/local/stow</span></samp>.
<br><dt>&lsquo;<samp><span class="samp">-b</span></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--badlinks</span></samp>&rsquo;<dd>Checks target directory for bogus symbolic links. That is, links that point to
non-existent files.
<br><dt>&lsquo;<samp><span class="samp">-a</span></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--aliens</span></samp>&rsquo;<dd>Checks for files in the target directory that are not symbolic links. The
target directory should be managed by stow alone, except for directories that
contain a <samp><span class="file">.stow</span></samp> file.
<br><dt>&lsquo;<samp><span class="samp">-l</span></samp>&rsquo;<dt>&lsquo;<samp><span class="samp">--list</span></samp>&rsquo;<dd>Will display the target package for every symbolic link in the stow target
directory.
</dl>
<!-- =========================================================================== -->
</body></html>

113
local/share/doc/stow/manual-split/Terminology.html Normal file
View file

@ -0,0 +1,113 @@
<html lang="en">
<head>
<title>Terminology - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Introduction.html#Introduction" title="Introduction">
<link rel="next" href="Invoking-Stow.html#Invoking-Stow" title="Invoking Stow">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Terminology"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Invoking-Stow.html#Invoking-Stow">Invoking Stow</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Introduction.html#Introduction">Introduction</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">2 Terminology</h2>
<p class="indent"><a name="index-package-1"></a>A <dfn>package</dfn> is a related collection of files and directories that
you wish to administer as a unit &mdash; e.g., Perl or Emacs &mdash; and that needs
to be installed in a particular directory structure &mdash; e.g., with
<samp><span class="file">bin</span></samp>, <samp><span class="file">lib</span></samp>, and <samp><span class="file">man</span></samp> subdirectories.
<p><a name="index-target-directory-2"></a>A <dfn>target directory</dfn> is the root of a tree in which one or more
packages wish to <em>appear</em> to be installed. A common, but by no
means the only such location is <samp><span class="file">/usr/local</span></samp>. The examples in this
manual will use <samp><span class="file">/usr/local</span></samp> as the target directory.
<p><a name="index-stow-directory-3"></a>A <dfn>stow directory</dfn> is the root of a tree containing separate
packages in private subtrees. When Stow runs, it uses the current
directory as the default stow directory. The examples in this manual
will use <samp><span class="file">/usr/local/stow</span></samp> as the stow directory, so that
individual packages will be, for example, <samp><span class="file">/usr/local/stow/perl</span></samp>
and <samp><span class="file">/usr/local/stow/emacs</span></samp>.
<p><a name="index-installation-image-4"></a>An <dfn>installation image</dfn> is the layout of files and directories
required by a package, relative to the target directory. Thus, the
installation image for Perl includes: a <samp><span class="file">bin</span></samp> directory containing
<samp><span class="file">perl</span></samp> and <samp><span class="file">a2p</span></samp> (among others); an <samp><span class="file">info</span></samp> directory
containing Texinfo documentation; a <samp><span class="file">lib/perl</span></samp> directory containing
Perl libraries; and a <samp><span class="file">man/man1</span></samp> directory containing man pages.
<p><a name="index-package-directory-5"></a><a name="index-package-name-6"></a>A <dfn>package directory</dfn> is the root of a tree containing the
installation image for a particular package. Each package directory
must reside in a stow directory &mdash; e.g., the package directory
<samp><span class="file">/usr/local/stow/perl</span></samp> must reside in the stow directory
<samp><span class="file">/usr/local/stow</span></samp>. The <dfn>name</dfn> of a package is the name of its
directory within the stow directory &mdash; e.g., <samp><span class="file">perl</span></samp>.
<p>Thus, the Perl executable might reside in
<samp><span class="file">/usr/local/stow/perl/bin/perl</span></samp>, where <samp><span class="file">/usr/local</span></samp> is the
target directory, <samp><span class="file">/usr/local/stow</span></samp> is the stow directory,
<samp><span class="file">/usr/local/stow/perl</span></samp> is the package directory, and
<samp><span class="file">bin/perl</span></samp> within is part of the installation image.
<p><a name="index-symlink-7"></a><a name="index-relative-symlink-8"></a><a name="index-absolute-symlink-9"></a>A <dfn>symlink</dfn> is a symbolic link. A symlink can be <dfn>relative</dfn> or
<dfn>absolute</dfn>. An absolute symlink names a full path; that is, one
starting from <samp><span class="file">/</span></samp>. A relative symlink names a relative path; that
is, one not starting from <samp><span class="file">/</span></samp>. The target of a relative symlink is
computed starting from the symlink's own directory. Stow only
creates relative symlinks.
<!-- =========================================================================== -->
</body></html>

1
local/share/doc/stow/manual-split/Tree-unfolding.html Normal file
View file

@ -0,0 +1 @@
<meta http-equiv="refresh" content="0; url=Installing-Packages.html#Tree%20unfolding">

167
local/share/doc/stow/manual-split/Types-And-Syntax-Of-Ignore-Lists.html Normal file
View file

@ -0,0 +1,167 @@
<html lang="en">
<head>
<title>Types And Syntax Of Ignore Lists - Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Ignore-Lists.html#Ignore-Lists" title="Ignore Lists">
<link rel="prev" href="Motivation-For-Ignore-Lists.html#Motivation-For-Ignore-Lists" title="Motivation For Ignore Lists">
<link rel="next" href="Justification-For-Yet-Another-Set-Of-Ignore-Files.html#Justification-For-Yet-Another-Set-Of-Ignore-Files" title="Justification For Yet Another Set Of Ignore Files">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled ``GNU General Public License'' is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Types-And-Syntax-Of-Ignore-Lists"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Justification-For-Yet-Another-Set-Of-Ignore-Files.html#Justification-For-Yet-Another-Set-Of-Ignore-Files">Justification For Yet Another Set Of Ignore Files</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Motivation-For-Ignore-Lists.html#Motivation-For-Ignore-Lists">Motivation For Ignore Lists</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Ignore-Lists.html#Ignore-Lists">Ignore Lists</a>
<hr>
</div>
<h3 class="section">4.2 Types And Syntax Of Ignore Lists</h3>
<p>If you put Perl regular expressions, one per line, in a
<samp><span class="file">.stow-local-ignore</span></samp> file within any top level package directory,
in which case any file or directory within that package matching any
of these regular expressions will be ignored. In the absence of this
package-specific ignore list, Stow will instead use the contents of
<samp><span class="file">~/.stow-global-ignore</span></samp>, if it exists. If neither the
package-local or global ignore list exist, Stow will use its own
built-in default ignore list, which serves as a useful example of the
format of these ignore list files:
<pre class="example"><pre class="verbatim"> # Comments and blank lines are allowed.
RCS
.+,v
CVS
\.\#.+ # CVS conflict files / emacs lock files
\.cvsignore
\.svn
_darcs
\.hg
\.git
\.gitignore
.+~ # emacs backup files
\#.*\# # emacs autosave files
^/README.*
^/LICENSE.*
^/COPYING
</pre></pre>
<p>Stow first iterates through the chosen ignore list (built-in, global,
or package-local) as per above, stripping out comments (if you want to
include the &lsquo;<samp><span class="samp">#</span></samp>&rsquo; symbol in a regular expression, escape it with a
blackslash) and blank lines, placing each regular expressions into one
of two sets depending on whether it contains the &lsquo;<samp><span class="samp">/</span></samp>&rsquo; forward
slash symbol.
<p>Then in order to determine whether a file or directory should be
ignored:
<ol type=1 start=1>
<li>Stow calculates its path relative to the top-level package directory,
prefixing that with &lsquo;<samp><span class="samp">/</span></samp>&rsquo;. If any of the regular expressions
containing a &lsquo;<samp><span class="samp">/</span></samp>&rsquo; <em>exactly</em><a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a> match
a subpath<a rel="footnote" href="#fn-2" name="fnd-2"><sup>2</sup></a> of this relative path, then the file or
directory will be ignored.
<li>If none of the regular expressions containing a &lsquo;<samp><span class="samp">/</span></samp>&rsquo; match in the
manner described above, Stow checks whether the
<em>basename</em><a rel="footnote" href="#fn-3" name="fnd-3"><sup>3</sup></a> of the file or directory matches
<em>exactly</em> against the remaining regular expressions which do not
contain a &lsquo;<samp><span class="samp">/</span></samp>&rsquo;, and if so, ignores the file or directory.
<li>Otherwise, the file or directory is not ignored.
</ol>
<!-- N.B. if you change the examples below, please also consider -->
<!-- updating test_examples_in_manual() in t/ignore.t. -->
<p>For example, if a file <samp><span class="file">bazqux</span></samp> is in the <samp><span class="file">foo/bar</span></samp>
subdirectory of the package directory, Stow would use
&lsquo;<samp><span class="samp">/foo/bar/bazqux</span></samp>&rsquo; as the text for matching against regular
expressions which contain &lsquo;<samp><span class="samp">/</span></samp>&rsquo;, and &lsquo;<samp><span class="samp">bazqux</span></samp>&rsquo; as the text for
matching against regular expressions which don't contain &lsquo;<samp><span class="samp">/</span></samp>&rsquo;.
Then regular expressions &lsquo;<samp><span class="samp">bazqux</span></samp>&rsquo;, &lsquo;<samp><span class="samp">baz.*</span></samp>&rsquo;, &lsquo;<samp><span class="samp">.*qux</span></samp>&rsquo;,
&lsquo;<samp><span class="samp">bar/.*x</span></samp>&rsquo;, and &lsquo;<samp><span class="samp">^/foo/.*qux</span></samp>&rsquo; would all match (causing the
file to be ignored), whereas &lsquo;<samp><span class="samp">bar</span></samp>&rsquo;, &lsquo;<samp><span class="samp">baz</span></samp>&rsquo;, &lsquo;<samp><span class="samp">qux</span></samp>&rsquo;, and
&lsquo;<samp><span class="samp">o/bar/b</span></samp>&rsquo; would not (although &lsquo;<samp><span class="samp">bar</span></samp>&rsquo; would cause its parent
directory to be ignored and prevent Stow from recursing into that
anyway, in which case the file <samp><span class="file">bazqux</span></samp> would not even be
considered for stowing).
<p>As a special exception to the above algorithm, any
<samp><span class="file">.stow-local-ignore</span></samp> present in the top-level package directory
is <em>always</em> ignored, regardless of the contents of any ignore
list, because this file serves no purpose outside the stow directory.
<!-- =========================================================================== -->
<div class="footnote">
<hr>
<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> Exact matching means the
regular expression is anchored at the beginning and end, in contrast
to unanchored regular expressions which will match a substring.</p>
<p class="footnote"><small>[<a name="fn-2" href="#fnd-2">2</a>]</small> In this context, &ldquo;subpath&rdquo; means a contiguous
subset of path segments; e.g for the relative path
<samp><span class="file">one/two/three</span></samp>, there are six valid subpaths: <samp><span class="file">one</span></samp>,
<samp><span class="file">two</span></samp>, <samp><span class="file">three</span></samp>, <samp><span class="file">one/two</span></samp>, <samp><span class="file">two/three</span></samp>,
<samp><span class="file">one/two/three</span></samp>.</p>
<p class="footnote"><small>[<a name="fn-3" href="#fnd-3">3</a>]</small> The &ldquo;basename&rdquo; is the name of the file or
directory itself, excluding any directory path prefix - as returned by
the <samp><span class="command">basename</span></samp> command.</p>
<hr></div>
</body></html>

164
local/share/doc/stow/manual-split/index.html Normal file
View file

@ -0,0 +1,164 @@
<html lang="en">
<head>
<title>Stow</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Stow">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="#Top">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual describes GNU Stow version 2.2.2
(9 November 2015), a program for managing the installation of software
packages.
Software and documentation is copyrighted by the following:
(C) 1993, 1994, 1995, 1996 Bob Glickstein <bobg+stow@zanshin.com>
(C) 2000, 2001 Guillaume Morin <gmorin@gnu.org>
(C) 2007 Kahlil (Kal) Hodgson <kahlil@internode.on.net>
(C) 2011 Adam Spiers <stow@adamspiers.org>
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission
notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided
also that the section entitled "GNU General Public License" is
included with the modified manual, and provided that the entire
resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for
modified versions, except that this permission notice may be
stated in a translation approved by the Free Software Foundation.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<h1 class="settitle">Stow</h1>
<div class="contents">
<h2>Table of Contents</h2>
<ul>
<li><a name="toc_Top" href="index.html#Top">Stow</a>
<li><a name="toc_Introduction" href="Introduction.html#Introduction">1 Introduction</a>
<li><a name="toc_Terminology" href="Terminology.html#Terminology">2 Terminology</a>
<li><a name="toc_Invoking-Stow" href="Invoking-Stow.html#Invoking-Stow">3 Invoking Stow</a>
<li><a name="toc_Ignore-Lists" href="Ignore-Lists.html#Ignore-Lists">4 Ignore Lists</a>
<ul>
<li><a href="Motivation-For-Ignore-Lists.html#Motivation-For-Ignore-Lists">4.1 Motivation For Ignore Lists</a>
<li><a href="Types-And-Syntax-Of-Ignore-Lists.html#Types-And-Syntax-Of-Ignore-Lists">4.2 Types And Syntax Of Ignore Lists</a>
<li><a href="Justification-For-Yet-Another-Set-Of-Ignore-Files.html#Justification-For-Yet-Another-Set-Of-Ignore-Files">4.3 Justification For Yet Another Set Of Ignore Files</a>
</li></ul>
<li><a name="toc_Installing-Packages" href="Installing-Packages.html#Installing-Packages">5 Installing Packages</a>
<ul>
<li><a href="Installing-Packages.html#Installing-Packages">5.1 Tree folding</a>
<li><a href="Installing-Packages.html#Installing-Packages">5.2 Tree unfolding</a>
<li><a href="Installing-Packages.html#Installing-Packages">5.3 Ownership</a>
<li><a href="Installing-Packages.html#Installing-Packages">5.4 Conflicts during installation</a>
</li></ul>
<li><a name="toc_Deleting-Packages" href="Deleting-Packages.html#Deleting-Packages">6 Deleting Packages</a>
<ul>
<li><a href="Deleting-Packages.html#Deleting-Packages">6.1 Refolding &ldquo;foldable&rdquo; trees.</a>
</li></ul>
<li><a name="toc_Conflicts" href="Conflicts.html#Conflicts">7 Conflicts</a>
<ul>
<li><a href="Conflicts.html#Conflicts">7.1 Deferred Operation</a>
</li></ul>
<li><a name="toc_Mixing-Operations" href="Mixing-Operations.html#Mixing-Operations">8 Mixing Operations</a>
<li><a name="toc_Multiple-Stow-Directories" href="Multiple-Stow-Directories.html#Multiple-Stow-Directories">9 Multiple Stow Directories</a>
<li><a name="toc_Target-Maintenance" href="Target-Maintenance.html#Target-Maintenance">10 Target Maintenance</a>
<li><a name="toc_Resource-Files" href="Resource-Files.html#Resource-Files">11 Resource Files</a>
<li><a name="toc_Compile_002dtime-vs-Install_002dtime" href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime">12 Compile-time vs Install-time</a>
<ul>
<li><a href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime">12.1 Advice on changing compilation and installation parameters</a>
<li><a href="GNU-Emacs.html#GNU-Emacs">12.2 GNU Emacs</a>
<li><a href="Other-FSF-Software.html#Other-FSF-Software">12.3 Other FSF Software</a>
<li><a href="Cygnus-Software.html#Cygnus-Software">12.4 Cygnus Software</a>
<li><a href="Perl-and-Perl-5-Modules.html#Perl-and-Perl-5-Modules">12.5 Perl and Perl 5 Modules</a>
</li></ul>
<li><a name="toc_Bootstrapping" href="Bootstrapping.html#Bootstrapping">13 Bootstrapping</a>
<li><a name="toc_Reporting-Bugs" href="Reporting-Bugs.html#Reporting-Bugs">14 Reporting Bugs</a>
<li><a name="toc_Known-Bugs" href="Known-Bugs.html#Known-Bugs">15 Known Bugs</a>
<li><a name="toc_GNU-General-Public-License" href="GNU-General-Public-License.html#GNU-General-Public-License">GNU General Public License</a>
<ul>
<li><a href="GNU-General-Public-License.html#GNU-General-Public-License">Preamble</a>
<li><a href="GNU-General-Public-License.html#GNU-General-Public-License">How to Apply These Terms to Your New Programs</a>
</li></ul>
<li><a name="toc_Index" href="Index.html#Index">Index</a>
</li></ul>
</div>
<!-- ========================================================================== -->
<div class="node">
<a name="Top"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Introduction.html#Introduction">Introduction</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="../index.html#dir">(dir)</a>
<hr>
</div>
<h2 class="unnumbered">Stow</h2>
<ul class="menu">
<li><a accesskey="1" href="Introduction.html#Introduction">Introduction</a>: Description of Stow.
<li><a accesskey="2" href="Terminology.html#Terminology">Terminology</a>: Terms used by this manual.
<li><a accesskey="3" href="Invoking-Stow.html#Invoking-Stow">Invoking Stow</a>: Option summary.
<li><a accesskey="4" href="Ignore-Lists.html#Ignore-Lists">Ignore Lists</a>: Controlling what gets stowed.
<li><a accesskey="5" href="Installing-Packages.html#Installing-Packages">Installing Packages</a>: Using Stow to install.
<li><a accesskey="6" href="Deleting-Packages.html#Deleting-Packages">Deleting Packages</a>: Using Stow to uninstall.
<li><a accesskey="7" href="Conflicts.html#Conflicts">Conflicts</a>: When Stow can't stow.
<li><a accesskey="8" href="Mixing-Operations.html#Mixing-Operations">Mixing Operations</a>: Multiple actions per invocation.
<li><a accesskey="9" href="Multiple-Stow-Directories.html#Multiple-Stow-Directories">Multiple Stow Directories</a>: Further segregating software.
<li><a href="Target-Maintenance.html#Target-Maintenance">Target Maintenance</a>: Cleaning up mistakes.
<li><a href="Resource-Files.html#Resource-Files">Resource Files</a>: Setting default command line options.
<li><a href="Compile_002dtime-vs-Install_002dtime.html#Compile_002dtime-vs-Install_002dtime">Compile-time vs Install-time</a>: Faking out `make install'.
<li><a href="Bootstrapping.html#Bootstrapping">Bootstrapping</a>: When stow and perl are not yet stowed.
<li><a href="Reporting-Bugs.html#Reporting-Bugs">Reporting Bugs</a>: How, what, where, and when to report.
<li><a href="Known-Bugs.html#Known-Bugs">Known Bugs</a>: Don't report any of these.
<li><a href="GNU-General-Public-License.html#GNU-General-Public-License">GNU General Public License</a>: Copying terms.
<li><a href="Index.html#Index">Index</a>: Index of concepts.
</li></ul>
<p>--- The Detailed Node Listing ---
<p>Ignore Lists
</p>
<ul class="menu">
<li><a href="Motivation-For-Ignore-Lists.html#Motivation-For-Ignore-Lists">Motivation For Ignore Lists</a>
<li><a href="Types-And-Syntax-Of-Ignore-Lists.html#Types-And-Syntax-Of-Ignore-Lists">Types And Syntax Of Ignore Lists</a>
<li><a href="Justification-For-Yet-Another-Set-Of-Ignore-Files.html#Justification-For-Yet-Another-Set-Of-Ignore-Files">Justification For Yet Another Set Of Ignore Files</a>
</li></ul>
<p>Advice on changing compilation and installation parameters
</p>
<ul class="menu">
<li><a href="GNU-Emacs.html#GNU-Emacs">GNU Emacs</a>
<li><a href="Other-FSF-Software.html#Other-FSF-Software">Other FSF Software</a>
<li><a href="Cygnus-Software.html#Cygnus-Software">Cygnus Software</a>
<li><a href="Perl-and-Perl-5-Modules.html#Perl-and-Perl-5-Modules">Perl and Perl 5 Modules</a>
</ul>
<!-- =========================================================================== -->
</body></html>

1
local/share/doc/stow/manual-split/tree-folding.html Normal file
View file

@ -0,0 +1 @@
<meta http-equiv="refresh" content="0; url=Installing-Packages.html#tree%20folding">

1
local/share/doc/stow/manual-split/tree-refolding.html Normal file
View file

@ -0,0 +1 @@
<meta http-equiv="refresh" content="0; url=Deleting-Packages.html#tree%20refolding">

BIN
local/share/doc/stow/manual.pdf Normal file
View file

Binary file not shown.

4
local/share/doc/stow/version.texi Normal file
View file

@ -0,0 +1,4 @@
@set UPDATED 9 November 2015
@set UPDATED-MONTH November 2015
@set EDITION 2.2.2
@set VERSION 2.2.2

4
dot-local/share/info/dir → local/share/info/dir
View file

@ -5,7 +5,7 @@ The first time you invoke Info you start off looking at this node.
File: dir, Node: Top This is the top of the INFO tree
This (the Directory node) gives a menu of major topics.
Typing "q" exits, "H" lists all Info commands, "d" returns here,
Typing "q" exits, "?" lists all Info commands, "d" returns here,
"h" gives a primer for first-timers,
"mEmacs<Return>" visits the Emacs manual, etc.
@ -15,4 +15,4 @@ File: dir, Node: Top This is the top of the INFO tree
* Menu:
System administration
* Stow: (stow). GNU Stow.
* Stow: (stow). GNU Stow.

1585
local/share/info/stow.info Normal file
View file

File diff suppressed because it is too large Load diff

322
dot-local/share/man/man8/stow.8 → local/share/man/man8/stow.8
View file

@ -1,5 +1,4 @@
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
@ -16,12 +15,29 @@
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
@ -30,7 +46,7 @@
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
@ -40,61 +56,122 @@
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "stow 8"
.TH stow 8 2023-10-23 "perl v5.38.0" "User Contributed Perl Documentation"
.IX Title "IO::FILE=IO(0X81D9F0) 1"
.TH IO::FILE=IO(0X81D9F0) 1 "2015-11-09" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
stow \- manage farms of symbolic links
.SH SYNOPSIS
.SH "NAME"
stow \- software package installation manager
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
stow [ options ] package ...
.SH DESCRIPTION
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This manual page describes GNU Stow 2.3.2. This is not the
definitive documentation for Stow; for that, see the accompanying info
manual, e.g. by typing \f(CW\*(C`info stow\*(C'\fR.
This manual page describes \s-1GNU\s0 Stow 2.2.2, a program for managing
the installation of software packages. This is not the definitive
documentation for stow; for that, see the info manual.
.PP
Stow is a symlink farm manager 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.
Stow is a tool for managing the installation of multiple software
packages in the same run-time directory tree. One historical
difficulty of this task has been the need to administer, upgrade,
install, and remove files in independent packages without confusing
them with other files sharing the same filesystem space. For instance,
it is common to install Perl and Emacs in \fI/usr/local\fR. When one
does so, one winds up (as of Perl 4.036 and Emacs 19.22) with the
following files in \fI/usr/local/man/man1\fR: \fIa2p.1\fR; \fIctags.1\fR;
\&\fIemacs.1\fR; \fIetags.1\fR; \fIh2ph.1\fR; \fIperl.1\fR; and \fIs2p.1\fR. Now
suppose it's time to uninstall Perl. Which man pages get removed?
Obviously \fIperl.1\fR is one of them, but it should not be the
administrator's responsibility to memorize the ownership of individual
files by separate packages.
.PP
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. By using Stow, \fI/usr/local/bin\fR
could contain symlinks to files within \fI/usr/local/stow/emacs/bin\fR,
\&\fI/usr/local/stow/perl/bin\fR etc., and likewise recursively for any
other subdirectories such as \fI.../share\fR, \fI.../man\fR, and so on.
.PP
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.
.PP
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.
The approach used by Stow is to install each package into its own
tree, then use symbolic links to make it appear as though the files
are installed in the common tree. Administration can be performed in
the package's private tree in isolation from clutter from other
packages. Stow can then be used to update the symbolic links. The
structure of each private tree should reflect the desired structure in
the common tree; i.e. (in the typical case) there should be a \fIbin\fR
directory containing executables, a \fIman/man1\fR directory containing
section 1 man pages, and so on.
.PP
Stow was inspired by Carnegie Mellon's Depot program, but is
substantially simpler and safer. Whereas Depot required database files
@ -104,41 +181,38 @@ 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., \fI/usr/local/stow/emacs\fR), so it's always
possible to rebuild the target tree (e.g., \fI/usr/local\fR).
.PP
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.
.SH TERMINOLOGY
.SH "TERMINOLOGY"
.IX Header "TERMINOLOGY"
A "package" is a related collection of files and directories that
you wish to administer as a unit \-\- e.g., Perl or Emacs \-\- and that
needs to be installed in a particular directory structure \-\- e.g.,
A \*(L"package\*(R" is a related collection of files and directories that
you wish to administer as a unit \*(-- e.g., Perl or Emacs \*(-- and that
needs to be installed in a particular directory structure \*(-- e.g.,
with \fIbin\fR, \fIlib\fR, and \fIman\fR subdirectories.
.PP
A "target directory" is the root of a tree in which one or more
A \*(L"target directory\*(R" is the root of a tree in which one or more
packages wish to \fBappear\fR to be installed. A common, but by no means
the only such location is \fI/usr/local\fR. The examples in this manual
page will use \fI/usr/local\fR as the target directory.
.PP
A "stow directory" is the root of a tree containing separate
A \*(L"stow directory\*(R" is the root of a tree containing separate
packages in private subtrees. When Stow runs, it uses the current
directory as the default stow directory. The examples in this manual
page will use \fI/usr/local/stow\fR as the stow directory, so that
individual packages will be, for example, \fI/usr/local/stow/perl\fR and
\&\fI/usr/local/stow/emacs\fR.
.PP
An "installation image" is the layout of files and directories
An \*(L"installation image\*(R" is the layout of files and directories
required by a package, relative to the target directory. Thus, the
installation image for Perl includes: a \fIbin\fR directory containing
\&\fIperl\fR and \fIa2p\fR (among others); an \fIinfo\fR directory containing
Texinfo documentation; a \fIlib/perl\fR directory containing Perl
libraries; and a \fIman/man1\fR directory containing man pages.
.PP
A "package directory" is the root of a tree containing the
A \*(L"package directory\*(R" is the root of a tree containing the
installation image for a particular package. Each package directory
must reside in a stow directory \-\- e.g., the package directory
must reside in a stow directory \*(-- e.g., the package directory
\&\fI/usr/local/stow/perl\fR must reside in the stow directory
\&\fI/usr/local/stow\fR. The "name" of a package is the name of its
directory within the stow directory \-\- e.g., \fIperl\fR.
\&\fI/usr/local/stow\fR. The \*(L"name\*(R" of a package is the name of its
directory within the stow directory \*(-- e.g., \fIperl\fR.
.PP
Thus, the Perl executable might reside in
\&\fI/usr/local/stow/perl/bin/perl\fR, where \fI/usr/local\fR is the target
@ -146,13 +220,13 @@ directory, \fI/usr/local/stow\fR is the stow directory,
\&\fI/usr/local/stow/perl\fR is the package directory, and \fIbin/perl\fR
within is part of the installation image.
.PP
A "symlink" is a symbolic link. A symlink can be "relative" or
"absolute". An absolute symlink names a full path; that is, one
A \*(L"symlink\*(R" is a symbolic link. A symlink can be \*(L"relative\*(R" or
\&\*(L"absolute\*(R". An absolute symlink names a full path; that is, one
starting from \fI/\fR. A relative symlink names a relative path; that
is, one not starting from \fI/\fR. The target of a relative symlink is
computed starting from the symlink's own directory. Stow only creates
relative symlinks.
.SH OPTIONS
.SH "OPTIONS"
.IX Header "OPTIONS"
The stow directory is assumed to be the value of the \f(CW\*(C`STOW_DIR\*(C'\fR
environment variable or if unset the current directory, and the target
@ -162,71 +236,69 @@ Each \fIpackage\fR given on the command line is the name of a package in
the stow directory (e.g., \fIperl\fR). By default, they are installed
into the target directory (but they can be deleted instead using
\&\f(CW\*(C`\-D\*(C'\fR).
.IP \-n 4
.IP "\-n" 4
.IX Item "-n"
.PD 0
.IP \-\-no 4
.IP "\-\-no" 4
.IX Item "--no"
.IP \-\-simulate 4
.IX Item "--simulate"
.PD
Do not perform any operations that modify the filesystem; merely show
what would happen.
.IP "\-d DIR" 4
.IP "\-d \s-1DIR\s0" 4
.IX Item "-d DIR"
.PD 0
.IP \-\-dir=DIR 4
.IP "\-\-dir=DIR" 4
.IX Item "--dir=DIR"
.PD
Set the stow directory to \f(CW\*(C`DIR\*(C'\fR instead of the current directory.
This also has the effect of making the default target directory be the
parent of \f(CW\*(C`DIR\*(C'\fR.
.IP "\-t DIR" 4
.IP "\-t \s-1DIR\s0" 4
.IX Item "-t DIR"
.PD 0
.IP \-\-target=DIR 4
.IP "\-\-target=DIR" 4
.IX Item "--target=DIR"
.PD
Set the target directory to \f(CW\*(C`DIR\*(C'\fR instead of the parent of the stow
directory.
.IP \-v 4
.IP "\-v" 4
.IX Item "-v"
.PD 0
.IP \-\-verbose[=N] 4
.IP "\-\-verbose[=N]" 4
.IX Item "--verbose[=N]"
.PD
Send verbose output to standard error describing what Stow is
doing. Verbosity levels are from 0 to 5; 0 is the default.
doing. Verbosity levels are 0, 1, 2, 3, and 4; 0 is the default.
Using \f(CW\*(C`\-v\*(C'\fR or \f(CW\*(C`\-\-verbose\*(C'\fR increases the verbosity by one; using
`\-\-verbose=N' sets it to N.
.IP \-S 4
.IP "\-S" 4
.IX Item "-S"
.PD 0
.IP \-\-stow 4
.IP "\-\-stow" 4
.IX Item "--stow"
.PD
Stow the packages that follow this option into the target directory.
This is the default action and so can be omitted if you are only
stowing packages rather than performing a mixture of
stow/delete/restow actions.
.IP \-D 4
.IP "\-D" 4
.IX Item "-D"
.PD 0
.IP \-\-delete 4
.IP "\-\-delete" 4
.IX Item "--delete"
.PD
Unstow the packages that follow this option from the target directory rather
than installing them.
.IP \-R 4
.IP "\-R" 4
.IX Item "-R"
.PD 0
.IP \-\-restow 4
.IP "\-\-restow" 4
.IX Item "--restow"
.PD
Restow packages (first unstow, then stow again). This is useful
for pruning obsolete symlinks from the target tree after updating
the software in a package.
.IP \-\-adopt 4
.IP "\-\-adopt" 4
.IX Item "--adopt"
\&\fBWarning!\fR This behaviour is specifically intended to alter the
contents of your stow directory. If you do not want that, this option
@ -240,47 +312,32 @@ same relative place within the package's installation image within the
stow directory, and then stowing proceeds as before. So effectively,
the file becomes adopted by the stow package, without its contents
changing.
.IP \-\-no\-folding 4
.IP "\-\-no\-folding" 4
.IX Item "--no-folding"
Disable folding of newly stowed directories when stowing, and
refolding of newly foldable directories when unstowing.
.IP \-\-ignore=REGEX 4
.IP "\-\-ignore=REGEX" 4
.IX Item "--ignore=REGEX"
Ignore files ending in this Perl regex.
.IP \-\-defer=REGEX 4
.IP "\-\-defer=REGEX" 4
.IX Item "--defer=REGEX"
Don't stow files beginning with this Perl regex if the file is already
stowed to another package.
.IP \-\-override=REGEX 4
.IP "\-\-override=REGEX" 4
.IX Item "--override=REGEX"
Force stowing files beginning with this Perl regex if the file is
already stowed to another package.
.IP \-\-dotfiles 4
.IX Item "--dotfiles"
Enable special handling for "dotfiles" (files or folders whose name
begins with a period) in the package directory. If this option is
enabled, Stow will add a preprocessing step for each file or folder
whose name begins with "dot\-", and replace the "dot\-" prefix in the
name by a period (.). This is useful when Stow is used to manage
collections of dotfiles, to avoid having a package directory full of
hidden files.
.Sp
For example, suppose we have a package containing two files,
\&\fIstow/dot\-bashrc\fR and \fIstow/dot\-emacs.d/init.el\fR. With this option,
Stow will create symlinks from \fI.bashrc\fR to \fIstow/dot\-bashrc\fR and
from \fI.emacs.d/init.el\fR to \fIstow/dot\-emacs.d/init.el\fR. Any other
files, whose name does not begin with "dot\-", will be processed as usual.
.IP \-V 4
.IP "\-V" 4
.IX Item "-V"
.PD 0
.IP \-\-version 4
.IP "\-\-version" 4
.IX Item "--version"
.PD
Show Stow version number, and exit.
.IP \-h 4
.IP "\-h" 4
.IX Item "-h"
.PD 0
.IP \-\-help 4
.IP "\-\-help" 4
.IX Item "--help"
.PD
Show Stow command syntax, and exit.
@ -303,8 +360,8 @@ symlinks to \fI../stow/perl/bin/perl\fR and \fI../stow/perl/bin/a2p\fR (and
so on), Stow will create a single symlink, \fI/usr/local/bin\fR, which
points to \fIstow/perl/bin\fR. In this way, it still works to refer to
\&\fI/usr/local/bin/perl\fR and \fI/usr/local/bin/a2p\fR, and fewer symlinks
have been created. This is called "tree folding", since an entire
subtree is "folded" into a single symlink.
have been created. This is called \*(L"tree folding\*(R", since an entire
subtree is \*(L"folded\*(R" into a single symlink.
.PP
To complete this example, Stow will also create the symlink
\&\fI/usr/local/info\fR pointing to \fIstow/perl/info\fR; the symlink
@ -326,7 +383,7 @@ tree-folding symlink.
.PP
The time often comes when a tree-folding symlink has to be undone
because another package uses one or more of the folded subdirectories
in its installation image. This operation is called "splitting open"
in its installation image. This operation is called \*(L"splitting open\*(R"
a folded tree. It involves removing the original symlink from the
target tree, creating a true directory in its place, and then
populating the new directory with symlinks to the newly-installed
@ -348,55 +405,34 @@ it is about to remove points inside a valid package in the current stow
directory.
.SS "Stow will never delete anything that it doesn't own."
.IX Subsection "Stow will never delete anything that it doesn't own."
Stow "owns" everything living in the target tree that points into a
Stow \*(L"owns\*(R" everything living in the target tree that points into a
package in the stow directory. Anything Stow owns, it can recompute if
lost. Note that by this definition, Stow doesn't "own" anything
lost. Note that by this definition, Stow doesn't \*(L"own\*(R" anything
\&\fBin\fR the stow directory or in any of the packages.
.PP
If Stow needs to create a directory or a symlink in the target tree
and it cannot because that name is already in use and is not owned by
Stow, then a conflict has arisen. See the "Conflicts" section in the
Stow, then a conflict has arisen. See the \*(L"Conflicts\*(R" section in the
info manual.
.SH "DELETING PACKAGES"
.IX Header "DELETING PACKAGES"
When the \f(CW\*(C`\-D\*(C'\fR option is given, the action of Stow is to delete a
package from the target tree. Note that Stow will not delete anything
it doesn't "own". Deleting a package does \fBnot\fR mean removing it from
it doesn't \*(L"own\*(R". Deleting a package does \fBnot\fR mean removing it from
the stow directory or discarding the package tree.
.PP
To delete a package, Stow recursively scans the target tree, skipping
over the stow directory (since that is usually a subdirectory of the
target tree) and any other stow directories it encounters (see
"Multiple stow directories" in the info manual). Any symlink it
\&\*(L"Multiple stow directories\*(R" in the info manual). Any symlink it
finds that points into the package being deleted is removed. Any
directory that contained only symlinks to the package being deleted is
removed. Any directory that, after removing symlinks and empty
subdirectories, contains only symlinks to a single other package, is
considered to be a previously "folded" tree that was "split open."
considered to be a previously \*(L"folded\*(R" tree that was \*(L"split open.\*(R"
Stow will re-fold the tree by removing the symlinks to the surviving
package, removing the directory, then linking the directory back to
the surviving package.
.SH "RESOURCE FILES"
.IX Header "RESOURCE FILES"
\&\fIStow\fR searches for default command line options at \fI.stowrc\fR (current
directory) and \fI~/.stowrc\fR (home directory) in that order. If both
locations are present, the files are effectively appended together.
.PP
The effect of options in the resource file is similar to simply prepending
the options to the command line. For options that provide a single value,
such as \fI\-\-target\fR or \fI\-\-dir\fR, the command line option will overwrite any
options in the resource file. For options that can be given more than once,
\&\fI\-\-ignore\fR for example, command line options and resource options are
appended together.
.PP
Environment variables and the tilde character (\fI~\fR) will be expanded for
options that take a file path.
.PP
The options \fI\-D\fR, \fI\-R\fR, \fI\-S\fR, and any packages listed in the resource
file are ignored.
.PP
See the info manual for more information on how stow handles resource
file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
The full documentation for \fIstow\fR is maintained as a Texinfo manual.
@ -407,46 +443,46 @@ If the \fIinfo\fR and \fIstow\fR programs are properly installed at your site, t
.Ve
.PP
should give you access to the complete manual.
.SH BUGS
.SH "BUGS"
.IX Header "BUGS"
Please report bugs in Stow using the Debian bug tracking system.
.PP
Currently known bugs include:
.IP \(bu 4
.IP "\(bu" 4
The empty-directory problem.
.Sp
If package \fIfoo\fR includes an empty directory \-\- say, \fIfoo/bar\fR \-\-
If package \fIfoo\fR includes an empty directory \*(-- say, \fIfoo/bar\fR \*(--
then if no other package has a \fIbar\fR subdirectory, everything's fine.
If another stowed package \fIquux\fR, has a \fIbar\fR subdirectory, then
when stowing, \fItargetdir/bar\fR will be "split open" and the contents
when stowing, \fItargetdir/bar\fR will be \*(L"split open\*(R" and the contents
of \fIquux/bar\fR will be individually stowed. So far, so good. But when
unstowing \fIquux\fR, \fItargetdir/bar\fR will be removed, even though
\&\fIfoo/bar\fR needs it to remain. A workaround for this problem is to
create a file in \fIfoo/bar\fR as a placeholder. If you name that file
\&\fI.placeholder\fR, it will be easy to find and remove such files when
this bug is fixed.
.IP \(bu 4
When using multiple stow directories (see "Multiple stow directories"
in the info manual), Stow fails to "split open" tree-folding symlinks
(see "Installing packages" in the info manual) that point into a stow
.IP "\(bu" 4
When using multiple stow directories (see \*(L"Multiple stow directories\*(R"
in the info manual), Stow fails to \*(L"split open\*(R" tree-folding symlinks
(see \*(L"Installing packages\*(R" in the info manual) that point into a stow
directory which is not the one in use by the current Stow
command. Before failing, it should search the target of the link to
see whether any element of the path contains a \fI.stow\fR file. If it
finds one, it can "learn" about the cooperating stow directory to
finds one, it can \*(L"learn\*(R" about the cooperating stow directory to
short-circuit the \fI.stow\fR search the next time it encounters a
tree-folding symlink.
.SH AUTHOR
.SH "AUTHOR"
.IX Header "AUTHOR"
This man page was originally constructed by Charles Briscoe-Smith from
parts of Stow's info manual, and then converted to POD format by Adam
parts of Stow's info manual, and then converted to \s-1POD\s0 format by Adam
Spiers. The info manual contains the following notice, which, as it
says, applies to this manual page, too. The text of the section
entitled "GNU General Public License" can be found in the file
entitled \*(L"\s-1GNU\s0 General Public License\*(R" can be found in the file
\&\fI/usr/share/common\-licenses/GPL\fR on any Debian GNU/Linux system. If
you don't have access to a Debian system, or the GPL is not there,
you don't have access to a Debian system, or the \s-1GPL\s0 is not there,
write to the Free Software Foundation, Inc., 59 Temple Place, Suite
330, Boston, MA, 02111\-1307, USA.
.SH COPYRIGHT
330, Boston, \s-1MA, 02111\-1307, USA.\s0
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C)
1993, 1994, 1995, 1996 by Bob Glickstein <bobg+stow@zanshin.com>;
@ -461,7 +497,7 @@ preserved on all copies.
.PP
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that
the section entitled "GNU General Public License" is included with the
the section entitled \*(L"\s-1GNU\s0 General Public License\*(R" is included with the
modified manual, and provided that the entire resulting derived work
is distributed under the terms of a permission notice identical to
this one.

241
dot-local/lib/perl/Stow.pm → local/share/perl/Stow.pm
View file

@ -1,25 +1,10 @@
#!/usr/bin/perl
#
# This file is part of GNU Stow.
#
# GNU Stow is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# GNU Stow is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see https://www.gnu.org/licenses/.
package Stow;
=head1 NAME
Stow - manage farms of symbolic links
Stow - manage the installation of multiple software packages
=head1 SYNOPSIS
@ -56,13 +41,15 @@ use File::Spec;
use POSIX qw(getcwd);
use Stow::Util qw(set_debug_level debug error set_test_mode
join_paths restore_cwd canon_path parent adjust_dotfile);
join_paths restore_cwd canon_path parent);
our $ProgramName = 'stow';
our $VERSION = '2.3.2-fixbug56727';
our $VERSION = '2.2.2';
our $LOCAL_IGNORE_FILE = '.stow-local-ignore';
our $GLOBAL_IGNORE_FILE = '.stow-global-ignore';
our $NO_FOLDING_FILE = '.stow-no-folding';
our $RENAME_FILE = '.stow-rename';
our @default_global_ignore_regexps =
__PACKAGE__->get_default_global_ignore_regexps();
@ -75,7 +62,6 @@ our %DEFAULT_OPTIONS = (
paranoid => 0,
compat => 0,
test_mode => 0,
dotfiles => 0,
adopt => 0,
'no-folding' => 0,
ignore => [],
@ -221,6 +207,9 @@ sub init_state {
# Store command line packages to unstow (-D and -R)
$self->{pkgs_to_delete} = [];
# Store .stow-rename info indexed by package name.
$self->{pkg_renames} = {};
# The following structures are used by the abstractions that allow us to
# defer operating on the filesystem until after all potential conflicts have
# been assessed.
@ -284,7 +273,6 @@ sub plan_unstow {
$self->{stow_path},
$package,
'.',
$path,
);
}
debug(2, "Planning unstow of package $package... done");
@ -317,7 +305,6 @@ sub plan_stow {
$package,
'.',
$path, # source from target
0,
);
debug(2, "Planning stow of package $package... done");
$self->{action_count}++;
@ -356,9 +343,7 @@ sub within_target_do {
# Parameters: $stow_path => relative path from current (i.e. target) directory
# : to the stow dir containing the package to be stowed
# : $package => the package whose contents are being stowed
# : $target => subpath relative to package directory which needs
# : stowing as a symlink at subpath relative to target
# : directory.
# : $target => subpath relative to package and target directories
# : $source => relative path from the (sub)dir of target
# : to symlink source
# Returns : n/a
@ -369,12 +354,14 @@ sub within_target_do {
#============================================================================
sub stow_contents {
my $self = shift;
my ($stow_path, $package, $target, $source, $level) = @_;
my ($stow_path, $package, $target, $source) = @_;
$target = $source;
$target =~ s/^(\.\.\/)*\Q$stow_path\E\/\Q$package\E\/?//;
$target = '.' unless $target;
my $path = join_paths($stow_path, $package, $target);
# Remove leading $level times .. from $source
my $n = 0;
my $path = join '/', map { (++$n <= $level) ? ( ) : $_ } (split m{/+}, $source);
return if $self->should_skip_target_which_is_stow_dir($target);
my $cwd = getcwd();
@ -383,10 +370,11 @@ sub stow_contents {
debug(3, $msg);
debug(4, " => $source");
my $dest = $self->renamed($package, $target);
error("stow_contents() called with non-directory path: $path")
unless -d $path;
error("stow_contents() called with non-directory target: $target")
unless $self->is_a_node($target);
error("stow_contents() called with non-directory target: $dest")
unless $self->is_a_node($dest);
opendir my $DIR, $path
or error("cannot read directory: $path ($!)");
@ -399,19 +387,11 @@ sub stow_contents {
next NODE if $node eq '..';
my $node_target = join_paths($target, $node);
next NODE if $self->ignore($stow_path, $package, $node_target);
if ($self->{dotfiles}) {
my $adj_node_target = adjust_dotfile($node_target);
debug(4, " Adjusting: $node_target => $adj_node_target");
$node_target = $adj_node_target;
}
$self->stow_node(
$stow_path,
$package,
$node_target, # target
join_paths($source, $node), # source
$level
);
}
}
@ -422,9 +402,7 @@ sub stow_contents {
# Parameters: $stow_path => relative path from current (i.e. target) directory
# : to the stow dir containing the node to be stowed
# : $package => the package containing the node being stowed
# : $target => subpath relative to package directory of node which
# : needs stowing as a symlink at subpath relative to
# : target directory.
# : $target => subpath relative to package and target directories
# : $source => relative path to symlink source from the dir of target
# Returns : n/a
# Throws : fatal exception if a conflict arises
@ -434,7 +412,7 @@ sub stow_contents {
#============================================================================
sub stow_node {
my $self = shift;
my ($stow_path, $package, $target, $source, $level) = @_;
my ($stow_path, $package, $target, $source) = @_;
my $path = join_paths($stow_path, $package, $target);
@ -456,13 +434,14 @@ sub stow_node {
}
# Does the target already exist?
if ($self->is_a_link($target)) {
my $dest = $self->renamed($package, $target);
if ($self->is_a_link($dest)) {
# Where is the link pointing?
my $existing_source = $self->read_a_link($target);
my $existing_source = $self->read_a_link($dest);
if (not $existing_source) {
error("Could not read link: $target");
error("Could not read link: $dest");
}
debug(4, " Evaluate existing link: $target => $existing_source");
debug(4, " Evaluate existing link: $dest => $existing_source");
# Does it point to a node under any stow directory?
my ($existing_path, $existing_stow_path, $existing_package) =
@ -471,7 +450,7 @@ sub stow_node {
$self->conflict(
'stow',
$package,
"existing target is not owned by stow: $target"
"existing target is not owned by stow: $dest"
);
return; # XXX #
}
@ -489,29 +468,27 @@ sub stow_node {
$self->do_unlink($target);
$self->do_link($source, $target);
}
elsif ($self->is_a_dir(join_paths(parent($target), $existing_source)) &&
$self->is_a_dir(join_paths(parent($target), $source)) ) {
elsif ($self->is_a_dir(join_paths(parent($dest), $existing_source)) &&
$self->is_a_dir(join_paths(parent($dest), $source)) ) {
# If the existing link points to a directory,
# and the proposed new link points to a directory,
# then we can unfold (split open) the tree at that point
debug(2, "--- Unfolding $target which was already owned by $existing_package");
$self->do_unlink($target);
$self->do_mkdir($target);
debug(2, "--- Unfolding $dest which was already owned by $existing_package");
$self->do_unlink($dest);
$self->do_mkdir($dest);
$self->stow_contents(
$existing_stow_path,
$existing_package,
$target,
join_paths('..', $existing_source),
$level + 1,
);
$self->stow_contents(
$self->{stow_path},
$package,
$target,
join_paths('..', $source),
$level + 1,
);
}
else {
@ -519,54 +496,52 @@ sub stow_node {
'stow',
$package,
"existing target is stowed to a different package: "
. "$target => $existing_source"
. "$dest => $existing_source"
);
}
}
else {
# The existing link is invalid, so replace it with a good link
debug(2, "--- replacing invalid link: $path");
$self->do_unlink($target);
$self->do_link($source, $target);
debug(2, "--- replacing invalid link: $dest");
$self->do_unlink($dest);
$self->do_link($source, $dest);
}
}
elsif ($self->is_a_node($target)) {
debug(4, " Evaluate existing node: $target");
if ($self->is_a_dir($target)) {
elsif ($self->is_a_node($dest)) {
debug(4, " Evaluate existing node: $dest");
if ($self->is_a_dir($dest)) {
$self->stow_contents(
$self->{stow_path},
$package,
$target,
join_paths('..', $source),
$level + 1,
);
}
else {
if ($self->{adopt}) {
$self->do_mv($target, $path);
$self->do_link($source, $target);
$self->do_mv($dest, $path);
$self->do_link($source, $dest);
}
else {
$self->conflict(
'stow',
$package,
"existing target is neither a link nor a directory: $target"
"existing target is neither a link nor a directory: $dest"
);
}
}
}
elsif ($self->{'no-folding'} && -d $path && ! -l $path) {
$self->do_mkdir($target);
$self->do_mkdir($dest);
$self->stow_contents(
$self->{stow_path},
$package,
$target,
join_paths('..', $source),
$level + 1,
);
}
else {
$self->do_link($source, $target);
$self->do_link($source, $dest);
}
return;
}
@ -595,7 +570,7 @@ sub should_skip_target_which_is_stow_dir {
return 1;
}
debug(4, "$target not protected");
debug (4, "$target not protected");
return 0;
}
@ -749,7 +724,10 @@ sub unstow_node_orig {
#============================================================================
sub unstow_contents {
my $self = shift;
my ($stow_path, $package, $target, $path) = @_;
my ($stow_path, $package, $target) = @_;
my $path = join_paths($stow_path, $package, $target);
my $dest = $self->renamed($package, $target);
return if $self->should_skip_target_which_is_stow_dir($target);
@ -764,8 +742,8 @@ sub unstow_contents {
# When called at the top level, $target should exist. And
# unstow_node() should only call this via mutual recursion if
# $target exists.
error("unstow_contents() called with invalid target: $target")
unless $self->is_a_node($target);
error("unstow_contents() called with invalid target: $dest")
unless $self->is_a_node($dest);
opendir my $DIR, $path
or error("cannot read directory: $path ($!)");
@ -778,14 +756,7 @@ sub unstow_contents {
next NODE if $node eq '..';
my $node_target = join_paths($target, $node);
next NODE if $self->ignore($stow_path, $package, $node_target);
if ($self->{dotfiles}) {
my $adj_node_target = adjust_dotfile($node_target);
debug(4, " Adjusting: $node_target => $adj_node_target");
$node_target = $adj_node_target;
}
$self->unstow_node($stow_path, $package, $node_target, join_paths($path, $node));
$self->unstow_node($stow_path, $package, $node_target);
}
if (-d $target) {
$self->cleanup_invalid_links($target);
@ -805,25 +776,26 @@ sub unstow_contents {
#============================================================================
sub unstow_node {
my $self = shift;
my ($stow_path, $package, $target, $source) = @_;
my ($stow_path, $package, $target) = @_;
my $path = join_paths($stow_path, $package, $target);
my $dest = $self->renamed($package, $target);
debug(3, "Unstowing $path");
debug(4, " target is $target");
debug(4, " target is $dest");
# Does the target exist?
if ($self->is_a_link($target)) {
debug(4, " Evaluate existing link: $target");
if ($self->is_a_link($dest)) {
debug(4, " Evaluate existing link: $dest");
# Where is the link pointing?
my $existing_source = $self->read_a_link($target);
my $existing_source = $self->read_a_link($dest);
if (not $existing_source) {
error("Could not read link: $target");
error("Could not read link: $dest");
}
if ($existing_source =~ m{\A/}) {
warn "Ignoring an absolute symlink: $target => $existing_source\n";
warn "Ignoring an absolute symlink: $dest => $existing_source\n";
return; # XXX #
}
@ -834,7 +806,7 @@ sub unstow_node {
$self->conflict(
'unstow',
$package,
"existing target is not owned by stow: $target => $existing_source"
"existing target is not owned by stow: $dest => $existing_source"
);
return; # XXX #
}
@ -842,14 +814,8 @@ sub unstow_node {
# Does the existing $target actually point to anything?
if (-e $existing_path) {
# Does link points to the right place?
# Adjust for dotfile if necessary.
if ($self->{dotfiles}) {
$existing_path = adjust_dotfile($existing_path);
}
if ($existing_path eq $path) {
$self->do_unlink($target);
$self->do_unlink($dest);
}
# XXX we quietly ignore links that are stowed to a different
@ -872,30 +838,30 @@ sub unstow_node {
#}
}
else {
debug(2, "--- removing invalid link into a stow directory: $path");
$self->do_unlink($target);
debug(2, "--- removing invalid link into a stow directory: $dest");
$self->do_unlink($dest);
}
}
elsif (-e $target) {
debug(4, " Evaluate existing node: $target");
if (-d $target) {
$self->unstow_contents($stow_path, $package, $target, $source);
elsif (-e $dest) {
debug(4, " Evaluate existing node: $dest");
if (-d $dest) {
$self->unstow_contents($stow_path, $package, $target);
# This action may have made the parent directory foldable
if (my $parent = $self->foldable($target)) {
$self->fold_tree($target, $parent);
if (my $parent = $self->foldable($dest)) {
$self->fold_tree($dest, $parent);
}
}
else {
$self->conflict(
'unstow',
$package,
"existing target is neither a link nor a directory: $target",
"existing target is neither a link nor a directory: $dest",
);
}
}
else {
debug(2, "$target did not exist to be unstowed");
debug(2, "$dest did not exist to be unstowed");
}
return;
}
@ -923,20 +889,18 @@ sub path_owned_by_package {
# Name : find_stowed_path()
# Purpose : determine whether the given link points to a member of a
# : stowed package
# Parameters: $target => path to a symbolic link under current directory.
# : Must share a common prefix with $self->{stow_path}
# Parameters: $target => path to a symbolic link under current directory
# : $source => where that link points to (needed because link
# : might not exist yet due to two-phase approach,
# : so we can't just call readlink()). This must be
# : expressed relative to (the directory containing)
# : $target.
# : so we can't just call readlink())
# Returns : ($path, $stow_path, $package) where $path and $stow_path are
# : relative from the current (i.e. target) directory. $path
# : is the full relative path, $stow_path is the relative path
# : to the stow directory, and $package is the name of the package.
# : or ('', '', '') if link is not owned by stow
# Throws : n/a
# Comments : Allow for stow dir not being under target dir.
# Comments : Needs
# : Allow for stow dir not being under target dir.
# : We could put more logic under here for multiple stow dirs.
#============================================================================
sub find_stowed_path {
@ -968,12 +932,6 @@ sub find_stowed_path {
# If no .stow file was found, we need to find out whether it's
# owned by the current stow directory, in which case $path will be
# a prefix of $self->{stow_path}.
if (substr($path, 0, 1) eq '/' xor substr($self->{stow_path}, 0, 1) eq '/')
{
warn "BUG in find_stowed_path? Absolute/relative mismatch between " .
"Stow dir $self->{stow_path} and path $path";
}
my @stow_path = split m{/+}, $self->{stow_path};
# Strip off common prefixes until one is empty
@ -990,7 +948,7 @@ sub find_stowed_path {
}
my $package = shift @path;
debug(4, " yes - by $package in " . join_paths(@path));
return ($path, $self->{stow_path}, $package);
}
@ -1368,6 +1326,11 @@ sub get_ignore_regexps_from_fh {
# because this is the only place stow looks for them.
$regexps{"^/\Q$LOCAL_IGNORE_FILE\E\$"}++;
# Also ignore the files .stow-no-folding and .stow-rename, for the same
# reason.
$regexps{"^/\Q$NO_FOLDING_FILE\E\$"}++;
$regexps{"^/\Q$RENAME_FILE\E\$"}++;
return $self->compile_ignore_regexps(%regexps);
}
@ -1657,6 +1620,46 @@ sub is_a_link {
return 0;
}
sub renamed {
my $self = shift;
my ($package, $path) = @_;
return $self->do_rename($self->read_rename_file($package), $path);
}
sub read_rename_file {
my $self = shift;
my ($package) = @_;
return $self->{pkg_renames}{$package} if defined $self->{pkg_renames}{$package};
my %renames = ();
$self->{pkg_renames}{$package} = \%renames;
my $file = join_paths($self->{stow_path}, $package, $RENAME_FILE);
return \%renames if (not -f $file);
open my $fh, $file or die "Could not open file $!";
while (<$fh>) {
chomp;
%renames = (%renames, split/\s*=>\s*/);
}
close $fh;
return \%renames;
}
sub do_rename {
my $self = shift;
my ($renames, $path) = @_;
my %renames = %{ $renames };
return $renames{$path} if $renames{$path};
foreach my $dir (keys %renames) {
if (0 == index $path, $dir) {
$path =~ s/^\Q$dir\E/$renames{$dir}/;
}
}
return $path;
}
#===== METHOD ===============================================================
# Name : is_a_dir()
# Purpose : determine if the given path is a current or planned directory

33
dot-local/lib/perl/Stow/Util.pm → local/share/perl/Stow/Util.pm
View file

@ -1,18 +1,3 @@
# This file is part of GNU Stow.
#
# GNU Stow is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# GNU Stow is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see https://www.gnu.org/licenses/.
package Stow::Util;
=head1 NAME
@ -37,11 +22,11 @@ use POSIX qw(getcwd);
use base qw(Exporter);
our @EXPORT_OK = qw(
error debug set_debug_level set_test_mode
join_paths parent canon_path restore_cwd adjust_dotfile
join_paths parent canon_path restore_cwd
);
our $ProgramName = 'stow';
our $VERSION = '2.3.2-fixbug56727';
our $VERSION = '2.2.2';
#############################################################################
#
@ -208,20 +193,6 @@ sub restore_cwd {
chdir($prev) or error("Your current directory $prev seems to have vanished");
}
sub adjust_dotfile {
my ($target) = @_;
my @result = ();
for my $part (split m{/+}, $target) {
if (($part ne "dot-") && ($part ne "dot-.")) {
$part =~ s/^dot-/./;
}
push @result, $part;
}
return join '/', @result;
}
=head1 BUGS
=head1 SEE ALSO