diff --git a/local/bin/chkstow b/local/bin/chkstow index b3a55b0..2d1df26 100755 --- a/local/bin/chkstow +++ b/local/bin/chkstow @@ -1,4 +1,19 @@ -#!/usr/bin/perl +#!/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/. use strict; use warnings; @@ -8,7 +23,7 @@ require 5.006_001; use File::Find; use Getopt::Long; -my $DEFAULT_TARGET = '/usr/local/'; +my $DEFAULT_TARGET = $ENV{STOW_DIR} || '/usr/local/'; our $Wanted = \&bad_links; our %Package = (); @@ -93,7 +108,7 @@ sub aliens { !-l && !-d && print "Unstowed file: $File::Find::name\n"; } -# just list the packages in the the target directory +# just list the packages in the target directory # FIXME: what if the stow dir is not called 'stow'? sub list { if (-l) { diff --git a/local/bin/stow b/local/bin/stow index 7acad8b..a7e9c7a 100755 --- a/local/bin/stow +++ b/local/bin/stow @@ -1,27 +1,29 @@ -#!/usr/bin/perl +#!/usr/local/bin/perl -# GNU Stow - manage the installation of multiple software packages +# GNU Stow - manage farms of symbolic links # 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 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 +# 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. # -# This program is distributed in the hope that it will be useful, but +# 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 +# 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 . +# along with this program. If not, see https://www.gnu.org/licenses/. =head1 NAME -stow - software package installation manager +stow - manage farms of symbolic links =head1 SYNOPSIS @@ -29,33 +31,34 @@ stow [ options ] package ... =head1 DESCRIPTION -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. +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. -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. When one -does so, one winds up (as of Perl 4.036 and Emacs 19.22) with the -following files in F: F; F; -F; F; F; F; and F. Now -suppose it's time to uninstall Perl. Which man pages get removed? -Obviously F is one of them, but it should not be the -administrator's responsibility to memorize the ownership of individual -files by separate packages. +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. -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 -directory containing executables, a F directory containing -section 1 man pages, and so on. +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 +could contain symlinks to files within F, +F 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. Stow was inspired by Carnegie Mellon's Depot program, but is substantially simpler and safer. Whereas Depot required database files @@ -66,6 +69,9 @@ will never delete any files, directories, or links that appear in a Stow directory (e.g., F), so it's always possible to rebuild the target tree (e.g., F). +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 @@ -129,6 +135,8 @@ C<-D>). =item --no +=item --simulate + Do not perform any operations that modify the filesystem; merely show what would happen. @@ -152,7 +160,7 @@ directory. =item --verbose[=N] Send verbose output to standard error describing what Stow is -doing. Verbosity levels are 0, 1, 2, 3, and 4; 0 is the default. +doing. Verbosity levels are from 0 to 5; 0 is the default. Using C<-v> or C<--verbose> increases the verbosity by one; using `--verbose=N' sets it to N. @@ -214,6 +222,22 @@ 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 and F. With this option, +Stow will create symlinks from F<.bashrc> to F and +from F<.emacs.d/init.el> to F. Any other +files, whose name does not begin with "dot-", will be processed as usual. + =item -V =item --version @@ -323,6 +347,28 @@ 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 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 is maintained as a Texinfo manual. @@ -412,11 +458,10 @@ use warnings; require 5.006_001; use POSIX qw(getcwd); -use Getopt::Long; +use Getopt::Long qw(GetOptionsFromArray); +use Scalar::Util qw(reftype); -use Cwd qw(abs_path); -use File::Basename qw(dirname); -use lib dirname(dirname(abs_path($0))) . '/share/perl'; +use FindBin; use lib "$FindBin::Bin/../lib/perl"; use Stow; use Stow::Util qw(parent error); @@ -463,27 +508,75 @@ sub main { #===== SUBROUTINE =========================================================== # Name : process_options() -# Purpose : parse command line options +# Purpose : Parse and process command line and .stowrc file options # Parameters: none # Returns : (\%options, \@pkgs_to_unstow, \@pkgs_to_stow) -# Throws : a fatal error if a bad command line option is given +# Throws : a fatal error if a bad 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'; - unshift @ARGV, get_config_file_options(); - #$,="\n"; print @ARGV,"\n"; # for debugging rc file + #$,="\n"; print @_,"\n"; # for debugging rc file Getopt::Long::config('no_ignore_case', 'bundling', 'permute'); - GetOptions( + GetOptionsFromArray( + \@_, \%options, 'verbose|v:+', 'help|h', 'simulate|n|no', 'version|V', 'compat|p', 'dir|d=s', 'target|t=s', - 'adopt', 'no-folding', + 'adopt', 'no-folding', 'dotfiles', # clean and pre-compile any regex's at parse time 'ignore=s' => @@ -525,31 +618,27 @@ sub process_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) = @_; - if (exists $options->{dir}) { - $options->{dir} =~ s/\A +//; - $options->{dir} =~ s/ +\z//; - } - else { - $options->{dir} = exists $ENV{STOW_DIR} ? $ENV{STOW_DIR} : getcwd(); + unless (exists $options->{dir}) { + $options->{dir} = length $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}) { - $options->{target} =~ s/\A +//; - $options->{target} =~ s/ +\z//; + usage("--target value '$options->{target}' is not a valid directory") + unless -d $options->{target}; } else { $options->{target} = parent($options->{dir}) || '.'; @@ -572,22 +661,25 @@ sub check_packages { } } - #===== SUBROUTINE ============================================================ # Name : get_config_file_options() # Purpose : search for default settings in any .stowrc files # Parameters: none -# 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). +# 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. #============================================================================= sub get_config_file_options { my @defaults = (); - for my $file ("$ENV{HOME}/.stowrc", '.stowrc') { + my @dirlist = ('.stowrc'); + if (defined($ENV{HOME})) { + unshift(@dirlist, "$ENV{HOME}/.stowrc"); + } + for my $file (@dirlist) { 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>){ @@ -597,9 +689,102 @@ sub get_config_file_options { close $FILE or die "Could not close open file: $file\n"; } } - return @defaults; + + # 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); } +#===== 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/(? 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 @@ -612,7 +797,7 @@ sub usage { my ($msg) = @_; if ($msg) { - print "$ProgramName: $msg\n\n"; + warn "$ProgramName: $msg\n\n"; } print <<"EOT"; @@ -638,10 +823,12 @@ 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 0,1,2,3; + -v, --verbose[=N] Increase verbosity (levels are from 0 to 5; -v or --verbose adds 1; --verbose=N sets level) -V, --version Show stow version number -h, --help Show this help diff --git a/local/share/perl/Stow.pm b/local/lib/perl/Stow.pm similarity index 92% rename from local/share/perl/Stow.pm rename to local/lib/perl/Stow.pm index b7ee6ad..96bfd1a 100644 --- a/local/share/perl/Stow.pm +++ b/local/lib/perl/Stow.pm @@ -1,10 +1,25 @@ #!/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 the installation of multiple software packages +Stow - manage farms of symbolic links =head1 SYNOPSIS @@ -41,15 +56,13 @@ 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); + join_paths restore_cwd canon_path parent adjust_dotfile); our $ProgramName = 'stow'; -our $VERSION = '2.2.2'; +our $VERSION = '2.3.2-fixbug56727'; 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(); @@ -62,6 +75,7 @@ our %DEFAULT_OPTIONS = ( paranoid => 0, compat => 0, test_mode => 0, + dotfiles => 0, adopt => 0, 'no-folding' => 0, ignore => [], @@ -207,9 +221,6 @@ 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. @@ -273,6 +284,7 @@ sub plan_unstow { $self->{stow_path}, $package, '.', + $path, ); } debug(2, "Planning unstow of package $package... done"); @@ -305,6 +317,7 @@ sub plan_stow { $package, '.', $path, # source from target + 0, ); debug(2, "Planning stow of package $package... done"); $self->{action_count}++; @@ -343,7 +356,9 @@ 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 and target directories +# : $target => subpath relative to package directory which needs +# : stowing as a symlink at subpath relative to target +# : directory. # : $source => relative path from the (sub)dir of target # : to symlink source # Returns : n/a @@ -354,14 +369,12 @@ sub within_target_do { #============================================================================ sub stow_contents { my $self = shift; - 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); + my ($stow_path, $package, $target, $source, $level) = @_; + # 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(); @@ -370,11 +383,10 @@ 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: $dest") - unless $self->is_a_node($dest); + error("stow_contents() called with non-directory target: $target") + unless $self->is_a_node($target); opendir my $DIR, $path or error("cannot read directory: $path ($!)"); @@ -387,11 +399,19 @@ 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 ); } } @@ -402,7 +422,9 @@ 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 and target directories +# : $target => subpath relative to package directory of node which +# : needs stowing as a symlink at subpath relative to +# : target directory. # : $source => relative path to symlink source from the dir of target # Returns : n/a # Throws : fatal exception if a conflict arises @@ -412,7 +434,7 @@ sub stow_contents { #============================================================================ sub stow_node { my $self = shift; - my ($stow_path, $package, $target, $source) = @_; + my ($stow_path, $package, $target, $source, $level) = @_; my $path = join_paths($stow_path, $package, $target); @@ -434,14 +456,13 @@ sub stow_node { } # Does the target already exist? - my $dest = $self->renamed($package, $target); - if ($self->is_a_link($dest)) { + if ($self->is_a_link($target)) { # Where is the link pointing? - my $existing_source = $self->read_a_link($dest); + my $existing_source = $self->read_a_link($target); if (not $existing_source) { - error("Could not read link: $dest"); + error("Could not read link: $target"); } - debug(4, " Evaluate existing link: $dest => $existing_source"); + debug(4, " Evaluate existing link: $target => $existing_source"); # Does it point to a node under any stow directory? my ($existing_path, $existing_stow_path, $existing_package) = @@ -450,7 +471,7 @@ sub stow_node { $self->conflict( 'stow', $package, - "existing target is not owned by stow: $dest" + "existing target is not owned by stow: $target" ); return; # XXX # } @@ -468,27 +489,29 @@ sub stow_node { $self->do_unlink($target); $self->do_link($source, $target); } - elsif ($self->is_a_dir(join_paths(parent($dest), $existing_source)) && - $self->is_a_dir(join_paths(parent($dest), $source)) ) { + elsif ($self->is_a_dir(join_paths(parent($target), $existing_source)) && + $self->is_a_dir(join_paths(parent($target), $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 $dest which was already owned by $existing_package"); - $self->do_unlink($dest); - $self->do_mkdir($dest); + debug(2, "--- Unfolding $target which was already owned by $existing_package"); + $self->do_unlink($target); + $self->do_mkdir($target); $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 { @@ -496,52 +519,54 @@ sub stow_node { 'stow', $package, "existing target is stowed to a different package: " - . "$dest => $existing_source" + . "$target => $existing_source" ); } } else { # The existing link is invalid, so replace it with a good link - debug(2, "--- replacing invalid link: $dest"); - $self->do_unlink($dest); - $self->do_link($source, $dest); + debug(2, "--- replacing invalid link: $path"); + $self->do_unlink($target); + $self->do_link($source, $target); } } - elsif ($self->is_a_node($dest)) { - debug(4, " Evaluate existing node: $dest"); - if ($self->is_a_dir($dest)) { + elsif ($self->is_a_node($target)) { + debug(4, " Evaluate existing node: $target"); + if ($self->is_a_dir($target)) { $self->stow_contents( $self->{stow_path}, $package, $target, join_paths('..', $source), + $level + 1, ); } else { if ($self->{adopt}) { - $self->do_mv($dest, $path); - $self->do_link($source, $dest); + $self->do_mv($target, $path); + $self->do_link($source, $target); } else { $self->conflict( 'stow', $package, - "existing target is neither a link nor a directory: $dest" + "existing target is neither a link nor a directory: $target" ); } } } elsif ($self->{'no-folding'} && -d $path && ! -l $path) { - $self->do_mkdir($dest); + $self->do_mkdir($target); $self->stow_contents( $self->{stow_path}, $package, $target, join_paths('..', $source), + $level + 1, ); } else { - $self->do_link($source, $dest); + $self->do_link($source, $target); } return; } @@ -570,7 +595,7 @@ sub should_skip_target_which_is_stow_dir { return 1; } - debug (4, "$target not protected"); + debug(4, "$target not protected"); return 0; } @@ -724,10 +749,7 @@ sub unstow_node_orig { #============================================================================ sub unstow_contents { my $self = shift; - my ($stow_path, $package, $target) = @_; - - my $path = join_paths($stow_path, $package, $target); - my $dest = $self->renamed($package, $target); + my ($stow_path, $package, $target, $path) = @_; return if $self->should_skip_target_which_is_stow_dir($target); @@ -742,8 +764,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: $dest") - unless $self->is_a_node($dest); + error("unstow_contents() called with invalid target: $target") + unless $self->is_a_node($target); opendir my $DIR, $path or error("cannot read directory: $path ($!)"); @@ -756,7 +778,14 @@ 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); - $self->unstow_node($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)); } if (-d $target) { $self->cleanup_invalid_links($target); @@ -776,26 +805,25 @@ sub unstow_contents { #============================================================================ sub unstow_node { my $self = shift; - my ($stow_path, $package, $target) = @_; + my ($stow_path, $package, $target, $source) = @_; my $path = join_paths($stow_path, $package, $target); - my $dest = $self->renamed($package, $target); debug(3, "Unstowing $path"); - debug(4, " target is $dest"); + debug(4, " target is $target"); # Does the target exist? - if ($self->is_a_link($dest)) { - debug(4, " Evaluate existing link: $dest"); + if ($self->is_a_link($target)) { + debug(4, " Evaluate existing link: $target"); # Where is the link pointing? - my $existing_source = $self->read_a_link($dest); + my $existing_source = $self->read_a_link($target); if (not $existing_source) { - error("Could not read link: $dest"); + error("Could not read link: $target"); } if ($existing_source =~ m{\A/}) { - warn "Ignoring an absolute symlink: $dest => $existing_source\n"; + warn "Ignoring an absolute symlink: $target => $existing_source\n"; return; # XXX # } @@ -806,7 +834,7 @@ sub unstow_node { $self->conflict( 'unstow', $package, - "existing target is not owned by stow: $dest => $existing_source" + "existing target is not owned by stow: $target => $existing_source" ); return; # XXX # } @@ -814,8 +842,14 @@ 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($dest); + $self->do_unlink($target); } # XXX we quietly ignore links that are stowed to a different @@ -838,30 +872,30 @@ sub unstow_node { #} } else { - debug(2, "--- removing invalid link into a stow directory: $dest"); - $self->do_unlink($dest); + debug(2, "--- removing invalid link into a stow directory: $path"); + $self->do_unlink($target); } } - elsif (-e $dest) { - debug(4, " Evaluate existing node: $dest"); - if (-d $dest) { - $self->unstow_contents($stow_path, $package, $target); + elsif (-e $target) { + debug(4, " Evaluate existing node: $target"); + if (-d $target) { + $self->unstow_contents($stow_path, $package, $target, $source); # This action may have made the parent directory foldable - if (my $parent = $self->foldable($dest)) { - $self->fold_tree($dest, $parent); + if (my $parent = $self->foldable($target)) { + $self->fold_tree($target, $parent); } } else { $self->conflict( 'unstow', $package, - "existing target is neither a link nor a directory: $dest", + "existing target is neither a link nor a directory: $target", ); } } else { - debug(2, "$dest did not exist to be unstowed"); + debug(2, "$target did not exist to be unstowed"); } return; } @@ -889,18 +923,20 @@ 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 +# Parameters: $target => path to a symbolic link under current directory. +# : Must share a common prefix with $self->{stow_path} # : $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()) +# : so we can't just call readlink()). This must be +# : expressed relative to (the directory containing) +# : $target. # 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 : Needs -# : Allow for stow dir not being under target dir. +# Comments : Allow for stow dir not being under target dir. # : We could put more logic under here for multiple stow dirs. #============================================================================ sub find_stowed_path { @@ -932,6 +968,12 @@ 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 @@ -948,7 +990,7 @@ sub find_stowed_path { } my $package = shift @path; - + debug(4, " yes - by $package in " . join_paths(@path)); return ($path, $self->{stow_path}, $package); } @@ -1326,11 +1368,6 @@ 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); } @@ -1620,46 +1657,6 @@ 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 diff --git a/local/share/perl/Stow/Util.pm b/local/lib/perl/Stow/Util.pm similarity index 81% rename from local/share/perl/Stow/Util.pm rename to local/lib/perl/Stow/Util.pm index c22d7b8..5cd98d4 100644 --- a/local/share/perl/Stow/Util.pm +++ b/local/lib/perl/Stow/Util.pm @@ -1,3 +1,18 @@ +# 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 @@ -22,11 +37,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 + join_paths parent canon_path restore_cwd adjust_dotfile ); our $ProgramName = 'stow'; -our $VERSION = '2.2.2'; +our $VERSION = '2.3.2-fixbug56727'; ############################################################################# # @@ -193,6 +208,20 @@ 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 diff --git a/local/share/doc/stow/ChangeLog b/local/share/doc/stow/ChangeLog index ec7f8e1..1d83673 100644 --- a/local/share/doc/stow/ChangeLog +++ b/local/share/doc/stow/ChangeLog @@ -1,3 +1,1723 @@ +Mon Oct 23 12:49:55 2023 +1100 Danielle McLean + + * Merge branch 'bug-56727' Merge in fixed --dotfiles support. We need + it. + + +Thu Apr 15 12:18:10 2021 +0100 Adam Spiers + + * Merge pull request #86 from gutierri/patch-manpage add option + --simulate on manpage + +Wed Apr 14 22:08:38 2021 -0300 Gutierri Barboza + + * add option --simulate on manpage + + M bin/stow.in + +Wed Apr 14 11:03:00 2021 +0100 Adam Spiers + + * Merge pull request #85 from gutierri/patch-usage-dotfiles add + --dotfiles sub usage + +Tue Apr 13 22:09:38 2021 -0300 Gutierri Barboza + + * add --dotfiles sub usage + + M bin/stow.in + +Sun Nov 1 12:24:52 2020 +0000 Adam Spiers + + * Merge pull request #71 from egli/master Mention the dotfiles option in + the manual + +Wed May 27 17:51:37 2020 +0200 Christian Egli + + * Mention the dotfiles option in the manual This should have been part + of 182acbbb64425bf95008cb6d42d266f6185032c9 when the option was + first added. + + This commit basically just copies the help text from stow.in into + the texinfo manual. + + + M doc/stow.texi + +Mon May 25 22:26:31 2020 +0200 ATuinDev <1757663+AitorATuin@users.noreply.github.com> + + * Fix missing variable + + M lib/Stow.pm.in + +Mon May 25 22:23:23 2020 +0200 ATuinDev <1757663+AitorATuin@users.noreply.github.com> + + * Add more tests for testing directories in dotfiles.t + + M t/dotfiles.t + +Mon May 25 22:21:31 2020 +0200 ATuinDev <1757663+AitorATuin@users.noreply.github.com> + + * Add $level variable in stow_contents and stow_node This variables is + used to keep track of the current level in the source. + + + M lib/Stow.pm.in + +Sun May 24 18:12:49 2020 +0200 ATuinDev <1757663+AitorATuin@users.noreply.github.com> + + * Fixes Bug #56727 Problem was that when running + stow_contents/unstow_contents recursively from + stow_node/unstow_node the information for the source path (without + the dot- to + . transformation) was lost. + + In the case of stow_contents the solution is just to remove the + leading dots (..) from the $source path (since the $source path is + passed as an argument to the function) + + In the case of unstow_contents the solution is the same as for + stow_contents but the arguments was now passed so I added it to + the function. + + + M lib/Stow.pm.in + +Sun Jul 28 14:54:36 2019 +0100 Adam Spiers + + * HOWTO-RELEASE: explicitly push to master This avoids errors like + + fatal: You are pushing to remote 'savannah', which is not the + upstream of + your current branch 'master', without telling me what to push + to update which remote branch. + + + M doc/HOWTO-RELEASE + +Sun Jul 28 14:52:53 2019 +0100 Adam Spiers + + * Bump version to 2.3.2 for development of next release + + M META.json + M META.yml + M configure.ac + +Sun Jul 28 14:52:16 2019 +0100 Adam Spiers + + * HOWTO-RELEASE: fix final step of bumping to next release version + + M doc/HOWTO-RELEASE + +Sun Jul 28 14:29:06 2019 +0100 Adam Spiers + + * NEWS: disable org-export-with-toc 2.3.0 was a big release with lots of + stuff, but most releases will be smaller, so default to not having + a ToC. + + + M NEWS + +Sun Jul 28 14:28:41 2019 +0100 Adam Spiers + + * NEWS: don't export with author name Avoid extra noise when exporting + to text for a release announcement. + + + M NEWS + +Sun Jul 28 13:58:00 2019 +0100 Adam Spiers + + * HOWTO-RELEASE: explain how to confirm PAUSE acceptance of upload + + M doc/HOWTO-RELEASE + +Sun Jul 28 13:28:46 2019 +0100 Adam Spiers + + * HOWTO-RELEASE: do ./Build dist earlier docker builds break ./Build + dist, so do it earlier. + + + M doc/HOWTO-RELEASE + +Sun Jul 28 13:15:11 2019 +0100 Adam Spiers + + * Make sure release process starts from a clean slate + + M doc/HOWTO-RELEASE + +Sun Jul 28 13:10:49 2019 +0100 Adam Spiers + + * Prepare NEWS for 2.3.1 release + + M NEWS + +Sun Jul 28 12:57:27 2019 +0100 Adam Spiers + + * fix cross-references under --no-folding section of manual Under emacs, + this was previously rendered as + + '--no-folding' + + This disables any further *note tree folding:: or *note + tree + refolding::. If a new subdirectory is encountered whilst + stowing a + + which looks awkward. Similarly under info(1): + + '--no-folding' + + This disables any further *note tree folding:: or *note + tree + refolding::. If a new subdirectory is encountered whilst + stowing a + + The new way is undesirably repetitive, but at least grammatically + correct. I don't think there's a better solution with texinfo :-/ + + + M doc/stow.texi + +Sun Jul 28 12:55:22 2019 +0100 Adam Spiers + + * HOWTO-RELEASE: add suggested commands for updating home page + + M doc/HOWTO-RELEASE + +Sun Jul 28 13:03:54 2019 +0100 Adam Spiers + + * cli.t: test with the right Perl executable (#62) cli.t: test with the + right Perl executable + +Tue Jul 16 19:24:19 2019 +0100 Adam Spiers + + * HOWTO-RELEASE: update news section of online home page + + M doc/HOWTO-RELEASE + +Tue Jul 16 19:21:04 2019 +0100 Adam Spiers + + * HOWTO-RELEASE: update online docs *after* uploading release It doesn't + make sense to have docs online relating to a release which isn't + yet available; it's less confusing to have a small time window in + which the online docs are out of date. + + + M doc/HOWTO-RELEASE + +Mon Jul 15 16:10:21 2019 -0400 Adam Spiers + + * cli.t: test with the right Perl executable t/cli.t calls scripts which + run with the first perl found in the user's PATH (usually the + system perl), not with the perl used for the build, as reported + here: + + https://rt.cpan.org/Ticket/Display.html?id=129944 + + Thanks to Slaven Rezic for spotting this and reporting it! + + + M THANKS + M t/cli.t + +Sat Jun 29 13:48:59 2019 +0100 Adam Spiers + + * Remove dependencies on Hash::Merge and Clone::Choose (#60) Remove + dependencies on Hash::Merge and Clone::Choose + +Sat Jun 29 13:04:30 2019 +0100 Adam Spiers + + * Remove dependencies on Hash::Merge and Clone::Choose stow 2.3.0 added + external runtime dependencies on Hash::Merge and Clone::Choose. + Historically stow hasn't had runtime dependencies other than Perl + itself, which is a useful property if you're managing the + installation of Perl using stow; the bootstrapping instructions in + stow's manual would need updating to describe how to install these + two modules (and any dependencies they have now or in the future) + as well. + + However, Hash::Merge is much more general than stow actually + needs, so replace the merge() call with a few lines of equivalent + code -- this avoids the external dependencies, and is clearer than + the merge() call. + + Many thanks to Adam Sampson for this patch: + + https://lists.gnu.org/archive/html/bug-stow/2019-06/msg00001.html + + + M Build.PL + M META.json + M META.yml + M NEWS + M bin/stow.in + M t/rc_options.t + +Sat Jun 29 13:40:45 2019 +0100 Adam Spiers + + * Bump version to 2.3.1 for development of next release + + M META.json + M META.yml + M NEWS + M configure.ac + M doc/HOWTO-RELEASE + +Sat Jun 29 13:03:11 2019 +0100 Adam Spiers + + * Maintainer tweaks (#59) Maintainer tweaks + +Sat Jun 29 01:30:36 2019 +0100 Adam Spiers + + * Add GPL v3 upgrade to NEWS for 2.3.0 release Forgot to do this prior + to the release :-( But at least it will be mentioned in the + announcement on the mailing lists. + + + M NEWS + +Sat Jun 29 01:12:36 2019 +0100 Adam Spiers + + * Make NEWS export to text better Run org-convert-to-odd-levels on NEWS + and set local variables so that sections can easily be exported + for release announcements. + + + M NEWS + M doc/HOWTO-RELEASE + +Fri Jun 28 23:48:37 2019 +0100 Adam Spiers + + * Set DISTCLEANFILES to clean up more Docker generates a whole bunch of + files as root. + + + M Makefile.am + +Sat Jun 29 00:55:51 2019 +0100 Adam Spiers + + * HOWTO-RELEASE: Fix cvs commit command for docs + + M doc/HOWTO-RELEASE + +Sat Jun 29 00:36:00 2019 +0100 Adam Spiers + + * HOWTO-RELEASE: Fix git tag command + + M doc/HOWTO-RELEASE + +Fri Jun 28 23:54:30 2019 +0100 Adam Spiers + + * Split perlbrew install-multiple into separate RUN cmd This allows + changing which Perls are used etc. without re-bootstrapping + perlbrew. + + + M docker/Dockerfile + +Fri Jun 28 21:57:08 2019 +0100 Adam Spiers + + * Use Clone backend for Hash::Merge, not Storable (#58) Use Clone + backend for Hash::Merge, not Storable + +Fri Jun 28 21:11:58 2019 +0100 Adam Spiers + + * Use Clone backend for Hash::Merge, not Storable Need to avoid Storable + backend, since it can't deal with regexps: + + https://rt.perl.org/Public/Bug/Display.html?id=50608 + + This should fix the Docker builds. + + + M Build.PL + M META.json + M META.yml + M bin/stow.in + +Fri Jun 28 21:20:22 2019 +0100 Adam Spiers + + * make maintainer-clean remove cover_db/ + + M Makefile.am + +Fri Jun 28 20:46:15 2019 +0100 Adam Spiers + + * Make testing within Docker containers easier (#56) Make testing within + Docker containers easier + +Fri Jun 28 20:10:45 2019 +0100 Adam Spiers + + * Make testing within Docker containers easier + + M docker/run-stow-tests.sh + M test-docker.sh + +Fri Jun 28 20:33:30 2019 +0100 Adam Spiers + + * Merge pull request #57 from aspiers/strict-tests Allow make to fail if + missing modules for test dependencies + +Fri Jun 28 20:21:41 2019 +0100 Adam Spiers + + * Allow make to fail if missing modules for test dependencies e.g. make + STRICT_TESTS=1 + + However we don't need this in .travis.yml as explained in the + comments. + + + M .travis.yml + M configure.ac + +Fri Jun 28 17:48:04 2019 +0100 Adam Spiers + + * Dockerfile: fix Debian jessie sources (#55) Dockerfile: fix Debian + jessie sources + +Fri Jun 28 17:12:18 2019 +0100 Adam Spiers + + * Dockerfile: fix Debian jessie sources + https://superuser.com/questions/1423486/issue-with-fetching-http-deb-debian-org-debian-dists-jessie-updates-inrelease + + + M docker/Dockerfile + +Fri Jun 28 17:14:23 2019 +0100 Adam Spiers + + * Make docker scripts use get-version (#54) Make docker scripts use + get-version + +Fri Jun 28 17:10:42 2019 +0100 Adam Spiers + + * rebuild META.* in preparation for 2.3.0 release (#53) rebuild META.* + in preparation for 2.3.0 release + +Fri Jun 28 17:08:48 2019 +0100 Adam Spiers + + * Make docker scripts use get-version + + M build-docker.sh + M test-docker.sh + +Fri Jun 28 17:04:40 2019 +0100 Adam Spiers + + * rebuild META.* in preparation for 2.3.0 release + + M META.json + M META.yml + +Fri Jun 28 16:48:59 2019 +0100 Adam Spiers + + * Various improvements to tests (#52) Various improvements to tests + +Fri Jun 28 09:56:46 2019 +0100 Adam Spiers + + * Add separate tests for .stowrc from $HOME and $PWD + .stowrc can be obtained from $HOME and/or the current working + directory; however only the $HOME case was tested before, because + during tests Stow was being run from $HOME. + + So switch $TEST_DIR to an absolute path, create a new run_from/ + subdirectory, and chdir to that before invoking any Stow code. + This allows us to test the behaviour of .stowrc in $HOME and + run_from/ separately. + + + M NEWS + M bin/stow.in + M t/rc_options.t + M t/testutil.pm + +Fri Jun 28 15:23:52 2019 +0100 Adam Spiers + + * Split up is_deeply() assertions in find_stowed_path.t This makes the + tests and any failures more readable. + + + M t/find_stowed_path.t + +Fri Jun 28 15:22:44 2019 +0100 Adam Spiers + + * Check that find_stowed_path $path matches relative/absolute with + target Watch out for a corner case probably only relevant in + tests. + + + M lib/Stow.pm.in + +Fri Jun 28 15:22:29 2019 +0100 Adam Spiers + + * Improve comments on function parameters for clarity + + M lib/Stow.pm.in + +Fri Jun 28 10:32:18 2019 +0100 Adam Spiers + + * Add examples of how to enable debugging in tests + + M t/find_stowed_path.t + M t/stow.t + +Fri Jun 28 01:02:48 2019 +0100 Adam Spiers + + * Replace testutil::make_dir with File::Path::make_path No need for a + custom function here. + + + M t/chkstow.t + M t/cleanup_invalid_links.t + M t/cli_options.t + M t/dotfiles.t + M t/examples.t + M t/find_stowed_path.t + M t/foldable.t + M t/ignore.t + M t/stow.t + M t/testutil.pm + M t/unstow.t + M t/unstow_orig.t + +Fri Jun 28 00:53:12 2019 +0100 Adam Spiers + + * Rename $OUT_DIR to $TEST_DIR This is a more accurate reflection of + what it is. + + + M t/chkstow.t + M t/cleanup_invalid_links.t + M t/cli_options.t + M t/defer.t + M t/dotfiles.t + M t/examples.t + M t/find_stowed_path.t + M t/foldable.t + M t/ignore.t + M t/rc_options.t + M t/stow.t + M t/testutil.pm + M t/unstow.t + M t/unstow_orig.t + +Fri Jun 28 00:41:55 2019 +0100 Adam Spiers + + * Avoid dereferencing $ENV{HOME} if it is undefined (#32) Avoid + dereferencing $ENV{HOME} if it is undefined + +Thu Jun 27 20:49:44 2019 +0100 Adam Spiers + + * Improve the history of individual contributions and repositories (#49) + Improve the history of individual contributions and repositories + +Thu Jun 27 20:49:18 2019 +0100 Adam Spiers + + * Upgrade to GPL v3 and add headers to files (#50) + Upgrade to GPL v3 and add headers to files + +Thu Jun 27 20:28:17 2019 +0100 Adam Spiers + + * Improve the history of individual contributions and repositories The + source code has been through a rather complicated journey, and + it's occasionally useful to understand this history from CVS to a + private Subversion repository to its current location in git. So + document this more thoroughly, and ensure that everyone involved + is in the THANKS file. + + + M AUTHORS + M README.md + M THANKS + +Thu Jun 27 20:39:16 2019 +0100 Adam Spiers + + * Change -w to "use warnings;" in tools/get-version This is more + idiomatic and consistent with everywhere else. + + + M tools/get-version + +Thu Jun 27 20:37:50 2019 +0100 Adam Spiers + + * Change #!/usr/local/bin/perl to #!/usr/bin/perl in t/*.t This doesn't + really matter, since these are not executed directly, but it's + more consistent with everything else and modern systems. + + + M t/chkstow.t + M t/cleanup_invalid_links.t + M t/cli.t + M t/cli_options.t + M t/defer.t + M t/dotfiles.t + M t/examples.t + M t/find_stowed_path.t + M t/foldable.t + M t/ignore.t + M t/join_paths.t + M t/parent.t + M t/rc_options.t + M t/stow.t + M t/unstow.t + M t/unstow_orig.t + +Thu Jun 27 14:02:19 2019 +0100 Adam Spiers + + * Upgrade to GPL v3 and add headers to files (#44) Following advice from + maintainers@gnu.org, bring Stow in line with other GNU projects by + upgrading it from GPL v2 to v3 + + + https://www.gnu.org/prep/maintain/html_node/Licensing-of-GNU-Packages.html#Licensing-of-GNU-Packages + + as obtained in plain text and texinfo formats from + + https://www.gnu.org/licenses/ + + and adding appropriate headers: + + + https://www.gnu.org/prep/maintain/html_node/License-Notices-for-Code.html#License-Notices-for-Code + + Fixes #44: https://github.com/aspiers/stow/issues/44 + + + M Build.PL + M COPYING + M INSTALL.md + M Makefile.am + M README.md + M TODO + M bin/chkstow.in + M bin/stow.in + M configure.ac + M doc/stow.texi + M docker/Dockerfile + M docker/bootstrap-perls.sh + M docker/run-stow-tests.sh + M lib/Stow.pm.in + M lib/Stow/Util.pm.in + M t/chkstow.t + M t/cleanup_invalid_links.t + M t/cli.t + M t/cli_options.t + M t/defer.t + M t/dotfiles.t + M t/examples.t + M t/find_stowed_path.t + M t/foldable.t + M t/ignore.t + M t/join_paths.t + M t/parent.t + M t/rc_options.t + M t/stow.t + M t/testutil.pm + M t/unstow.t + M t/unstow_orig.t + +Thu Jun 27 14:14:23 2019 +0100 Adam Spiers + + * Fix Travis failure after merging #42 (#46) Fix Travis failure after + merging #42 + +Thu Jun 27 14:06:19 2019 +0100 Adam Spiers + + * remove trailing whitespace from lines (#45) remove trailing whitespace + from lines + +Thu Jun 27 13:55:35 2019 +0100 Adam Spiers + + * Fix Travis failure after merging #42 Something weird happened with + https://travis-ci.org/aspiers/stow/jobs/551290921 after merging + #42, as shown below. Maybe removing texi2html from the list of + packages for Travis to install will help. + + --- Installing APT Packages 15.50s$ travis_apt_get_update 0.11s$ + sudo -E apt-get -yq --no-install-suggests --no-install-recommends + $(travis_apt_get_options) install texinfo texlive texi2html + Reading package lists... Building dependency tree... Reading state + information... Package texinfo is not available, but is referred + to by another package. This may mean that the package is missing, + has been obsoleted, or is only available from another source + However the following packages replace it: + info install-info E: Package 'texinfo' has no installation + candidate E: Unable to locate package texi2html + apt-get.diagnostics apt-get install failed + $ cat ${TRAVIS_HOME}/apt-get-update.log Get:2 + http://dl.hhvm.com/ubuntu trusty InRelease [3,106 B] Get:3 + http://security.ubuntu.com/ubuntu trusty-security InRelease [65.9 + kB] Get:4 http://ppa.launchpad.net/chris-lea/redis-server/ubuntu + trusty InRelease [15.4 kB] Ign:5 + http://repo.mongodb.org/apt/ubuntu trusty/mongodb-org/3.4 + InRelease Get:6 http://repo.mongodb.org/apt/ubuntu + trusty/mongodb-org/3.4 Release [2,495 B] Get:7 + http://repo.mongodb.org/apt/ubuntu trusty/mongodb-org/3.4 + Release.gpg [801 B] Get:8 http://dl.hhvm.com/ubuntu trusty/main + amd64 Packages [1,812 B] Get:9 http://security.ubuntu.com/ubuntu + trusty-security/main Sources [220 kB] Get:10 + http://security.ubuntu.com/ubuntu trusty-security/restricted + Sources [5,050 B] Get:11 http://security.ubuntu.com/ubuntu + trusty-security/universe Sources [126 kB] Get:12 + http://security.ubuntu.com/ubuntu trusty-security/multiverse + Sources [3,070 B] Get:13 http://security.ubuntu.com/ubuntu + trusty-security/main amd64 Packages [1,032 kB] Get:14 + http://security.ubuntu.com/ubuntu trusty-security/main i386 + Packages [934 kB] Get:15 http://security.ubuntu.com/ubuntu + trusty-security/main Translation-en [541 kB] Get:16 + http://security.ubuntu.com/ubuntu trusty-security/restricted amd64 + Packages [18.1 kB] Get:17 http://security.ubuntu.com/ubuntu + trusty-security/restricted i386 Packages [17.8 kB] Get:18 + http://security.ubuntu.com/ubuntu trusty-security/restricted + Translation-en [3,272 B] Get:19 http://security.ubuntu.com/ubuntu + trusty-security/universe amd64 Packages [377 kB] Get:20 + http://security.ubuntu.com/ubuntu trusty-security/universe i386 + Packages [355 kB] Get:21 http://security.ubuntu.com/ubuntu + trusty-security/universe Translation-en [203 kB] Get:22 + http://security.ubuntu.com/ubuntu trusty-security/multiverse amd64 + Packages [4,730 B] Get:23 http://security.ubuntu.com/ubuntu + trusty-security/multiverse i386 Packages [4,887 B] Get:24 + http://security.ubuntu.com/ubuntu trusty-security/multiverse + Translation-en [2,426 B] Get:25 + https://download.docker.com/linux/ubuntu trusty InRelease [37.1 + kB] Get:26 http://repo.mongodb.org/apt/ubuntu + trusty/mongodb-org/3.4/multiverse amd64 Packages [14.1 kB] Get:27 + https://download.docker.com/linux/ubuntu trusty/stable amd64 + Packages [5,763 B] Get:28 https://download.docker.com/linux/ubuntu + trusty/edge amd64 Packages [6,911 B] Ign:29 + http://ppa.launchpad.net/couchdb/stable/ubuntu trusty InRelease + Get:30 http://ppa.launchpad.net/git-core/ppa/ubuntu trusty + InRelease [20.8 kB] Get:31 http://ppa.launchpad.net/hvr/ghc/ubuntu + trusty InRelease [15.4 kB] Get:32 + http://ppa.launchpad.net/pollinate/ppa/ubuntu trusty InRelease + [15.4 kB] Get:33 http://ppa.launchpad.net/webupd8team/java/ubuntu + trusty InRelease [15.5 kB] Get:34 + http://ppa.launchpad.net/chris-lea/redis-server/ubuntu trusty/main + amd64 Packages [1,843 B] Get:35 + http://ppa.launchpad.net/chris-lea/redis-server/ubuntu trusty/main + i386 Packages [1,842 B] Get:36 + http://ppa.launchpad.net/chris-lea/redis-server/ubuntu trusty/main + Translation-en [990 B] Get:37 + http://ppa.launchpad.net/couchdb/stable/ubuntu trusty Release + [15.1 kB] Get:38 http://ppa.launchpad.net/couchdb/stable/ubuntu + trusty Release.gpg [316 B] Ign:39 + http://dl.google.com/linux/chrome/deb stable InRelease Get:40 + http://dl.google.com/linux/chrome/deb stable Release [943 B] + Get:41 http://dl.google.com/linux/chrome/deb stable Release.gpg + [819 B] Get:42 http://ppa.launchpad.net/git-core/ppa/ubuntu + trusty/main amd64 Packages [3,494 B] Get:43 + http://ppa.launchpad.net/git-core/ppa/ubuntu trusty/main i386 + Packages [3,496 B] Get:44 + http://ppa.launchpad.net/git-core/ppa/ubuntu trusty/main + Translation-en [2,368 B] Get:45 + http://ppa.launchpad.net/hvr/ghc/ubuntu trusty/main amd64 Packages + [18.5 kB] Get:46 http://ppa.launchpad.net/hvr/ghc/ubuntu + trusty/main i386 Packages [15.7 kB] Get:47 + http://ppa.launchpad.net/hvr/ghc/ubuntu trusty/main Translation-en + [1,107 B] Get:48 http://ppa.launchpad.net/pollinate/ppa/ubuntu + trusty/main amd64 Packages [430 B] Get:49 + http://ppa.launchpad.net/pollinate/ppa/ubuntu trusty/main i386 + Packages [430 B] Get:50 + http://ppa.launchpad.net/pollinate/ppa/ubuntu trusty/main + Translation-en [374 B] Get:51 + http://ppa.launchpad.net/webupd8team/java/ubuntu trusty/main amd64 + Packages [20 B] Get:52 + http://ppa.launchpad.net/webupd8team/java/ubuntu trusty/main i386 + Packages [20 B] Get:53 + http://ppa.launchpad.net/webupd8team/java/ubuntu trusty/main + Translation-en [20 B] Get:54 + http://ppa.launchpad.net/couchdb/stable/ubuntu trusty/main amd64 + Packages [985 B] Get:55 + http://ppa.launchpad.net/couchdb/stable/ubuntu trusty/main i386 + Packages [985 B] Get:56 + http://ppa.launchpad.net/couchdb/stable/ubuntu trusty/main + Translation-en [644 B] Get:57 + http://dl.google.com/linux/chrome/deb stable/main amd64 Packages + [1,107 B] Err:58 + https://packagecloud.io/computology/apt-backport/ubuntu trusty + InRelease + Failed to connect to packagecloud.io port 443: Connection timed + out Err:59 http://us-east-1.ec2.archive.ubuntu.com/ubuntu trusty + InRelease + Could not connect to apt.cache.travis-ci.com:80 (34.96.81.152), + connection timed out Err:60 + http://us-east-1.ec2.archive.ubuntu.com/ubuntu trusty-updates + InRelease + Unable to connect to apt.cache.travis-ci.com:http: Err:61 + http://toolbelt.heroku.com/ubuntu ./ InRelease + Could not connect to apt.cache.travis-ci.com:80 (34.96.81.152), + connection timed out Err:62 + http://us-east-1.ec2.archive.ubuntu.com/ubuntu trusty-backports + InRelease + Unable to connect to apt.cache.travis-ci.com:http: Err:63 + http://apt.postgresql.org/pub/repos/apt trusty-pgdg InRelease + Could not connect to apt.cache.travis-ci.com:80 (34.96.81.152), + connection timed out Err:1 http://dl.bintray.com/apache/cassandra + 39x InRelease + Could not connect to apt.cache.travis-ci.com:80 (34.96.81.152), + connection timed out Get:64 + https://packagecloud.io/github/git-lfs/ubuntu trusty InRelease + [23.2 kB] Ign:64 https://packagecloud.io/github/git-lfs/ubuntu + trusty InRelease Get:65 + https://packagecloud.io/rabbitmq/rabbitmq-server/ubuntu trusty + InRelease [23.7 kB] Get:66 + https://packagecloud.io/github/git-lfs/ubuntu trusty/main Sources + [20 B] Get:67 https://packagecloud.io/github/git-lfs/ubuntu + trusty/main amd64 Packages [8,003 B] Get:68 + https://packagecloud.io/github/git-lfs/ubuntu trusty/main i386 + Packages [7,761 B] Get:69 + https://packagecloud.io/rabbitmq/rabbitmq-server/ubuntu + trusty/main Sources [20 B] Get:70 + https://packagecloud.io/rabbitmq/rabbitmq-server/ubuntu + trusty/main amd64 Packages [7,866 B] Get:71 + https://packagecloud.io/rabbitmq/rabbitmq-server/ubuntu + trusty/main i386 Packages [7,866 B] Fetched 4,218 kB in 15s (279 + kB/s) Reading package lists... W: + http://ppa.launchpad.net/couchdb/stable/ubuntu/dists/trusty/Release.gpg: + Signature by key 15866BAFD9BCC4F3C1E0DFC7D69548E1C17EAB57 uses + weak digest algorithm (SHA1) W: GPG error: + https://packagecloud.io/github/git-lfs/ubuntu trusty InRelease: + The following signatures couldn't be verified because the public + key is not available: NO_PUBKEY 6B05F25D762E3157 W: The repository + 'https://packagecloud.io/github/git-lfs/ubuntu trusty InRelease' + is not signed. W: There is no public key available for the + following key IDs: 6B05F25D762E3157 W: Failed to fetch + http://us-east-1.ec2.archive.ubuntu.com/ubuntu/dists/trusty/InRelease + Could not connect to apt.cache.travis-ci.com:80 (34.96.81.152), + connection timed out W: Failed to fetch + http://us-east-1.ec2.archive.ubuntu.com/ubuntu/dists/trusty-updates/InRelease + Unable to connect to apt.cache.travis-ci.com:http: W: Failed to + fetch + http://us-east-1.ec2.archive.ubuntu.com/ubuntu/dists/trusty-backports/InRelease + Unable to connect to apt.cache.travis-ci.com:http: W: Failed to + fetch + http://www.apache.org/dist/cassandra/debian/dists/39x/InRelease + Could not connect to apt.cache.travis-ci.com:80 (34.96.81.152), + connection timed out W: Failed to fetch + https://packagecloud.io/computology/apt-backport/ubuntu/dists/trusty/InRelease + Failed to connect to packagecloud.io port 443: Connection timed + out W: Failed to fetch + http://toolbelt.heroku.com/ubuntu/./InRelease Could not connect + to apt.cache.travis-ci.com:80 (34.96.81.152), connection timed out + W: Failed to fetch + http://apt.postgresql.org/pub/repos/apt/dists/trusty-pgdg/InRelease + Could not connect to apt.cache.travis-ci.com:80 (34.96.81.152), + connection timed out W: Some index files failed to download. They + have been ignored, or old ones used instead. The command "sudo -E + apt-get -yq --no-install-suggests --no-install-recommends + $(travis_apt_get_options) install texinfo texlive texi2html" + failed and exited with 100 during . Your build has been stopped. + + + M .travis.yml + +Wed Jun 26 13:25:53 2019 +0100 Adam Spiers + + * remove trailing whitespace from lines + + M doc/stow.texi + +Thu Jun 27 13:27:12 2019 +0100 Adam Spiers + + * Update maintainership to reflect reality (#41) Update maintainership + to reflect reality + +Wed Jun 26 14:08:48 2019 +0100 Adam Spiers + + * switch from unmaintained texi2html to makeinfo --html --no-split (#42) + switch from unmaintained texi2html to makeinfo --html --no-split + +Wed Jun 26 13:26:08 2019 +0100 Adam Spiers + + * Update maintainership to reflect reality Troy hasn't been active on + the project for many years. + + https://lists.gnu.org/archive/html/stow-devel/2011-11/msg00009.html + + + M AUTHORS + M THANKS + +Wed Jun 26 13:37:07 2019 +0100 Adam Spiers + + * Switch to makeinfo --html --no-split for single-page HTML manual (#21) + Remove the dependency on the ancient and unmaintained texi2html, + which was difficult to get running on most distros other than + openSUSE. + + There are two more modern alternative approaches which can replace + this: + + - Use texi2any + - Use makeinfo --html --no-split + + The latter seems to be the standard way these days, so we switch + to that; however we keep Makefile rules for all three, and a phony + meta-rule 'manual-single-html-all' to allow quick comparison + between them. Make tweaks accordingly to minimise the differences + and improve the output. + + The rules for the older two approaches do not get triggered by + default. + + Fixes #21: https://github.com/aspiers/stow/issues/21 + + + M .gitignore + M MANIFEST.SKIP + M Makefile.am + M NEWS + +Wed Jun 26 13:34:09 2019 +0100 Adam Spiers + + * Include the preamble in online versions of the manual This is more + inline with the suggestion in the texinfo manual: + + https://www.gnu.org/software/texinfo/manual/texinfo/html_node/_0040top-Command.html + + and also the preamble is useful in all cases. + + + M doc/stow.texi + +Wed Jun 26 13:33:48 2019 +0100 Adam Spiers + + * Add Guillaume and myself to the list of @authors + + M doc/stow.texi + +Wed Jun 26 13:25:53 2019 +0100 Adam Spiers + + * remove trailing whitespace from lines + + M AUTHORS + +Tue Jun 25 20:33:48 2019 +0100 Adam Spiers + + * add tools/get-version to MANIFEST Forgot to do this, and it broke + ./Build.PL distcheck. + + + M MANIFEST + +Tue Jun 25 20:10:43 2019 +0100 Adam Spiers + + * Merge remote-tracking branch 'bricewge/fix-34' + +Tue Jun 25 20:04:11 2019 +0100 Adam Spiers + + * Add some polish to the release process + + M doc/HOWTO-RELEASE + A tools/get-version + +Tue Jun 25 19:49:46 2019 +0100 Adam Spiers + + * Perform shell expansion on the contents of .stowrc (#40) Perform shell + expansion on the contents of .stowrc + +Thu Jul 14 14:48:40 2016 -0500 Charles LeDoux + + * Add function to expand ~ in .stowrc files (#14) Add a new + expand_tilde() function that performs tilde expansion of strings, + and corresponding unit tests: + + * A ~ at the beginning of a path is expanded to the user's + home + directory. + * Literal '~' can be provided with '\~' + + Combine this with expand_environment() in a new expand_filepath() + function which applies all (both) required expansion functions to + a string, and use that in get_config_file_options() to expand + .stowrc options. + + Add more tests to check that tilde expanded in correct places, + i.e.: + + * expanded for --target and --dir + * not expanded for --ignore, --defer, or --override + + Update documentation on stowrc files according to this + functionality change. + + Fixes #14: https://github.com/aspiers/stow/issues/14 + + + M NEWS + M bin/stow.in + M doc/stow.texi + M t/rc_options.t + +Thu Jul 14 11:37:42 2016 -0500 Charles LeDoux + + * Apply environment expansion to options in .stowrc files Expand + environment variables used in stowrc, as requested in + + https://savannah.gnu.org/bugs/?41826 + + This is achieved by creating a new function expand_environment() + that replaces any substring of the form '$VAR' or '${VAR}' with + contents of environment variable $VAR. Literal '$' can be given + by '\$'. + + N.B. The function is only applied to the --target and --dir + options, and only for options specified in .stowrc; cli options + are left untouched. + + Undefined variables are expanded to the empty string, as they + would be in normal shell parameter expansion. + + Unit tests added accordingly: + + - Test expand_environment(): + * Expand $HOME + * Expand ${HOME} + * Expand ${WITH SPACE} + * Expand '\$HOME'. Expected is '$HOME' + * Expand ${UNDEFINED}. Expected is ''. + + - Test that it's applied to the correct options. + + - Test that CLI options are not expanded. + + + M bin/stow.in + M t/cli_options.t + M t/rc_options.t + +Fri Jul 1 20:07:28 2016 -0500 Charles LeDoux + + * Parse cli and stowrc files separately Why: + + * We want to selectively apply expansion to: + * Only options from stowrc files. + * Only options that take a path. + * This requires ability to: + * Differentiate cli options from stowrc options + * Distinguish between individual stowrc options. + + This change addresses the need by: + + * Options from ARGV and stowrc files are separately parsed, + resulting in + two options hashes. + * Creating an option hash from stowrc files allows modification + of + specific arguments without having to rely on something like + regex + parsing of the options. + + * get_config_file_options modified to return options hash. + * Uses the same parse_options function that parses ARGV + + * Add Hash:Merge to dependencies in order to merge the two option + hashes. + + * process_options() merges the two option hashes. + * Get option hash for ARGV + * Get option hash from get_config_file_options(). + * Merge the two hashes with Hash::Merge. + * Sanitation and checks are ran on the merged options. + + * The options -S, -D, and -R are ignored in stowrc files. + * Due to the way argument parsing happens, the effect of these + actions is not carried from stowrc into parsing of cli + options. + * It doesn't seem to make sense to put these options in stowrc + anyway. + + + M Build.PL + M META.json + M META.yml + M bin/stow.in + +Fri Jun 24 16:34:13 2016 -0500 Charles LeDoux + + * Factor out parsing of options Why: + + * Want to be able to selectively apply filepath expansion to: + 1. Only options in a stowrc file. + 2. Only options that take a file path. + + * Because of need 1, any expansion must be performed on stowrc + options + before merging with cli options. + + * Because of need 2, stowrc options need to be parsed before + expansion + in order to know which options need expanding. + + This change addresses the need by: + + * Create parse_options() + * Implements option parsing logic previously in + process_options() + * Takes an array as parameter instead of assuming ARGV + * Edit process_options() to still work as expected. + * Only change was to call parse_options() instead of directly + parsing ARGV + + * By factoring out the option parsing code, we can reuse the + existing + parsing code for stowrc options. + * Allows expansion of only the option itself, i.e expansion on + "$HOME/target" rather than "--target=$HOME/target" + * Allows easy determination of which options need expansion. + + + M bin/stow.in + +Thu Jul 14 08:55:55 2016 -0500 Charles LeDoux + + * Add test for conflicting stowrc and cli args Why: + + * Want to add feature to stowrc parsing. + * Missing regression test for conflicting cli and stowrc options. + + This change addresses the need by: + + * Add missing regression tests to rc_options.t + * Two types of tests for the two types of options possible. + + * For scalar options such as --target, cli arguments should + overwrite + stowrc arguments. + + * For options that result in a list, such as --ignore, the + arguments + from cli and stowrc files should be merged. + + + M t/rc_options.t + +Fri Jul 1 18:38:25 2016 -0500 Charles LeDoux + + * Add test harness for stowrc files Why: + + * Planning on developing a new feature for parsing of stowrc + files. + * Need a test harness that performs initialization and clean up + * Initialization: Create directory structure that allows + creation of + stowrc files without worrying about squashing existing files. + * Clean up: Remove all files created during testing. + + This change addresses the need by: + + * Add intialization and cleanup harness in t/rc_options.t + * Define the location to write stowrc files to in $RC_FILE + * Ensures that location $RC_FILE does not already exist. + * Calls the init_test_dirs to bootstrap directory tree. + * After all tests are run, removes $RC_FILE and the testing + directory tree. + + * Add basic test of stowrc parsing to t/rc_options.t + * Provides a template of how to create and test a stowrc file. + + * Newly created t/rc_options.t file added to MANIFEST + + + M MANIFEST + A t/rc_options.t + +Fri Jun 24 15:06:06 2016 -0500 Charles LeDoux + + * Change init_test_dirs to point $HOME at $OUT_DIRS Why: + + * Want to add a new feature to parsing of stowrc files. + * Need ability to write .stowrc files for testing without risk of + squashing existing files. + + This change addresses the need by: + + * Reusing logic in init_test_dirs + * init_test_dirs already creates new directory structure and + overwrites + $HOME to point into /tmp. + * This commit changes init_test_dirs to point $HOME at the newly + created + directory structure ($OUT_DIR) instead of /tmp. + * Grants ability to write .stowrc to $HOME without fear. + * Pointing $HOME at $OUT_DIR instead of /tmp also makes cleanup + easier. + * Remove $OUT_DIR vs remove specific files in /tmp. + + + M t/testutil.pm + +Tue Jun 25 19:05:38 2019 +0100 Adam Spiers + + * Don't warn when .stowrc is used We fully support and expect some users + using .stowrc, so there is no reason to issue a warning when they + do. + + + M bin/stow.in + +Tue Jun 25 19:36:49 2019 +0100 Adam Spiers + + * Group news items for 2.3.0 Since 2.3.0 is a long overdue release and + has many changes, document them in NEWS in three groups: + + - New features / changes in behaviour + - Documentation fixes and enhancements + - Fixes for bugs and technical debt + + + M NEWS + +Tue Jun 25 17:48:07 2019 +0100 Adam Spiers + + * Update docs according to recent commits (#39) Update docs according to + recent commits + +Tue Jun 25 17:21:53 2019 +0100 Adam Spiers + + * Update NEWS and THANKS according to recent commits + + M NEWS + M THANKS + +Tue Jun 25 17:25:33 2019 +0100 Adam Spiers + + * Synchronise --verbose documentation The man page was updated with + regard to higher --verbose levels but not the info manual, so fix + that. + + + M doc/stow.texi + +Tue Jun 25 17:05:43 2019 +0100 Adam Spiers + + * Fix old descriptions of Stow (#22) (#38) Fix old descriptions of Stow + (#22) + +Mon Nov 21 14:56:26 2016 +0000 Adam Spiers + + * Fix old descriptions of Stow (#22) De-emphasise the package management + aspects, since these days almost everyone prefers to use modern + package managers such as rpm / dpkg / Nix for (system-wide) + package management. + + Also include more popular modern use cases for Stow such as + management of dotfiles and software compiled in the user's $HOME + directory. + + Fixes #22: https://github.com/aspiers/stow/issues/22 + + + M README.md + M bin/stow.in + M doc/stow.texi + M lib/Stow.pm.in + +Tue Jun 25 15:55:15 2019 +0100 Adam Spiers + + * Merge pull request #37 from aspiers/invalid-option-exit-code Return + non-zero exit code when invalid option is specified (#34) + +Tue Jun 25 13:44:35 2019 +0100 Adam Spiers + + * Return non-zero exit code when invalid option is specified (#34) Also + add a unit test for this. + + Fixes #34: https://github.com/aspiers/stow/issues/34 + + + M bin/stow.in + M t/cli.t + +Tue Jun 25 15:41:41 2019 +0100 Adam Spiers + + * Add black box CLI testing and 2 other tweaks (#36) Add black box CLI + testing and 2 other tweaks + +Tue Jun 25 14:27:56 2019 +0100 Adam Spiers + + * Add cli.t for testing invocation of stow executable Unlike the other + tests, this actually treats stow(1) as a black box script, running + it directly rather than require-ing it as a library. This allows + us to check things like the exit codes returned. + + + M MANIFEST + A t/cli.t + +Tue Jun 25 14:30:08 2019 +0100 Adam Spiers + + * Make dotfiles.t executable for consistency with other tests + + M t/dotfiles.t + +Tue Jun 25 13:44:17 2019 +0100 Adam Spiers + + * remove duplicate "the" typo + + M bin/chkstow.in + +Tue Jun 11 14:13:51 2019 +0200 Brice Waegeneire + + * retrun exit code 1 when unknown option + + M bin/stow.in + +Tue Jun 11 10:53:28 2019 +0200 Brice Waegeneire + + * make non docker scripts more portable + + M build-docker.sh + M test-docker.sh + +Tue Jun 11 10:28:25 2019 +0200 Brice Waegeneire + + * fix dockerfile apt-get lock issue E: Could not open lock file + /var/cache/apt/archives/lock - open (2: No such file or directory) + E: Unable to lock the download directory + + + M docker/Dockerfile + +Wed Apr 3 09:48:15 2019 -0600 Will Aoki + + * Avoid dereferencing $ENV{HOME} if it is undefined + + M bin/stow.in + +Sat Feb 9 17:08:44 2019 +0000 Adam Spiers + + * Merge pull request #30 from aspiers/chkstow-stow-dir make chkstow + honour $STOW_DIR environment variable + +Sat Feb 9 17:02:47 2019 +0000 Adam Spiers + + * make chkstow honour $STOW_DIR environment variable Thanks to Matan + Nassau for reporting this deficiency. + + + M THANKS + M bin/chkstow.in + +Sun Feb 11 17:58:33 2018 +0000 Adam Spiers + + * add Jean Louis to THANKS file Forgot to do this in e7e6c7f. + + + M THANKS + +Sun Feb 11 17:55:40 2018 +0000 Adam Spiers + + * avoid "regex" abbreviation for consistency + + M doc/stow.texi + +Sun Feb 11 17:47:06 2018 +0000 Adam Spiers + + * fix erroneous glob examples in --ignore documentation Many thanks to + Daniel Shahaf for noticing this. + + http://lists.gnu.org/archive/html/bug-stow/2017-07/msg00000.html + + + M THANKS + M doc/stow.texi + +Sun Feb 11 11:52:56 2018 +0000 Adam Spiers + + * update aclocal.m4 using aclocal 1.15.1 + + M aclocal.m4 + +Sun Feb 11 11:47:39 2018 +0000 Adam Spiers + + * update the introductory text to clarify Stow's common usage Thanks to + Jean Louis for some suggestions on this. + + + M doc/stow.texi + +Sun Mar 19 21:12:46 2017 +0000 Adam Spiers + + * INSTALL.md: document how to build from git (#20) Fixes + https://github.com/aspiers/stow/issues/20 + + + M INSTALL.md + +Sat Mar 4 14:28:19 2017 +0000 Adam Spiers + + * fix typo in "Deleting Packages" chapter Thanks to Hongyi Zhao for + spotting this error and reporting it. + + + M THANKS + M doc/stow.texi + +Sun Dec 18 23:16:41 2016 +0000 Adam Spiers + + * clarify that ~/.stowrc args don't get processed by a shell Address + confusion reported here: + + http://lists.gnu.org/archive/html/bug-stow/2016-08/msg00000.html + + + M doc/stow.texi + +Sun Dec 18 23:14:39 2016 +0000 Adam Spiers + + * replace a "you" typo with better text The contents are prepended to + the arguments; they still come after the stow executable. + + + M doc/stow.texi + +Sun Dec 18 23:10:13 2016 +0000 Adam Spiers + + * fix documentation for --verbose It actually goes up to 5 these days. + Thanks to Kristoffer Haugsbakk for spotting that: + + http://lists.gnu.org/archive/html/bug-stow/2016-08/msg00000.html + + + M THANKS + M bin/stow.in + +Sun Nov 20 22:02:19 2016 +0000 Adam Spiers + + * Bump version to 2.3.0 + + M META.json + M META.yml + M configure.ac + +Sun Nov 20 21:45:17 2016 +0000 Adam Spiers + + * Prepare NEWS file for 2.3.0 release + + M NEWS + +Sun Nov 20 22:16:43 2016 +0000 Adam Spiers + + * HOWTO-RELEASE: use Docker to test before releasing Charles LeDoux did + some awesome work providing this Docker environment which can test + across multiple Perl versions using perlbrew, so it would be crazy + not to use it. + + + M doc/HOWTO-RELEASE + +Sun Nov 20 22:57:08 2016 +0000 Adam Spiers + + * ignore cover_db generated by Coveralls + + M .gitignore + +Sun Nov 20 22:16:10 2016 +0000 Adam Spiers + + * tag Docker images with the corresponding version number + + M build-docker.sh + M test-docker.sh + +Sun Nov 20 22:02:00 2016 +0000 Adam Spiers + + * use PAUSE upload for final validation step of release + + M doc/HOWTO-RELEASE + +Sun Nov 20 22:00:46 2016 +0000 Adam Spiers + + * make sure release tags are also pushed to GitHub + + M doc/HOWTO-RELEASE + +Sun Nov 20 21:58:31 2016 +0000 Adam Spiers + + * further refine the release process Let's try a new approach where we + increment the version number immediately after publishing a + release, not just before. + + This will mean that anyone who builds from git gets a version of + Stow which is higher than the release which was just cut, and this + could provide valuable debugging hints in case a bug report does + not clearly state whether the problem arose with the latest + release or with a build from git. + + + M doc/HOWTO-RELEASE + +Sun Nov 20 21:51:41 2016 +0000 Adam Spiers + + * whitespace cleanups + + M doc/HOWTO-RELEASE + M docker/Dockerfile + M docker/bootstrap-perls.sh + M docker/run-stow-tests.sh + M test-docker.sh + +Sun Nov 20 21:18:08 2016 +0000 Adam Spiers + + * THANKS: add some recent contributors + + M THANKS + +Sun Nov 20 21:17:46 2016 +0000 Adam Spiers + + * THANKS: clarify mention of Bob Glickstein + + M THANKS + +Sun Nov 20 20:55:14 2016 +0000 Adam Spiers + + * HOWTO-RELEASE: add a reminder to update THANKS Make sure the + maintainer always gives credit to contributors :-) + + + M doc/HOWTO-RELEASE + +Wed Oct 5 17:47:51 2016 +0100 Adam Spiers + + * Merge pull request #17 from jvkersch/enh/dot-files Special processing + for dotfiles + +Sun Jul 31 21:55:55 2016 +0100 Joris Vankerschaver + + * Special processing for dotfiles + + M MANIFEST + M bin/stow.in + M lib/Stow.pm.in + M lib/Stow/Util.pm.in + A t/dotfiles.t + +Sun Sep 25 19:32:08 2016 +0100 Adam Spiers + + * Merge pull request #16 from cledoux/feature/docker Added docker files + for local testing. + +Tue Sep 20 18:27:46 2016 +0100 Adam Spiers + + * fix naming of man page The title of the generated man page was ending + up as something like + + IO::FILE=IO(0XA719C0)(1) + + Also, with newer perls (e.g. v5.22.1), pod2man requires --name if + used within a pipeline. + + Closes #18. + + https://github.com/aspiers/stow/issues/18 + + + M Makefile.am + +Tue Aug 23 10:37:12 2016 +0100 Adam Spiers + + * remove superfluous space in function call Be consistent with style + elsewhere. + + + M lib/Stow.pm.in + +Tue May 10 15:00:13 2016 -0500 Charles LeDoux + + * Add docker files for local testing. + * Use docker to locally run tests on multiple perl versions + * perlbrew used to install multiple perls + * perl environments bootstrapped when image built + * Based on travis configuration + * Adds docker folder to MANIFEST.SKIP + * Running image runs all tests. + * If exit with no error, then all tests pass. + * ./build-docker.sh builds stow testing image. + * ./test-docker.sh runs stow testing image. + * Assumes built with options in build-docker.sh + * *-docker.sh scripts added to MANIFEST.SKIP + + + M MANIFEST.SKIP + A build-docker.sh + A docker/Dockerfile + A docker/bootstrap-perls.sh + A docker/run-stow-tests.sh + A test-docker.sh + +Sat Feb 27 12:19:57 2016 -0500 Lucas Theisen + + * fixed testutil to support cygwin which reports -z = true on + directories + + M t/testutil.pm + +Tue Nov 17 17:27:39 2015 +0000 Adam Spiers + + * another attempt to fix automake config d527094b was not the right fix + - Util.pm was being installed alongside Stow.pm under $(PMDIR). + This should be the correct fix. + + + M Makefile.am + +Tue Nov 17 01:50:27 2015 +0000 Adam Spiers + + * add coveralls badge + + M README.md + +Tue Nov 17 01:43:38 2015 +0000 Adam Spiers + + * add coveralls + + M .travis.yml + +Mon Nov 16 22:47:34 2015 +0000 Adam Spiers + + * add make distcheck and Module::Build to Travis tests + + M .travis.yml + M Makefile.am + +Mon Nov 16 22:50:58 2015 +0000 Adam Spiers + + * add .travis.yml to MANIFEST.SKIP + + M MANIFEST.SKIP + +Tue Nov 17 01:34:23 2015 +0000 Adam Spiers + + * fix make distcheck Stow/Util.pm was not being installed correctly + + + M Makefile.am + +Mon Nov 16 22:39:53 2015 +0000 Adam Spiers + + * add Travis CI badge to README.md + + M README.md + +Mon Nov 16 22:35:56 2015 +0000 Adam Spiers + + * fix breakage caused by converting files to Markdown + + M MANIFEST + M Makefile.am + M configure.ac + +Mon Nov 16 22:21:44 2015 +0000 Adam Spiers + + * convert INSTALL to Markdown + + D INSTALL + A INSTALL.md + M README.md + +Mon Nov 16 22:12:02 2015 +0000 Adam Spiers + + * convert README to Markdown + +R076 README README.md + +Mon Nov 16 21:56:45 2015 +0000 Adam Spiers + + * switch to Travis CI containers + + M .travis.yml + +Fri Nov 13 14:50:19 2015 +0000 Adam Spiers + + * Merge pull request #9 from Gnouc/master Allow directory with trailing + and leading spaces + +Fri Nov 13 11:57:21 2015 +0700 LE Manh Cuong + + * Allow directory with trailing and leading spaces + - The `sanitize_path_options` functions remove all trailing + and leading spaces. So any valid directory like ` 123`, + `123 ` can not be used + + - Also if there are two directories ` 123` and `123`, and if + user pick the ` 123` as option to `-d` or `-t`, then stow pick + directory `123` as the argument instead of ` 123` as user want. + + ``` + STOW_DIR=. stow -n -v3 -t \ 123 456 + stow dir is /tmp/test + stow dir path relative to target 123 is .. + cwd now 123 + cwd restored to /tmp/test + cwd now 123 + Planning stow of package 456... + Stowing contents of ../456 (cwd=/tmp/test/123) + Planning stow of package 456... done + cwd restored to /tmp/test + WARNING: in simulation mode so not modifying filesystem. + ``` + - This commit remove the check in `sanitize_path_options` + function, + and now stow can work with those directories. There have been a + check + for valid directory, so we are safe. + + + M bin/stow.in + M t/cli_options.t + +Fri Nov 13 11:13:06 2015 +0000 Adam Spiers + + * set up Travis CI + + A .travis.yml + +Fri Nov 13 12:04:52 2015 +0000 Adam Spiers + + * add IO::Scalar to build_requires + + M Build.PL + M META.json + M META.yml + +Wed Nov 11 12:25:19 2015 +0000 Adam Spiers + + * Do more validation on --dir / --target directories (#7) Previously + STOW_DIR=0 would cause the cwd to be used as the STOW_DIR. Make + that instead raise an error. Do similar validation on the target + directory. + + Closes #7 - https://github.com/aspiers/stow/pull/7 + + + M bin/stow.in + +Wed Nov 11 11:22:05 2015 +0000 Adam Spiers + + * Correctly handle empty STOW_DIR (#5, #6) In shell, a variable is often + considered unset even if it is set to the empty string. In other + words, + + STOW_DIR= stow [args] + + is an idiomatic alternative to writing: + + unset STOW_DIR + stow [args] + + and it also has the advantage of temporarily "unsetting" STOW_DIR + for a single command. + + Therefore we should treat STOW_DIR being set to the empty string + as equivalent to it not being set at all. + + Thanks to Cuong Manh Le for highlighting this issue! + + Fixes #6 - https://github.com/aspiers/stow/issues/6 Closes #5 - + https://github.com/aspiers/stow/pull/5 + + + M THANKS + M bin/stow.in + Mon Nov 9 12:37:09 2015 +0000 Adam Spiers * More fixes to "make distcheck" As with dc6a141d, the dependency of @@ -52,8 +1772,7 @@ Mon Nov 9 11:36:11 2015 +0000 Adam Spiers M META.yml M Makefile.am M NEWS - D lib/Stow/Util.pm - A lib/Stow/Util.pm.in +R099 lib/Stow/Util.pm lib/Stow/Util.pm.in Mon Nov 9 11:05:00 2015 +0000 Adam Spiers @@ -555,20 +2274,16 @@ Mon Jan 9 21:32:31 2012 +0000 Adam Spiers * Rename test files to reflect their purpose. M MANIFEST - A t/stow.t - D t/stow_contents.t - A t/unstow.t - D t/unstow_contents.t - D t/unstow_contents_orig.t - A t/unstow_orig.t +R099 t/stow_contents.t t/stow.t +R099 t/unstow_contents.t t/unstow.t +R099 t/unstow_contents_orig.t t/unstow_orig.t Mon Jan 9 21:31:46 2012 +0000 Adam Spiers * Rename stow.t to be more consistent with its purpose. M MANIFEST - A t/cli_options.t - D t/stow.t +R098 t/stow.t t/cli_options.t Mon Jan 9 22:10:19 2012 +0000 Adam Spiers @@ -1097,9 +2812,8 @@ Thu Nov 24 17:00:33 2011 +0000 Adam Spiers * Auto-generate ChangeLog from git M .gitignore - D ChangeLog M Makefile.am - A doc/ChangeLog.OLD +R099 ChangeLog doc/ChangeLog.OLD Thu Nov 24 16:59:45 2011 +0000 Adam Spiers @@ -1313,23 +3027,15 @@ Mon Nov 21 13:59:36 2011 +0000 Adam Spiers A META.json A META.yml M Makefile.am - A automake/install-sh - A automake/mdate-sh - A automake/missing - A bin/chkstow.in - A bin/stow.in - D chkstow.in +R100 install-sh automake/install-sh +R100 mdate-sh automake/mdate-sh +R100 missing automake/missing +R091 chkstow.in bin/chkstow.in +R096 stow.in bin/stow.in M configure.ac - A doc/stow.8 - A doc/stow.texi - A doc/texinfo.tex - D install-sh - D mdate-sh - D missing - D stow.8 - D stow.in - D stow.texi - D texinfo.tex +R099 stow.8 doc/stow.8 +R099 stow.texi doc/stow.texi +R099 texinfo.tex doc/texinfo.tex Mon Nov 21 14:07:39 2011 +0000 Adam Spiers @@ -1360,10 +3066,9 @@ Thu Nov 24 16:28:09 2011 +0000 Adam Spiers M t/parent.t M t/stow.t M t/stow_contents.t - A t/testutil.pm +R083 t/util.pm t/testutil.pm M t/unstow_contents.t M t/unstow_contents_orig.t - D t/util.pm Fri Nov 18 15:09:39 2011 +0000 Adam Spiers diff --git a/local/share/doc/stow/INSTALL.md b/local/share/doc/stow/INSTALL.md new file mode 100644 index 0000000..a85ad87 --- /dev/null +++ b/local/share/doc/stow/INSTALL.md @@ -0,0 +1,202 @@ +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. diff --git a/local/share/doc/stow/README b/local/share/doc/stow/README deleted file mode 100644 index d8df705..0000000 --- a/local/share/doc/stow/README +++ /dev/null @@ -1,53 +0,0 @@ -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). diff --git a/local/share/doc/stow/README.md b/local/share/doc/stow/README.md new file mode 100644 index 0000000..525a573 --- /dev/null +++ b/local/share/doc/stow/README.md @@ -0,0 +1,101 @@ +[![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. diff --git a/local/share/doc/stow/manual-single.html b/local/share/doc/stow/manual-single.html index 6f112cc..7f288da 100644 --- a/local/share/doc/stow/manual-single.html +++ b/local/share/doc/stow/manual-single.html @@ -1,21 +1,23 @@ - + - + + + - - +approved by the Free Software Foundation. --> Stow - - + + + + + + + - + - - - - - - -
[Top][Contents][Index][ ? ]
- -

Stow

-

This manual describes GNU Stow 2.2.2 (9 November 2015), a -program for managing the installation of software packages. + + + + + +

+
+

+Next:   [Contents][Index]

+
+ +

This manual describes GNU Stow 2.3.2-fixbug56727 (23 October 2023), a +symlink farm manager which takes distinct sets of software and/or data +located in separate directories on the filesystem, and makes them +appear to be installed in a single directory tree.

- - - - - - - - - - - - - - - - - - - - - - - - - -
1. Introduction   Description of Stow. -
2. Terminology   Terms used by this manual. -
3. Invoking Stow   Option summary. -
4. Ignore Lists   Controlling what gets stowed. -
5. Installing Packages   Using Stow to install. -
6. Deleting Packages   Using Stow to uninstall. -
7. Conflicts   When Stow can’t stow. -
8. Mixing Operations   Multiple actions per invocation. -
9. Multiple Stow Directories   Further segregating software. -
10. Target Maintenance   Cleaning up mistakes. -
11. Resource Files   Setting default command line options. -
12. Compile-time vs Install-time   Faking out ‘make install’. -
13. Bootstrapping   When stow and perl are not yet stowed. -
14. Reporting Bugs   How, what, where, and when to report. -
15. Known Bugs   Don’t report any of these. -
GNU General Public License   Copying terms. -
Index   Index of concepts. -
 — The Detailed Node Listing —
 
-Ignore Lists
+

+
Table of Contents

 
-
4.1 Motivation For Ignore Lists   -
4.2 Types And Syntax Of Ignore Lists   -
4.3 Justification For Yet Another Set Of Ignore Files   -
-Advice on changing compilation and installation parameters
+

 
-
12.2 GNU Emacs   -
12.3 Other FSF Software   -
12.4 Cygnus Software   -
12.5 Perl and Perl 5 Modules   -
-
+ +
+ +
+
+
+

+Next:   [Contents][Index]

+
+

1 Introduction

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

1. Introduction

- -

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 ‘/usr/local’. When one does so, one -winds up with the following files(1) in ‘/usr/local/man/man1’: +

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.

-
 
a2p.1
+
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.  When one does so, one winds up with the following
+files1 in
+/usr/local/man/man1:
+

+

+
a2p.1
 ctags.1
 emacs.1
 etags.1
 h2ph.1
 perl.1
 s2p.1
-
+

Now suppose it’s time to uninstall Perl. Which man pages -get removed? Obviously ‘perl.1’ is one of them, but it should not +get removed? Obviously 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.

@@ -197,194 +183,197 @@ 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 ‘bin’ directory -containing executables, a ‘man/man1’ directory containing section 1 +tree; i.e. (in the typical case) there should be a bin directory +containing executables, a man/man1 directory containing section 1 man pages, 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 +directory2, +especially when coupled with version control +systems3. +

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

For information about the latest version of Stow, you can refer to -http://www.gnu.org/software/stow/. +http://www.gnu.org/software/stow/.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

2. Terminology

+
+ +
+
+

+Next: , Previous:   [Contents][Index]

+
+

2 Terminology

- -

A package is a related collection of files and directories that + +

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., with -‘bin’, ‘lib’, and ‘man’ subdirectories. +bin, lib, and man subdirectories.

- -

A target directory is the root of a tree in which one or more -packages wish to appear to be installed. A common, but by no -means the only such location is ‘/usr/local’. The examples in this -manual will use ‘/usr/local’ as the target directory. + +

A target directory is the root of a tree in which one or more +packages wish to appear to be installed. A common, but by no +means the only such location is /usr/local. The examples in this +manual will use /usr/local as the target directory.

- -

A stow directory is the root of a tree containing separate + +

A stow directory 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 ‘/usr/local/stow’ as the stow directory, so that -individual packages will be, for example, ‘/usr/local/stow/perl’ -and ‘/usr/local/stow/emacs’. +will use /usr/local/stow as the stow directory, so that +individual packages will be, for example, /usr/local/stow/perl +and /usr/local/stow/emacs.

- -

An installation image is the layout of files and directories + +

An installation image is the layout of files and directories required by a package, relative to the target directory. Thus, the -installation image for Perl includes: a ‘bin’ directory containing -‘perl’ and ‘a2p’ (among others); an ‘info’ directory -containing Texinfo documentation; a ‘lib/perl’ directory containing -Perl libraries; and a ‘man/man1’ directory containing man pages. +installation image for Perl includes: a bin directory containing +perl and a2p (among others); an info directory +containing Texinfo documentation; a lib/perl directory containing +Perl libraries; and a man/man1 directory containing man pages.

- - -

A package directory is the root of a tree containing the + + +

A package directory 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 -‘/usr/local/stow/perl’ must reside in the stow directory -‘/usr/local/stow’. The name of a package is the name of its -directory within the stow directory — e.g., ‘perl’. +/usr/local/stow/perl must reside in the stow directory +/usr/local/stow. The name of a package is the name of its +directory within the stow directory — e.g., perl.

Thus, the Perl executable might reside in -‘/usr/local/stow/perl/bin/perl’, where ‘/usr/local’ is the -target directory, ‘/usr/local/stow’ is the stow directory, -‘/usr/local/stow/perl’ is the package directory, and -‘bin/perl’ within is part of the installation image. +/usr/local/stow/perl/bin/perl, where /usr/local is the +target directory, /usr/local/stow is the stow directory, +/usr/local/stow/perl is the package directory, and +bin/perl within is part of the installation image.

- - - -

A symlink is a symbolic link. A symlink can be relative or -absolute. An absolute symlink names a full path; that is, one -starting from ‘/’. A relative symlink names a relative path; that -is, one not starting from ‘/’. The target of a relative symlink is + + + +

A symlink is a symbolic link. A symlink can be relative or +absolute. An absolute symlink names a full path; that is, one +starting from /. A relative symlink names a relative path; that +is, one not starting from /. The target of a relative symlink is computed starting from the symlink’s own directory. Stow only creates relative symlinks.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

3. Invoking Stow

+
+
+
+
+

+Next: , Previous:   [Contents][Index]

+
+

3 Invoking Stow

-

The syntax of the stow command is: +

The syntax of the stow command is:

-
 
stow [options] [action flag] package …
-
+
+
stow [options] [action flag] package ...
+
-

Each package is the name of a package (e.g., ‘perl’) in the stow +

Each package is the name of a package (e.g., ‘perl’) 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 action flag. +may be specified by preceding the package name(s) with an action flag.

The following options are supported:

-
-
‘-d dir’
-
‘--dir=dir’
-

Set the stow directory to dir. Defaults to the value of the environment -variable STOW_DIR if set, or the current directory otherwise. +

+
‘-d dir’
+
‘--dir=dir’
+

Set the stow directory to dir. Defaults to the value of the environment +variable STOW_DIR if set, or the current directory otherwise.

-
‘-t dir’
-
‘--target=dir’
-

Set the target directory to dir instead of the parent of the stow +

‘-t dir’
+
‘--target=dir’
+

Set the target directory to dir instead of the parent of the stow directory. Defaults to the parent of the stow directory, so it is typical to -execute stow from the directory ‘/usr/local/stow’. +execute stow from the directory /usr/local/stow.

-
‘--ignore=regexp’
+
‘--ignore=regexp’

This (repeatable) option lets you suppress acting on files that match the -given perl regular expression. For example, using the options +given Perl regular expression. For example, using the options

-
 
--ignore='*.orig' --ignore='*.dist'
-
+
+
--ignore='.*\.orig' --ignore='.*\.dist'
+
-

will cause stow to ignore files ending in ‘.orig’ or ‘.dist’. +

will cause stow to ignore files ending in .orig or .dist.

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.

Also note that by default Stow automatically ignores a “sensible” -built-in list of files and directories such as ‘CVS’, editor -backup files, and so on. See section Ignore Lists, for more details. +built-in list of files and directories such as CVS, editor +backup files, and so on. See Ignore Lists, for more details.

-
‘--defer=regexp’
+
‘--defer=regexp’

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 ‘--override’. +This is effectively the opposite of --override.

-

(N.B. the name ‘--defer’ was chosen in the sense that the package +

(N.B. the name --defer 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 Deferred Operation.) +this nomenclature with the wording used in Deferred Operation.)

For example, the following options

-
 
--defer=man --defer=info
-
+
+
--defer=man --defer=info
+

will cause stow to skip over pre-existing man and info pages.

-

Equivalently, you could use ‘--defer='man|info'’ since the -argument is just a Perl regex. +

Equivalently, you could use ‘--defer='man|info'’ since the +argument is just a Perl regular expression.

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.

-
‘--override=regexp’
+
‘--override=regexp’

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

-
 
--override=man --override=info
-
+
+
--override=man --override=info
+

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. @@ -393,20 +382,38 @@ pages that are owned by stow and would otherwise cause a conflict. the target directory, because this is what you will want to do most of the time.

-
‘--no-folding’
+
‘--dotfiles’
-

This disables any further tree folding or tree refolding. -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. +

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, +stow/dot-bashrc and stow/dot-emacs.d/init.el. With this +option, Stow will create symlinks from .bashrc to +stow/dot-bashrc and from .emacs.d/init.el to +stow/dot-emacs.d/init.el. Any other files, whose name does not +begin with ‘dot-’, will be processed as usual.

-
-
‘--adopt’
-

Warning! This behaviour is specifically intended to alter the +

‘--no-folding’
+
+

This disables any further tree folding (see tree folding) or +refolding (see tree refolding). 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. +

+
+
‘--adopt’
+

Warning! 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.

@@ -423,190 +430,149 @@ changing. 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 ‘git diff ...’ -inside the stow package, and finally either kept (e.g. via ‘git -commit ...’) or discarded (‘git checkout HEAD ...’). +package, then compared by running something like ‘git diff ...’ +inside the stow package, and finally either kept (e.g. via ‘git +commit ...’) or discarded (‘git checkout HEAD ...’).

- -
-
‘-n’
-
‘--no’
-
‘--simulate’
+
+‘-n’
+
‘--no’
+
‘--simulate’

Do not perform any operations that modify the file system; in combination with -‘-v’ can be used to merely show what would happen. +-v can be used to merely show what would happen.

-
-
‘-v’
-
‘--verbose[=n]’
+
‘-v’
+
‘--verbose[=n]’

Send verbose output to standard error describing what Stow is -doing. Verbosity levels are 0, 1, 2, and 3; 0 is the default. Using -‘-v’ or ‘--verbose’ increases the verbosity by one; using -‘--verbose=n’ sets it to n. +doing. Verbosity levels are from 0 to 5; 0 is the default. Using +-v or --verbose increases the verbosity by one; using +‘--verbose=n’ sets it to n.

-
‘-p’
-
‘--compat’
+
‘-p’
+
‘--compat’

Scan the whole target tree when unstowing. By default, only -directories specified in the installation image are scanned +directories specified in the installation image 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 ‘--badlinks’ option to the -chkstow utility may be a better way of ensuring that your -installation does not have any dangling symlinks (see section Target Maintenance). +the legacy behaviour; however, the --badlinks option to the +chkstow utility may be a better way of ensuring that your +installation does not have any dangling symlinks (see Target Maintenance).

-
‘-V’
-
‘--version’
+
‘-V’
+
‘--version’

Show Stow version number, and exit.

-
‘-h’
-
‘--help’
+
‘-h’
+
‘--help’

Show Stow command syntax, and exit.

-

The following action flags are supported: +

The following action flags are supported:

-
-
‘-D’
-
‘--delete’
-

Delete (unstow) the package name(s) that follow this option from the target +

+
‘-D’
+
‘--delete’
+

Delete (unstow) the package name(s) that follow this option from the target directory. This option may be repeated any number of times.

-
‘-R’
-
‘--restow’
+
‘-R’
+
‘--restow’

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.

-
‘-S’
-
‘--stow’
+
‘-S’
+
‘--stow’

explictly stow the package name(s) that follow this option. May be -omitted if you are not using the ‘-D’ or ‘-R’ options in the -same invocation. See section Mixing Operations, for details of when you +omitted if you are not using the -D or -R options in the +same invocation. See Mixing Operations, for details of when you might like to use this feature. This option may be repeated any number of times.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

4. Ignore Lists

+
+
+
+
+

+Next: , Previous:   [Contents][Index]

+
+

4 Ignore Lists

- - + + - - - - -
4.1 Motivation For Ignore Lists   -
4.2 Types And Syntax Of Ignore Lists   -
4.3 Justification For Yet Another Set Of Ignore Files   -
-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

4.1 Motivation For Ignore Lists

+ +
+
+
+

+Next: , Previous: , Up: Ignore Lists   [Contents][Index]

+
+

4.1 Motivation For Ignore Lists

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 -‘.gitignore’, ‘CVS’, ‘*,v’ (RCS files) should typically +.gitignore, CVS, *,v (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.

In these cases, it can be rather cumbersome to specify a -‘--ignore’ parameter for each file or directory to be ignored. +--ignore parameter for each file or directory to be ignored. This could be worked around by ensuring the existence of -‘~/.stowrc’ containing multiple ‘--ignore’ lines, or if a +~/.stowrc containing multiple --ignore lines, or if a different set of files/directories should be ignored depending on -which stow package is involved, a ‘.stowrc’ file for each stow +which stow package is involved, a .stowrc 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 -‘.stowrc’ onto ARGV at run-time, it could clutter up the process +.stowrc 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.

- -

Therefore in addition to ‘--ignore’ parameters, Stow provides a + +

Therefore in addition to --ignore parameters, Stow provides a way to specify lists of files and directories to ignore.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

4.2 Types And Syntax Of Ignore Lists

+
+
+
+
+

+Next: , Previous: , Up: Ignore Lists   [Contents][Index]

+
+

4.2 Types And Syntax Of Ignore Lists

If you put Perl regular expressions, one per line, in a -‘.stow-local-ignore’ file within any top level package directory, +.stow-local-ignore 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 -‘~/.stow-global-ignore’, if it exists. If neither the +~/.stow-global-ignore, 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:

-
 
# Comments and blank lines are allowed.
+

+
# Comments and blank lines are allowed.
 
 RCS
 .+,v
@@ -628,93 +594,78 @@ _darcs
 ^/README.*
 ^/LICENSE.*
 ^/COPYING
-
+

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 ‘#’ symbol in a regular expression, escape it with a +include the ‘#’ 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 ‘/’ forward +of two sets depending on whether it contains the ‘/’ forward slash symbol.

Then in order to determine whether a file or directory should be ignored:

-
    -
  1. -Stow calculates its path relative to the top-level package directory, -prefixing that with ‘/’. If any of the regular expressions -containing a ‘/’ exactly(2) match -a subpath(3) of this relative path, then the file or +
      +
    1. Stow calculates its path relative to the top-level package directory, +prefixing that with ‘/’. If any of the regular expressions +containing a ‘/’ exactly4 match +a subpath5 of this relative path, then the file or directory will be ignored. -
    2. -If none of the regular expressions containing a ‘/’ match in the +
    3. If none of the regular expressions containing a ‘/’ match in the manner described above, Stow checks whether the -basename(4) of the file or directory matches -exactly against the remaining regular expressions which do not -contain a ‘/’, and if so, ignores the file or directory. +basename6 of the file or directory matches +exactly against the remaining regular expressions which do not +contain a ‘/’, and if so, ignores the file or directory. -
    4. -Otherwise, the file or directory is not ignored. +
    5. Otherwise, the file or directory is not ignored.
    -

    For example, if a file ‘bazqux’ is in the ‘foo/bar’ +

    For example, if a file bazqux is in the foo/bar subdirectory of the package directory, Stow would use -‘/foo/bar/bazqux’ as the text for matching against regular -expressions which contain ‘/’, and ‘bazqux’ as the text for -matching against regular expressions which don’t contain ‘/’. -Then regular expressions ‘bazqux’, ‘baz.*’, ‘.*qux’, -‘bar/.*x’, and ‘^/foo/.*qux’ would all match (causing the -file to be ignored), whereas ‘bar’, ‘baz’, ‘qux’, and -‘o/bar/b’ would not (although ‘bar’ would cause its parent +‘/foo/bar/bazqux’ as the text for matching against regular +expressions which contain ‘/’, and ‘bazqux’ as the text for +matching against regular expressions which don’t contain ‘/’. +Then regular expressions ‘bazqux’, ‘baz.*’, ‘.*qux’, +‘bar/.*x’, and ‘^/foo/.*qux’ would all match (causing the +file to be ignored), whereas ‘bar’, ‘baz’, ‘qux’, and +‘o/bar/b’ would not (although ‘bar’ would cause its parent directory to be ignored and prevent Stow from recursing into that -anyway, in which case the file ‘bazqux’ would not even be +anyway, in which case the file bazqux would not even be considered for stowing).

    As a special exception to the above algorithm, any -‘.stow-local-ignore’ present in the top-level package directory -is always ignored, regardless of the contents of any ignore +.stow-local-ignore present in the top-level package directory +is always ignored, regardless of the contents of any ignore list, because this file serves no purpose outside the stow directory.

    -
    - - - - - - - - - - - - - - - - -
    [ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
    - -

    4.3 Justification For Yet Another Set Of Ignore Files

    +
    +
+
+
+

+Previous: , Up: Ignore Lists   [Contents][Index]

+
+

4.3 Justification For Yet Another Set Of Ignore Files

The reader may note that this format is very similar to existing -ignore list file formats, such as those for cvs, git, -rsync etc., and wonder if another set of ignore lists is +ignore list file formats, such as those for cvs, git, +rsync 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, ‘.cvsignore’, and use that if it +check for the presence of say, .cvsignore, 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. +it didn’t already exist.

Secondly even if it did, version control system ignore lists generally -reflect build-time ignores rather than install-time, and +reflect build-time ignores rather than install-time, 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 not in the version control +stowed. Similarly, if a file is not 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. @@ -724,28 +675,17 @@ 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.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

5. Installing Packages

+
+
+ +
+
+

+Next: , Previous:   [Contents][Index]

+
+

5 Installing Packages

- +

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 @@ -753,224 +693,137 @@ 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.

-

-

- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
-

5.1 Tree folding

- - - + +
+

5.1 Tree folding

+ + +

For example, suppose that no packages have yet been installed in -‘/usr/local’; it’s completely empty (except for the ‘stow’ +/usr/local; it’s completely empty (except for the stow subdirectory, of course). Now suppose the Perl package is installed. Recall that it includes the following directories in its installation -image: ‘bin’; ‘info’; ‘lib/perl’; ‘man/man1’. -Rather than creating the directory ‘/usr/local/bin’ and populating -it with symlinks to ‘../stow/perl/bin/perl’ and -‘../stow/perl/bin/a2p’ (and so on), Stow will create a -single symlink, ‘/usr/local/bin’, which points to -‘stow/perl/bin’. In this way, it still works to refer to -‘/usr/local/bin/perl’ and ‘/usr/local/bin/a2p’, and fewer -symlinks have been created. This is called tree folding, since an +image: bin; info; lib/perl; man/man1. +Rather than creating the directory /usr/local/bin and populating +it with symlinks to ../stow/perl/bin/perl and +../stow/perl/bin/a2p (and so on), Stow will create a +single symlink, /usr/local/bin, which points to +stow/perl/bin. In this way, it still works to refer to +/usr/local/bin/perl and /usr/local/bin/a2p, and fewer +symlinks have been created. This is called tree folding, since an entire subtree is “folded” into a single symlink.

To complete this example, Stow will also create the symlink -‘/usr/local/info’ pointing to ‘stow/perl/info’; the symlink -‘/usr/local/lib’ pointing to ‘stow/perl/lib’; and the symlink -‘/usr/local/man’ pointing to ‘stow/perl/man’. +/usr/local/info pointing to stow/perl/info; the symlink +/usr/local/lib pointing to stow/perl/lib; and the symlink +/usr/local/man pointing to stow/perl/man.

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, ‘/usr/local/bin’ -already exists and is a directory, as are ‘/usr/local/lib’ and -‘/usr/local/man/man1’. In this case, Stow will descend into -‘/usr/local/bin’ and create symlinks to -‘../stow/perl/bin/perl’ and ‘../stow/perl/bin/a2p’ (etc.), -and it will descend into ‘/usr/local/lib’ and create the -tree-folding symlink ‘perl’ pointing to -‘../stow/perl/lib/perl’, and so on. As a rule, Stow only +system-administration philosophy. In particular, /usr/local/bin +already exists and is a directory, as are /usr/local/lib and +/usr/local/man/man1. In this case, Stow will descend into +/usr/local/bin and create symlinks to +../stow/perl/bin/perl and ../stow/perl/bin/a2p (etc.), +and it will descend into /usr/local/lib and create the +tree-folding symlink perl pointing to +../stow/perl/lib/perl, 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 ‘--no-folding’ option; see section Invoking Stow. +the --no-folding option; see Invoking Stow.

-

-

- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
-

5.2 Tree unfolding

- - - - +
+
+

5.2 Tree unfolding

+ + + +

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 or -unfolding a folded tree. It involves removing the original symlink from +its installation image. This operation is called splitting open or +unfolding 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 and to +new directory with symlinks to the newly-installed package and to the old package that used the old symlink. For example, suppose that -after installing Perl into an empty ‘/usr/local’, we wish to -install Emacs. Emacs’s installation image includes a ‘bin’ -directory containing the ‘emacs’ and ‘etags’ executables, +after installing Perl into an empty /usr/local, we wish to +install Emacs. Emacs’s installation image includes a bin +directory containing the emacs and etags executables, among others. Stow must make these files appear to be installed -in ‘/usr/local/bin’, but presently ‘/usr/local/bin’ is a -symlink to ‘stow/perl/bin’. Stow therefore takes the -following steps: the symlink ‘/usr/local/bin’ is deleted; the -directory ‘/usr/local/bin’ is created; links are made from -‘/usr/local/bin’ to ‘../stow/emacs/bin/emacs’ and -‘../stow/emacs/bin/etags’; and links are made from -‘/usr/local/bin’ to ‘../stow/perl/bin/perl’ and -‘../stow/perl/bin/a2p’. +in /usr/local/bin, but presently /usr/local/bin is a +symlink to stow/perl/bin. Stow therefore takes the +following steps: the symlink /usr/local/bin is deleted; the +directory /usr/local/bin is created; links are made from +/usr/local/bin to ../stow/emacs/bin/emacs and +../stow/emacs/bin/etags; and links are made from +/usr/local/bin to ../stow/perl/bin/perl and +../stow/perl/bin/a2p.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
-

5.3 Ownership

- +
+
+

5.3 Ownership

+

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. Stow will never delete anything +current stow directory. Stow will never delete anything that it doesn’t own. Stow “owns” 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 “owns”. Note that by this definition, Stow doesn’t “own” anything -in the stow directory or in any of the packages. +in the stow directory or in any of the packages.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
-

5.4 Conflicts during installation

- - +
+
+

5.4 Conflicts during installation

+ +

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 section Conflicts. +by Stow, then a conflict has arisen. See Conflicts.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

6. Deleting Packages

+
+
+
+
+
+

+Next: , Previous:   [Contents][Index]

+
+

6 Deleting Packages

- -

When the ‘-D’ option is given, the action of Stow is to + +

When the -D 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 not +delete anything it doesn’t “own”. Deleting a package does not mean removing it from the stow directory or discarding the package tree.

To delete a package, Stow recursively scans the target tree, skipping over any -directory that is not included in the installation image.(5) -For example, if the target directory is ‘/usr/local’ and the -installation image for the package being deleted has only a ‘bin’ -directory and a ‘man’ directory at the top level, then we only scan -‘/usr/local/bin’ and ‘/usr/local/bin/man’, and not -‘/usr/local/lib’ or ‘/usr/local/share’, or for that matter -‘/usr/local/stow’. Any symlink it finds that points into the package +directory that is not included in the installation image.7 +For example, if the target directory is /usr/local and the +installation image for the package being deleted has only a bin +directory and a man directory at the top level, then we only scan +/usr/local/bin and /usr/local/man, and not +/usr/local/lib or /usr/local/share, or for that matter +/usr/local/stow. 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.

-

-

- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
-

6.1 Refolding “foldable” trees.

- - + +
+

6.1 Refolding “foldable” trees.

+ +

After removing symlinks and empty subdirectories, any directory that contains only symlinks to a single other package is considered to be a @@ -978,34 +831,23 @@ previously “folded” tree that was “split open.” Stow wi 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 -‘--no-folding’ option; see section Invoking Stow. +--no-folding option; see Invoking Stow.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

7. Conflicts

+
+
+
+
+
+

+Next: , Previous:   [Contents][Index]

+
+

7 Conflicts

- +

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 -conflict has arisen. A conflict also occurs if a directory exists +conflict 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 @@ -1017,27 +859,12 @@ 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.

-

-

- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
-

7.1 Deferred Operation

- + +
+

7.1 Deferred Operation

+

Since version 2.0, Stow now adopts a two-phase algorithm, first scanning for any potential conflicts before any stowing or unstowing @@ -1050,319 +877,271 @@ being partially stowed or unstowed due to conflicts. operation could be aborted mid-flow, leaving the target tree in an inconsistent state.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

8. Mixing Operations

- +
+
+
+
+
+

+Next: , Previous:   [Contents][Index]

+
+

8 Mixing Operations

+

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:

-
 
stow -D emacs-21.3 -S emacs-21.4a
-
+
+
stow -D emacs-21.3 -S emacs-21.4a
+

which will replace emacs-21.3 with emacs-21.4a using a single invocation.

- +

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 Deferred Operation), so the +and merged before being executed (see Deferred Operation), so the amount of of time in which GNU Emacs is unavailable is minimised.

You can mix and match any number of actions, for example,

-
 
stow -S pkg1 pkg2 -D pkg3 pkg4 -S pkg5 -R pkg6
-
+
+
stow -S pkg1 pkg2 -D pkg3 pkg4 -S pkg5 -R pkg6
+

will unstow pkg3, pkg4 and pkg6, then stow pkg1, pkg2, pkg5 and pkg6.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

9. Multiple Stow Directories

+
+
+
+
+

+Next: , Previous:   [Contents][Index]

+
+

9 Multiple Stow Directories

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 ‘.stow’ -in each stow directory. The presence of ‘/usr/local/foo/.stow’ -informs Stow that, though ‘foo’ is not the current stow +stow directories, it can be done by creating a file named .stow +in each stow directory. The presence of /usr/local/foo/.stow +informs Stow that, though foo is not the current stow directory, even if it is a subdirectory of the target directory, -nevertheless it is a stow directory and as such Stow -doesn’t “own” anything in it (see section Installing Packages). This will -protect the contents of ‘foo’ from a ‘stow -D’, for instance. +nevertheless it is a stow directory and as such Stow +doesn’t “own” anything in it (see Installing Packages). This will +protect the contents of foo from a ‘stow -D’, for instance.

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 ‘.stow’, Stow knows how to split +existing symlink points contains .stow, Stow knows how to split open the tree in the correct manner.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

10. Target Maintenance

+
+
+
+
+

+Next: , Previous:   [Contents][Index]

+
+

10 Target Maintenance

- +

From time to time you will need to clean up your target tree. Since -version 2, Stow provides a new utility chkstow to help with +version 2, Stow provides a new utility chkstow 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.

-

The syntax of the chkstow command is: +

The syntax of the chkstow command is:

-
 
chkstow [options]
-
+
+
chkstow [options]
+

The following options are supported:

-
-
‘-t dir’
-
‘--target=dir’
-

Set the target directory to dir instead of the parent of the stow +

+
‘-t dir’
+
‘--target=dir’
+

Set the target directory to dir instead of the parent of the stow directory. Defaults to the parent of the stow directory, so it is typical to -execute stow from the directory ‘/usr/local/stow’. +execute stow from the directory /usr/local/stow.

-
‘-b’
-
‘--badlinks’
+
‘-b’
+
‘--badlinks’

Checks target directory for bogus symbolic links. That is, links that point to non-existent files.

-
‘-a’
-
‘--aliens’
+
‘-a’
+
‘--aliens’

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 ‘.stow’ file. +contain a .stow file.

-
‘-l’
-
‘--list’
+
‘-l’
+
‘--list’

Will display the target package for every symbolic link in the stow target directory.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

11. Resource Files

- - +
+
+
+
+

+Next: , Previous:   [Contents][Index]

+
+

11 Resource Files

+ + -

Default command line options may be set in ‘.stowrc’ (current directory) or -‘~/.stowrc’ (home directory). These are parsed in that order, and effectively -prepended to you command line. This feature can be used for some interesting -effects. +

Default command line options may be set in .stowrc (current +directory) or ~/.stowrc (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.

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 -‘~/.stowrc’ file: +~/.stowrc file:

-
 
--dir=/usr/local/stow2
+

+
--dir=/usr/local/stow2
 --target=/usr/local
 --ignore='~'
 --ignore='^CVS'
-
+
-

so that the stow command will default to operating on the -‘/usr/local/stow2’ directory, with ‘/usr/local’ as the +

so that the stow command will default to operating on the +/usr/local/stow2 directory, with /usr/local as the target, and ignoring vi backup files and CVS directories.

-

If you had a stow directory ‘/usr/local/stow/perl-extras’ that +

If you had a stow directory /usr/local/stow/perl-extras that was only used for Perl modules, then you might place the following in -‘/usr/local/stow/perl-extras/.stowrc’: +/usr/local/stow/perl-extras/.stowrc:

-
 
--dir=/usr/local/stow/perl-extras
+

+
--dir=/usr/local/stow/perl-extras
 --target=/usr/local
 --override=bin
 --override=man
 --ignore='perllocal\.pod'
 --ignore='\.packlist'
 --ignore='\.bs'
-
+ -

so that when you are in the ‘/usr/local/stow/perl-extras’ -directory, stow will regard any subdirectories as stow -packages, with ‘/usr/local’ as the target (rather than the -immediate parent directory ‘/usr/local/stow’), overriding any +

so that when you are in the /usr/local/stow/perl-extras +directory, stow will regard any subdirectories as stow +packages, with /usr/local as the target (rather than the +immediate parent directory /usr/local/stow), overriding any pre-existing links to bin files or man pages, and ignoring some cruft that gets installed by default.

- -
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

12. Compile-time vs Install-time

+

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 --target or --dir, the command line +option will overwrite any options in the resource file. For options that can +be given more than once, --ignore for example, command line +options and resource options are appended together. +

+

For options that take a file path, environment variables and the tilde +character (~) are expanded. An environment variable can be +given in either the $VAR or ${VAR} form. To +prevent expansion, escape the $ or ~ with a +backslash. +

+

The options -D, -S, and -R are ignored in +resource files. This is also true of any package names given in the +resource file. +

+
+ +
+
+

+Next: , Previous:   [Contents][Index]

+
+

12 Compile-time vs Install-time

Software whose installation is managed with Stow needs to be installed -in one place (the package directory, e.g. ‘/usr/local/stow/perl’) +in one place (the package directory, e.g. /usr/local/stow/perl) but needs to appear to run in another place (the target tree, e.g., -‘/usr/local’). Why is this important? What’s wrong with Perl, for -instance, looking for its files in ‘/usr/local/stow/perl’ instead -of in ‘/usr/local’? +/usr/local). Why is this important? What’s wrong with Perl, for +instance, looking for its files in /usr/local/stow/perl instead +of in /usr/local?

The answer is that there may be another package, e.g., -‘/usr/local/stow/perl-extras’, stowed under ‘/usr/local’. If -Perl is configured to find its files in ‘/usr/local/stow/perl’, it -will never find the extra files in the ‘perl-extras’ package, even +/usr/local/stow/perl-extras, stowed under /usr/local. If +Perl is configured to find its files in /usr/local/stow/perl, it +will never find the extra files in the ‘perl-extras’ package, even though they’re intended to be found by Perl. On the other hand, if Perl -looks for its files in ‘/usr/local’, then it will find the -intermingled Perl and ‘perl-extras’ files. +looks for its files in /usr/local, then it will find the +intermingled Perl and ‘perl-extras’ files.

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.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
-

12.1 Advice on changing compilation and installation parameters

+ +
+

12.1 Advice on changing compilation and installation parameters

Some software packages allow you to specify, at compile-time, separate locations for installation and for run-time. Perl is one such package; -see Perl and Perl 5 Modules. Others allow you to compile the -package, then give a different destination in the ‘make install’ +see Perl and Perl 5 Modules. Others allow you to compile the +package, then give a different destination in the ‘make install’ step without causing the binaries or other files to get rebuilt. Most GNU software falls into this category; Emacs is a notable exception. -See section GNU Emacs, and Other FSF Software. +See GNU Emacs, and Other FSF Software.

Still other software packages cannot abide the idea of separate -installation and run-time locations at all. If you try to ‘make -install prefix=/usr/local/stow/foo’, then first the whole package -will be recompiled to hardwire the ‘/usr/local/stow/foo’ +installation and run-time locations at all. If you try to ‘make +install prefix=/usr/local/stow/foo’, then first the whole package +will be recompiled to hardwire the /usr/local/stow/foo path. With these packages, it is best to compile normally, then run -‘make -n install’, which should report all the steps needed to +‘make -n install’, 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 ‘make install’. Be sure to execute the -script using the same shell that ‘make install’ would have used. +shell script in place of ‘make install’. Be sure to execute the +script using the same shell that ‘make install’ would have used.

(If you use GNU Make and a shell [such as GNU bash] that understands -pushd and popd, you can do the following: +pushd and popd, you can do the following:

-
    -
  1. -Replace all lines matching ‘make[n]: Entering directory -dir’ with ‘pushd dir’. -
  2. -Replace all lines matching ‘make[n]: Leaving directory -dir’ with ‘popd’. -
  3. -Delete all lines matching ‘make[n]: Nothing to be done for -rule’. +
      +
    1. Replace all lines matching ‘make[n]: Entering directory +dir’ with ‘pushd dir’. +
    2. Replace all lines matching ‘make[n]: Leaving directory +dir’ with ‘popd’. +
    3. Delete all lines matching ‘make[n]: Nothing to be done for +rule’.
    -

    Then find other lines in the output containing cd or make +

    Then find other lines in the output containing cd or make commands and rewrite or delete them. In particular, you should be able to delete sections of the script that resemble this:

    -
     
    for i in dir_1 dir_2 …; do \
-  (cd $i; make args …) \
+
    
+
    for i in dir_1 dir_2 ...; do \
+  (cd $i; make args ...) \
 done
-
    +

Note, that’s “should be able to,” not “can.” Be sure to modulate these guidelines with plenty of your own intelligence. @@ -1370,165 +1149,111 @@ these guidelines with plenty of your own intelligence.

The details of stowing some specific packages are described in the following sections.

- - - - - -
12.2 GNU Emacs   -
12.3 Other FSF Software   -
12.4 Cygnus Software   -
12.5 Perl and Perl 5 Modules   -
-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

12.2 GNU Emacs

+
+
+
+
+

+Next: , Previous: , Up: Compile-time vs Install-time   [Contents][Index]

+
+

12.2 GNU Emacs

Although the Free Software Foundation has many enlightened practices -regarding Makefiles and software installation (see see section Other FSF Software), Emacs, its flagship program, doesn’t quite follow the +regarding Makefiles and software installation (see see Other FSF Software), Emacs, its flagship program, doesn’t quite follow the rules. In particular, most GNU software allows you to write:

-
 
make
-make install prefix=/usr/local/stow/package
-
+
+
make
+make install prefix=/usr/local/stow/package
+
-

If you try this with Emacs, then the new value for prefix in the -‘make install’ step will cause some files to get recompiled with -the new value of prefix wired into them. In Emacs 19.23 and -later,(6) +

If you try this with Emacs, then the new value for prefix in the +‘make install’ step will cause some files to get recompiled with +the new value of prefix wired into them. In Emacs 19.23 and +later,8 the way to work around this problem is:

-
 
make
+

+
make
 make install-arch-dep install-arch-indep prefix=/usr/local/stow/emacs
-
+

In 19.22 and some prior versions of Emacs, the workaround was:

-
 
make
+

+
make
 make do-install prefix=/usr/local/stow/emacs
-
+ -
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

12.3 Other FSF Software

+
+ +
+
+

+Next: , Previous: , Up: Compile-time vs Install-time   [Contents][Index]

+
+

12.3 Other FSF Software

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 ‘autoconf’ and ‘automake’, most packages +Thanks to its tools ‘autoconf’ and ‘automake’, most packages now respond well to these simple steps, with no other intervention necessary:

-
 
./configure options
+

+
./configure options
 make
-make install prefix=/usr/local/stow/package
-
+make install prefix=/usr/local/stow/package +

Hopefully, these tools can evolve to be aware of Stow-managed packages, -such that providing an option to ‘configure’ can allow ‘make’ -and ‘make install’ steps to work correctly without needing to +such that providing an option to ‘configure’ can allow ‘make’ +and ‘make install’ steps to work correctly without needing to “fool” the build process.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

12.4 Cygnus Software

+
+ +
+
+

+Next: , Previous: , Up: Compile-time vs Install-time   [Contents][Index]

+
+

12.4 Cygnus Software

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 ‘gdb’, -‘gnats’, and ‘dejagnu’. +other packages. Among the packages released by Cygnus are ‘gdb’, +‘gnats’, and ‘dejagnu’.

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 all of Cygnus’ packages, any number of which may reside +compile all of Cygnus’ packages, any number of which may reside under the top-level directory. In other words, even if you’re only -building ‘gnats’, the top-level Makefile will look for, and try to -build, ‘gdb’ and ‘dejagnu’ subdirectories, among many others. +building ‘gnats’, the top-level Makefile will look for, and try to +build, gdb and dejagnu subdirectories, among many others.

-

The result is that if you try ‘make -n install -prefix=/usr/local/stow/package’ at the top level of a Cygnus +

The result is that if you try ‘make -n install +prefix=/usr/local/stow/package’ 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.

-

In cases like this, the best approach is to run your ‘make install -prefix=…’, but be ready to interrupt it if you detect that it +

In cases like this, the best approach is to run your ‘make install +prefix=…’, but be ready to interrupt it if you detect that it is recompiling files. Usually it will work just fine; otherwise, install manually.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

12.5 Perl and Perl 5 Modules

+
+
+
+
+

+Previous: , Up: Compile-time vs Install-time   [Contents][Index]

+
+

12.5 Perl and Perl 5 Modules

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 @@ -1546,989 +1271,1056 @@ Depot, not from AFS.

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 unless you’re running AFS. Fortunately, after you’ve +trees unless 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 -‘config.sh’. When prompted, you should edit this file and replace +config.sh. When prompted, you should edit this file and replace occurrences of

-
 
inst…/usr/local…
-
+
+
inst.../usr/local...
+

with

-
 
inst…/usr/local/stow/perl…
-
+
+
inst.../usr/local/stow/perl...
+

You can do this with the following Unix command:

-
 
sed 's,^\(inst.*/usr/local\),\1/stow/perl,' config.sh > config.sh.new
+

+
sed 's,^\(inst.*/usr/local\),\1/stow/perl,' config.sh > config.sh.new
 mv config.sh.new config.sh
-
+

Hopefully, the Perl authors will correct this deficiency in Perl 5’s configuration mechanism.

Perl 5 modules—i.e., extensions to Perl 5—generally conform to a set of standards for building and installing them. The standard says that -the package comes with a top-level ‘Makefile.PL’, which is a Perl -script. When it runs, it generates a ‘Makefile’. +the package comes with a top-level Makefile.PL, which is a Perl +script. When it runs, it generates a Makefile.

-

If you followed the instructions above for editing ‘config.sh’ when -Perl was built, then when you create a ‘Makefile’ from a -‘Makefile.PL’, it will contain separate locations for run-time -(‘/usr/local’) and install-time (‘/usr/local/stow/perl’). +

If you followed the instructions above for editing config.sh when +Perl was built, then when you create a Makefile from a +Makefile.PL, it will contain separate locations for run-time +(/usr/local) and install-time (/usr/local/stow/perl). Thus you can do

-
 
perl Makefile.PL
+

+
perl Makefile.PL
 make
 make install
-
+ -

and the files will be installed into ‘/usr/local/stow/perl’. +

and the files will be installed into /usr/local/stow/perl. However, you might prefer each Perl module to be stowed separately. In that case, you must edit the resulting Makefile, replacing -‘/usr/local/stow/perl’ with ‘/usr/local/stow/module’. +/usr/local/stow/perl with /usr/local/stow/module. The best way to do this is:

-
 
perl Makefile.PL
+

+
perl Makefile.PL
 find . -name Makefile -print | \
-  xargs perl -pi~ -e 's,^(INST.*/stow)/perl,$1/module,;'
+  xargs perl -pi~ -e 's,^(INST.*/stow)/perl,$1/module,;'
 make
 make install
-
+ -

(The use of ‘find’ and ‘xargs’ ensures that all Makefiles in +

(The use of ‘find’ and ‘xargs’ 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 -module ‘cpan.module’, where ‘cpan’ stands for +module cpan.module, where ‘cpan’ 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 ‘/usr/local/stow’ are Perl 5 +glance which of the subdirectories of /usr/local/stow are Perl 5 extensions.

When you stow separate Perl 5 modules separately, you are likely to -encounter conflicts (see section Conflicts) with files named ‘.exists’ -and ‘perllocal.pod’. One way to work around this is to remove +encounter conflicts (see Conflicts) with files named .exists +and perllocal.pod. One way to work around this is to remove those files before stowing the module. If you use the -‘cpan.module’ naming convention, you can simply do this: +cpan.module naming convention, you can simply do this:

-
 
cd /usr/local/stow
+

+
cd /usr/local/stow
 find cpan.* \( -name .exists -o -name perllocal.pod \) -print | \
   xargs rm
-
+ -
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

13. Bootstrapping

+
+ + +
+
+

+Next: , Previous:   [Contents][Index]

+
+

13 Bootstrapping

Suppose you have a stow directory all set up and ready to go: -‘/usr/local/stow/perl’ contains the Perl installation, -‘/usr/local/stow/stow’ contains Stow itself, and perhaps you have +/usr/local/stow/perl contains the Perl installation, +/usr/local/stow/stow contains Stow itself, and perhaps you have other packages waiting to be stowed. You’d like to be able to do this:

-
 
cd /usr/local/stow
+

+
cd /usr/local/stow
 stow -vv *
-
+
-

but stow is not yet in your PATH. Nor can you do this: +

but stow is not yet in your PATH. Nor can you do this:

-
 
cd /usr/local/stow
+

+
cd /usr/local/stow
 stow/bin/stow -vv *
-
+ -

because the ‘#!’ line at the beginning of stow tries to -locate Perl (usually in ‘/usr/local/bin/perl’), and that won’t be +

because the ‘#!’ line at the beginning of stow tries to +locate Perl (usually in /usr/local/bin/perl), and that won’t be found. The solution you must use is:

-
 
cd /usr/local/stow
+

+
cd /usr/local/stow
 perl/bin/perl stow/bin/stow -vv *
-
+ -
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

14. Reporting Bugs

+
+ +
+
+

+Next: , Previous:   [Contents][Index]

+
+

14 Reporting Bugs

Please send bug reports to the current maintainers by electronic -mail. The address to use is ‘<bug-stow@gnu.org>’. Please +mail. The address to use is ‘<bug-stow@gnu.org>’. Please include:

-
    -
  • -the version number of Stow (‘stow --version’); +
      +
    • the version number of Stow (‘stow --version’); -
    • -the version number of Perl (‘perl -v’); +
    • the version number of Perl (‘perl -v’); -
    • -the system information, which can often be obtained with ‘uname +
    • the system information, which can often be obtained with ‘uname -a’; -
    • -a description of the bug; +
    • a description of the bug; -
    • -the precise command you gave; +
    • the precise command you gave; -
    • -the output from the command (preferably verbose output, obtained by -adding ‘--verbose=3’ to the Stow command line). +
    • the output from the command (preferably verbose output, obtained by +adding ‘--verbose=3’ to the Stow command line).

    If you are really keen, consider developing a minimal test case and -creating a new test. See the ‘t/’ directory in the source for +creating a new test. See the t/ directory in the source for lots of examples.

    Before reporting a bug, please read the manual carefully, especially -Known Bugs, to see whether you’re encountering +Known Bugs, to see whether you’re encountering something that doesn’t need reporting. -(see section Conflicts). +(see Conflicts).

    -
    - - - - - - - - - - - - - - - - -
    [ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
    - -

    15. Known Bugs

    +
    +
+
+
+

+Next: , Previous:   [Contents][Index]

+
+

15 Known Bugs

-

There are no known bugs in Stow version 2.2.2! -If you think you have found one, please see section Reporting Bugs. +

There are no known bugs in Stow version 2.3.2-fixbug56727! +If you think you have found one, please see Reporting Bugs.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

GNU General Public License

+
+
+
+
+

+Next: , Previous:   [Contents][Index]

+
+

GNU General Public License

-

Version 2, June 1991 +

Version 3, 29 June 2007 +
+ +
+
Copyright © 2007 Free Software Foundation, Inc. https://fsf.org/
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+ +

Preamble

+ +

The GNU General Public License is a free, copyleft license for +software and other kinds of works.

-
 
Copyright © 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.
-
- -
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
-

Preamble

- -

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—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. +

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

-

When we speak of free software, we are referring to freedom, not +

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

-

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

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.

-

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

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.

-

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

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.

-

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

For the developers’ and authors’ protection, the GPL clearly explains +that there is no warranty for this free software. For both users’ and +authors’ 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.

-

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

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

-

The precise terms and conditions for copying, distribution and +

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

+

The precise terms and conditions for copying, distribution and modification follow.

-

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION +

TERMS AND CONDITIONS

+ +
    +
  1. Definitions. + +

    “This License” refers to version 3 of the GNU General Public License.

    -
      -
    1. -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 “Program”, below, -refers to any such program or work, and a “work based on the Program” -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 “modification”.) Each licensee is addressed as “you”. - -

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

      “Copyright” also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks.

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

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

      “The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations.

      -
    3. -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: +

      To “modify” 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 “modified version” of +the earlier work or a work “based on” the earlier work. +

      +

      A “covered work” means either the unmodified Program or a work based +on the Program. +

      +

      To “propagate” 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. +

      +

      To “convey” 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. +

      +

      An interactive user interface displays “Appropriate Legal Notices” 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. +

      +
    4. Source Code. -
        -
      1. -You must cause the modified files to carry prominent notices -stating that you changed the files and the date of any change. +

        The “source code” for a work means the preferred form of the work for +making modifications to it. “Object code” means any non-source form +of a work. +

        +

        A “Standard Interface” 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. +

        +

        The “System Libraries” 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 +“Major Component”, 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. +

        +

        The “Corresponding Source” 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’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. +

        +

        The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. +

        +

        The Corresponding Source for a work in source code form is that same +work. +

        +
      2. Basic Permissions. -
      3. -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. +

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

        +

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

        +

        Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. +

        +
      4. Protecting Users’ Legal Rights From Anti-Circumvention Law. -
      5. -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.) +

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

        +

        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’s users, your or third parties’ legal rights to forbid +circumvention of technological measures. +

        +
      6. Conveying Verbatim Copies. + +

        You may convey 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; +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. +

        +

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

        +
      7. Conveying Modified Source Versions. + +

        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: +

        +
          +
        1. The work must carry prominent notices stating that you modified it, +and giving a relevant date. + +
        2. 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 “keep intact all +notices”. + +
        3. 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. + +
        4. 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.
        -

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

        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 +“aggregate” if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation’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.

        -

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

      8. Conveying Non-Source Forms. + +

        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:

        -

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

        -
      9. -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: +
          +
        1. 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. -
            -
          1. -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, +
          2. 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. -
          3. -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, +
          4. 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. + +
          5. 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. + +
          6. 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. -
          7. -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.)
          -

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

          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.

          -

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

          A “User Product” is either (1) a “consumer product”, 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, +“normally used” 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.

          -
        2. -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. +

          “Installation Information” 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. +

          +

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

          +

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

          +

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

          +
        3. Additional Terms. -
        4. -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. +

          “Additional permissions” 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. +

          +

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

          +

          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: +

          +
            +
          1. Disclaiming warranty or limiting liability differently from the terms +of sections 15 and 16 of this License; or -
          2. -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 +
          3. 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 + +
          4. 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 + +
          5. Limiting the use for publicity purposes of names of licensors or +authors of the material; or + +
          6. Declining to grant rights under trademark law for use of some trade +names, trademarks, or service marks; or + +
          7. 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. +
          + +

          All other non-permissive additional terms are considered “further +restrictions” 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. +

          +

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

          +

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

          +
        5. Termination. + +

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

          +

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

          +

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

          +

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

          +
        6. Acceptance Not Required for Having Copies. + +

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

          +
        7. Automatic Licensing of Downstream Recipients. + +

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

          +

          An “entity transaction” 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’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. +

          +

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

          +
        8. Patents. + +

          A “contributor” 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’s “contributor version”. +

          +

          A contributor’s “essential patent claims” 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, “control” includes the right to grant +patent sublicenses in a manner consistent with the requirements of this License. +

          +

          Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor’s essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. +

          +

          In the following three paragraphs, a “patent license” 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 “grant” such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. +

          +

          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. “Knowingly relying” means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient’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. +

          +

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

          +

          A patent license is “discriminatory” 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. +

          +

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

          +
        9. No Surrender of Others’ Freedom. -
        10. -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 +

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

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

          -

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

          -

          This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. -

          -
        11. -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. +
        12. Use with the GNU Affero General Public License. -
        13. -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. +

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

          +
        14. Revised Versions of this License. +

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

          Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and “any -later version”, 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. +specifies that a certain numbered version of the GNU General Public +License “or any later version” 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.

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

          NO WARRANTY +

          If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy’s public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program.

          -
        16. -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 “AS IS” 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. +

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

          +
        17. Disclaimer of Warranty. -
        18. -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. +

          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 “AS IS” 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. +

          +
        19. Limitation of Liability. + +

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

          +
        20. Interpretation of Sections 15 and 16. + +

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

        -

        END OF TERMS AND CONDITIONS -

        +

        END OF TERMS AND CONDITIONS

        -
        - - - - - - - - - - - - - - - - -
        [ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
        -

        How to Apply These Terms to Your New Programs

        +

        How to Apply These Terms to Your New Programs

        -

        If you develop a new program, and you want it to be of the greatest +

        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. +free software which everyone can redistribute and change under these +terms.

        -

        To do so, attach the following notices to the program. It is safest +

        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 +state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

        -
         
        one line to give the program's name and an idea of what it does.
-Copyright (C) 19yy  name of author
+
        
+
        one line to give the program's name and a brief idea of what it does.
+Copyright (C) year name of author
 
-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 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.
+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.
-
        +along with this program. If not, see https://www.gnu.org/licenses/. +

Also add information on how to contact you by electronic and paper mail.

-

If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: +

If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode:

-
 
Gnomovision version 69, Copyright (C) 19yy name of author
-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.
-
+
+
program Copyright (C) year name of author
+This program 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.
+
-

The hypothetical commands ‘show w’ and ‘show c’ should show -the appropriate parts of the General Public License. Of course, the -commands you use may be called something other than ‘show w’ and -‘show c’; they could even be mouse-clicks or menu items—whatever -suits your program. +

The hypothetical commands ‘show w’ and ‘show c’ should show +the appropriate parts of the General Public License. Of course, your +program’s commands might be different; for a GUI interface, you would +use an “about box”.

-

You should also get your employer (if you work as a programmer) or your -school, if any, to sign a “copyright disclaimer” for the program, if -necessary. Here is a sample; alter the names: +

You should also get your employer (if you work as a programmer) or school, +if any, to sign a “copyright disclaimer” for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +https://www.gnu.org/licenses/.

-
 
Yoyodyne, Inc., hereby disclaims all copyright
-interest in the program `Gnomovision'
-(which makes passes at compilers) written
-by James Hacker.
-
-signature of Ty Coon, 1 April 1989
-Ty Coon, President of Vice
-
- -

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

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 https://www.gnu.org/licenses/why-not-lgpl.html.

-
- - - - - - - - - - - - - - - - -
[ < ][ > ]   [ << ][ Up ][ >> ]         [Top][Contents][Index][ ? ]
- -

Index

+
+ +
+
+

+Previous:   [Contents][Index]

+
+

Index

-
Jump to:   A +
+
Jump to:   A   -C +C   -D +D   -F +F   -I +I   -M +M   -O +O   -P +P   -R +R   -S +S   -T +T   -U +U   -V +V  
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
Index Entry Section
A
absolute symlink2. Terminology
adopting existing files3. Invoking Stow
C
configuration files11. Resource Files
conflicts5.4 Conflicts during installation
conflicts7. Conflicts
D
deferred operation7.1 Deferred Operation
deferred operation8. Mixing Operations
deletion6. Deleting Packages
directory folding5.1 Tree folding
dry run3. Invoking Stow
F
folding trees5.1 Tree folding
I
ignore lists4. Ignore Lists
ignore lists4.1 Motivation For Ignore Lists
ignoring files and directories4. Ignore Lists
installation5. Installing Packages
installation conflicts5.4 Conflicts during installation
installation image2. Terminology
M
maintenance10. Target Maintenance
mixing operations8. Mixing Operations
O
ownership5.3 Ownership
P
package2. Terminology
package directory2. Terminology
package name2. Terminology
R
refolding trees6.1 Refolding “foldable” trees.
relative symlink2. Terminology
resource files11. Resource Files
S
simulated run3. Invoking Stow
splitting open folded trees5.2 Tree unfolding
stow directory2. Terminology
symlink2. Terminology
T
target directory2. Terminology
tree folding5.1 Tree folding
tree refolding6.1 Refolding “foldable” trees.
tree unfolding5.2 Tree unfolding
tree unsplitting5.2 Tree unfolding
U
unfolding trees5.2 Tree unfolding
V
verbosity levels3. Invoking Stow
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Index EntrySection
A
absolute symlinkTerminology
adopting existing filesInvoking Stow
C
configuration filesResource Files
conflictsInstalling Packages
conflictsConflicts
D
deferred operationConflicts
deferred operationMixing Operations
deletionDeleting Packages
directory foldingInstalling Packages
dotfilesInvoking Stow
dry runInvoking Stow
F
folding treesInstalling Packages
I
ignore listsIgnore Lists
ignore listsMotivation For Ignore Lists
ignoring files and directoriesIgnore Lists
installationInstalling Packages
installation conflictsInstalling Packages
installation imageTerminology
M
maintenanceTarget Maintenance
mixing operationsMixing Operations
O
ownershipInstalling Packages
P
packageTerminology
package directoryTerminology
package nameTerminology
R
refolding treesDeleting Packages
relative symlinkTerminology
resource filesResource Files
S
simulated runInvoking Stow
splitting open folded treesInstalling Packages
stow directoryTerminology
symlinkTerminology
T
target directoryTerminology
tree foldingInstalling Packages
tree refoldingDeleting Packages
tree unfoldingInstalling Packages
tree unsplittingInstalling Packages
U
unfolding treesInstalling Packages
V
verbosity levelsInvoking Stow
-
Jump to:   A +
Jump to:   A   -C +C   -D +D   -F +F   -I +I   -M +M   -O +O   -P +P   -R +R   -S +S   -T +T   -U +U   -V +V  
+ -
- - - - - - -
[Top][Contents][Index][ ? ]
-

Footnotes

-

(1)

-

As of Perl 4.036 and Emacs -19.22. -

(2)

+ + +
+
+

Footnotes

+ +
(1)
+

As of Perl 4.036 and Emacs 19.22. These are now +ancient releases but the example still holds valid.

+
(2)
+

http://brandon.invergo.net/news/2012-05-26-using-gnu-stow-to-manage-your-dotfiles.html

+
(3)
+

http://lists.gnu.org/archive/html/info-stow/2011-12/msg00000.html

+
(4)

Exact matching means the regular expression is anchored at the beginning and end, in contrast -to unanchored regular expressions which will match a substring. -

(3)

+to unanchored regular expressions which will match a substring.

+
(5)

In this context, “subpath” means a contiguous subset of path segments; e.g for the relative path -‘one/two/three’, there are six valid subpaths: ‘one’, -‘two’, ‘three’, ‘one/two’, ‘two/three’, -‘one/two/three’. -

(4)

+one/two/three, there are six valid subpaths: one, +two, three, one/two, two/three, +one/two/three.

+
(6)

The “basename” is the name of the file or directory itself, excluding any directory path prefix - as returned by -the basename command. -

(5)

+the basename command.

+
(7)

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 ‘-p’ option. Alternatively, you can -use the ‘--badlinks’ option get stow to search for dangling links in your target tree and remove the offenders manually. -

(6)

-

As I write this, the current version of Emacs is 19.31. -

- - - - - - -
[Top][Contents][Index][ ? ]
-

Table of Contents

-
- - +you can enable the old approach with the -p option. Alternatively, you can +use the --badlinks option get stow to search for dangling links in your target tree and remove the offenders manually.

+
(8)
+

As I write this, the current version of Emacs is 19.31.

-
- - - - - - -
[Top][Contents][Index][ ? ]
-

About This Document

-

- This document was generated by Adam Spiers on November 9, 2015 using texi2html 1.82. -

-

- The buttons in the navigation panels have the following meaning: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Button Name Go to From 1.2.3 go to
[ < ] BackPrevious section in reading order1.2.2
[ > ] ForwardNext section in reading order1.2.4
[ << ] FastBackBeginning of this chapter or previous chapter1
[ Up ] UpUp section1.2
[ >> ] FastForwardNext chapter2
[Top] TopCover (top) of document  
[Contents] ContentsTable of contents  
[Index] IndexIndex  
[ ? ] AboutAbout (help)  
-

- where the Example assumes that the current position is at Subsubsection One-Two-Three of a document of the following structure: -

-
    -
  • 1. Section One -
      -
    • 1.1 Subsection One-One -
        -
      • ...
        • -
      -
      • -
    • 1.2 Subsection One-Two -
        -
      • 1.2.1 Subsubsection One-Two-One
        • -
      • 1.2.2 Subsubsection One-Two-Two
        • -
      • 1.2.3 Subsubsection One-Two-Three     - <== Current Position
        • -
      • 1.2.4 Subsubsection One-Two-Four
        • -
      -
      • -
    • 1.3 Subsection One-Three -
        -
      • ...
        • -
      -
      • -
    • 1.4 Subsection One-Four
      • -
    -
    • -
-
-

- - This document was generated by Adam Spiers on November 9, 2015 using texi2html 1.82. - -
- -

diff --git a/local/share/doc/stow/manual-split/Bootstrapping.html b/local/share/doc/stow/manual-split/Bootstrapping.html index 40ee46e..a1cc379 100644 --- a/local/share/doc/stow/manual-split/Bootstrapping.html +++ b/local/share/doc/stow/manual-split/Bootstrapping.html @@ -1,89 +1,104 @@ - + + + -Bootstrapping - Stow - - - - - - - - +Bootstrapping (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- -

-Next: , -Previous: Compile-time vs Install-time, -Up: Top -

-
-

13 Bootstrapping

+ +
+
+

+Next: , Previous:   [Contents][Index]

+
+
+

13 Bootstrapping

Suppose you have a stow directory all set up and ready to go: -/usr/local/stow/perl contains the Perl installation, -/usr/local/stow/stow contains Stow itself, and perhaps you have -other packages waiting to be stowed. You'd like to be able to do this: +/usr/local/stow/perl contains the Perl installation, +/usr/local/stow/stow contains Stow itself, and perhaps you have +other packages waiting to be stowed. You’d like to be able to do this: +

+
+
cd /usr/local/stow
+stow -vv *
+
-
     cd /usr/local/stow
-     stow -vv *
-
-

but stow is not yet in your PATH. Nor can you do this: +

but stow is not yet in your PATH. Nor can you do this: +

+
+
cd /usr/local/stow
+stow/bin/stow -vv *
+
-
     cd /usr/local/stow
-     stow/bin/stow -vv *
-
-

because the ‘#!’ line at the beginning of stow tries to -locate Perl (usually in /usr/local/bin/perl), and that won't be +

because the ‘#!’ line at the beginning of stow tries to +locate Perl (usually in /usr/local/bin/perl), and that won’t be found. The solution you must use is: +

+
+
cd /usr/local/stow
+perl/bin/perl stow/bin/stow -vv *
+
-
     cd /usr/local/stow
-     perl/bin/perl stow/bin/stow -vv *
-
- - +
+ + + + diff --git a/local/share/doc/stow/manual-split/Compile_002dtime-vs-Install_002dtime.html b/local/share/doc/stow/manual-split/Compile_002dtime-vs-Install_002dtime.html index cb7776e..21a983b 100644 --- a/local/share/doc/stow/manual-split/Compile_002dtime-vs-Install_002dtime.html +++ b/local/share/doc/stow/manual-split/Compile_002dtime-vs-Install_002dtime.html @@ -1,144 +1,162 @@ - + + + -Compile-time vs Install-time - Stow - - - - - - - - +Compile-time vs Install-time (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- - -

-Next: , -Previous: Resource Files, -Up: Top -

-
-

12 Compile-time vs Install-time

+ +
+
+

+Next: , Previous:   [Contents][Index]

+
+
+

12 Compile-time vs Install-time

Software whose installation is managed with Stow needs to be installed -in one place (the package directory, e.g. /usr/local/stow/perl) +in one place (the package directory, e.g. /usr/local/stow/perl) but needs to appear to run in another place (the target tree, e.g., -/usr/local). Why is this important? What's wrong with Perl, for -instance, looking for its files in /usr/local/stow/perl instead -of in /usr/local? - -

The answer is that there may be another package, e.g., -/usr/local/stow/perl-extras, stowed under /usr/local. If -Perl is configured to find its files in /usr/local/stow/perl, it -will never find the extra files in the ‘perl-extras’ package, even -though they're intended to be found by Perl. On the other hand, if Perl -looks for its files in /usr/local, then it will find the -intermingled Perl and ‘perl-extras’ files. - -

This means that when you compile a package, you must tell it the +/usr/local). Why is this important? What’s wrong with Perl, for +instance, looking for its files in /usr/local/stow/perl instead +of in /usr/local? +

+

The answer is that there may be another package, e.g., +/usr/local/stow/perl-extras, stowed under /usr/local. If +Perl is configured to find its files in /usr/local/stow/perl, it +will never find the extra files in the ‘perl-extras’ package, even +though they’re intended to be found by Perl. On the other hand, if Perl +looks for its files in /usr/local, then it will find the +intermingled Perl and ‘perl-extras’ files. +

+

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

12.1 Advice on changing compilation and installation parameters

- +

+ +
+

12.1 Advice on changing compilation and installation parameters

Some software packages allow you to specify, at compile-time, separate locations for installation and for run-time. Perl is one such package; -see Perl and Perl 5 Modules. Others allow you to compile the -package, then give a different destination in the ‘make install’ +see Perl and Perl 5 Modules. Others allow you to compile the +package, then give a different destination in the ‘make install’ step without causing the binaries or other files to get rebuilt. Most -GNU software falls into this category; Emacs is a notable exception. -See GNU Emacs, and Other FSF Software. - -

Still other software packages cannot abide the idea of separate -installation and run-time locations at all. If you try to ‘make -install prefix=/usr/local/stow/foo’, then first the whole package -will be recompiled to hardwire the /usr/local/stow/foo +GNU software falls into this category; Emacs is a notable exception. +See GNU Emacs, and Other FSF Software. +

+

Still other software packages cannot abide the idea of separate +installation and run-time locations at all. If you try to ‘make +install prefix=/usr/local/stow/foo’, then first the whole package +will be recompiled to hardwire the /usr/local/stow/foo path. With these packages, it is best to compile normally, then run -‘make -n install’, which should report all the steps needed to +‘make -n install’, 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 ‘make install’. Be sure to execute the -script using the same shell that ‘make install’ would have used. +shell script in place of ‘make install’. Be sure to execute the +script using the same shell that ‘make install’ would have used. +

+

(If you use GNU Make and a shell [such as GNU bash] that understands +pushd and popd, you can do the following: +

+
    +
  1. Replace all lines matching ‘make[n]: Entering directory +dir’ with ‘pushd dir’. +
  2. Replace all lines matching ‘make[n]: Leaving directory +dir’ with ‘popd’. +
  3. Delete all lines matching ‘make[n]: Nothing to be done for +rule’. +
-

(If you use GNU Make and a shell [such as GNU bash] that understands -pushd and popd, you can do the following: - -

    -
  1. Replace all lines matching ‘make[n]: Entering directory -dir’ with ‘pushd dir’. -
  2. Replace all lines matching ‘make[n]: Leaving directory -dir’ with ‘popd’. -
  3. Delete all lines matching ‘make[n]: Nothing to be done for -rule’. -
- -

Then find other lines in the output containing cd or make +

Then find other lines in the output containing cd or make commands and rewrite or delete them. In particular, you should be able to delete sections of the script that resemble this: +

+
+
for i in dir_1 dir_2 ...; do \
+  (cd $i; make args ...) \
+done
+
-
     for i in dir_1 dir_2 ...; do \
-       (cd $i; make args ...) \
-     done
-
-

Note, that's “should be able to,” not “can.” Be sure to modulate +

Note, that’s “should be able to,” not “can.” Be sure to modulate these guidelines with plenty of your own intelligence. - -

The details of stowing some specific packages are described in the +

+

The details of stowing some specific packages are described in the following sections. +

- +
+
+
+
+

+Next: Bootstrapping, Previous: Resource Files   [Contents][Index]

+
- - + + + diff --git a/local/share/doc/stow/manual-split/Conflicts.html b/local/share/doc/stow/manual-split/Conflicts.html index 6c58620..deeee1f 100644 --- a/local/share/doc/stow/manual-split/Conflicts.html +++ b/local/share/doc/stow/manual-split/Conflicts.html @@ -1,100 +1,117 @@ - + + + -Conflicts - Stow - - - - - - - - +Conflicts (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- + + +
+

-Next: , -Previous: Deleting Packages, -Up: Top -

+Next: , Previous:   [Contents][Index]

+
+

7 Conflicts

-

7 Conflicts

- -

If, during installation, a file or symlink exists in the target tree and + +

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 -conflict has arisen. A conflict also occurs if a directory exists +conflict 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.) - -

For complex packages, scanning the stow and target trees in tandem, +

+

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

+ +
+

7.1 Deferred Operation

+ -

- -

7.1 Deferred Operation

- -

-Since version 2.0, Stow now adopts a two-phase algorithm, first +

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

Prior to version 2.0, if a conflict was discovered, the stow or unstow +

+

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

+
+
+
+
+

+Next: Mixing Operations, Previous: Deleting Packages   [Contents][Index]

+
- - + + + diff --git a/local/share/doc/stow/manual-split/Cygnus-Software.html b/local/share/doc/stow/manual-split/Cygnus-Software.html index a98b83d..9488c0c 100644 --- a/local/share/doc/stow/manual-split/Cygnus-Software.html +++ b/local/share/doc/stow/manual-split/Cygnus-Software.html @@ -1,95 +1,103 @@ - + + + -Cygnus Software - Stow - - - - - - - - - +Cygnus Software (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- -

-Next: , -Previous: Other FSF Software, -Up: Compile-time vs Install-time -

-
-

12.4 Cygnus Software

+ +
+
+

+Next: , Previous: , Up: Compile-time vs Install-time   [Contents][Index]

+
+
+

12.4 Cygnus Software

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 ‘gdb’, -‘gnats’, and ‘dejagnu’. - -

Cygnus packages have the peculiarity that each one unpacks into a +other packages. Among the packages released by Cygnus are ‘gdb’, +‘gnats’, and ‘dejagnu’. +

+

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 all of Cygnus' packages, any number of which may reside -under the top-level directory. In other words, even if you're only -building ‘gnats’, the top-level Makefile will look for, and try to -build, gdb and dejagnu subdirectories, among many others. - -

The result is that if you try ‘make -n install -prefix=/usr/local/stow/package’ at the top level of a Cygnus -package, you'll get a bewildering amount of output. It will then be +compile all of Cygnus’ packages, any number of which may reside +under the top-level directory. In other words, even if you’re only +building ‘gnats’, the top-level Makefile will look for, and try to +build, gdb and dejagnu subdirectories, among many others. +

+

The result is that if you try ‘make -n install +prefix=/usr/local/stow/package’ 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 +will proceed correctly. Unfortunately, it’s not always clear how to invoke an install from the subdirectory of interest. - -

In cases like this, the best approach is to run your ‘make install -prefix=...’, but be ready to interrupt it if you detect that it +

+

In cases like this, the best approach is to run your ‘make install +prefix=…’, but be ready to interrupt it if you detect that it is recompiling files. Usually it will work just fine; otherwise, install manually. +

+
- - + + + diff --git a/local/share/doc/stow/manual-split/Deferred-Operation.html b/local/share/doc/stow/manual-split/Deferred-Operation.html index ff438aa..260bee1 100644 --- a/local/share/doc/stow/manual-split/Deferred-Operation.html +++ b/local/share/doc/stow/manual-split/Deferred-Operation.html @@ -1 +1,55 @@ - + + + + + + + +Deferred Operation (Stow) + + + + + + + + + + + + + + +

The node you are looking for is at Deferred Operation.

+ diff --git a/local/share/doc/stow/manual-split/Deleting-Packages.html b/local/share/doc/stow/manual-split/Deleting-Packages.html index 0257f0e..17d71d2 100644 --- a/local/share/doc/stow/manual-split/Deleting-Packages.html +++ b/local/share/doc/stow/manual-split/Deleting-Packages.html @@ -1,112 +1,126 @@ - + + + -Deleting Packages - Stow - - - - - - - - +Deleting Packages (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- + + +
+

-Next: , -Previous: Installing Packages, -Up: Top -

+Next: , Previous:   [Contents][Index]

+
+

6 Deleting Packages

-

6 Deleting Packages

- -

When the -D option is given, the action of Stow is to + +

When the -D 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 not +delete anything it doesn’t “own”. Deleting a package does not mean removing it from the stow directory or discarding the package tree. - -

To delete a package, Stow recursively scans the target tree, skipping over any -directory that is not included in the installation image.1 -For example, if the target directory is /usr/local and the -installation image for the package being deleted has only a bin -directory and a man directory at the top level, then we only scan -/usr/local/bin and /usr/local/bin/man, and not -/usr/local/lib or /usr/local/share, or for that matter -/usr/local/stow. Any symlink it finds that points into the package +

+

To delete a package, Stow recursively scans the target tree, skipping over any +directory that is not included in the installation image.7 +For example, if the target directory is /usr/local and the +installation image for the package being deleted has only a bin +directory and a man directory at the top level, then we only scan +/usr/local/bin and /usr/local/man, and not +/usr/local/lib or /usr/local/share, or for that matter +/usr/local/stow. 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. +

+ +
+

6.1 Refolding “foldable” trees.

+ + -

- -

6.1 Refolding “foldable” trees.

- -

-After removing symlinks and empty subdirectories, any directory that +

After removing symlinks and empty subdirectories, any directory that contains only symlinks to a single other package is considered to be a previously “folded” tree that was “split open.” 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 ---no-folding option; see Invoking Stow. - - -

+--no-folding option; see Invoking Stow. +

+
+
+
-

Footnotes

[1] This +

Footnotes

+ +
(7)
+

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 -p option. Alternatively, you can -use the --badlinks option get stow to search for dangling links in your target tree and remove the offenders manually.

+you can enable the old approach with the -p option. Alternatively, you can +use the --badlinks option get stow to search for dangling links in your target tree and remove the offenders manually.

+
-
- + + diff --git a/local/share/doc/stow/manual-split/GNU-Emacs.html b/local/share/doc/stow/manual-split/GNU-Emacs.html index 3f44cce..195a0ec 100644 --- a/local/share/doc/stow/manual-split/GNU-Emacs.html +++ b/local/share/doc/stow/manual-split/GNU-Emacs.html @@ -1,97 +1,112 @@ - + + + -GNU Emacs - Stow - - - - - - - - - +GNU Emacs (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- -

-Next: , -Previous: Compile-time vs Install-time, -Up: Compile-time vs Install-time -

-
-

12.2 GNU Emacs

+ +
+
+

+Next: , Previous: , Up: Compile-time vs Install-time   [Contents][Index]

+
+
+

12.2 GNU Emacs

Although the Free Software Foundation has many enlightened practices -regarding Makefiles and software installation (see see Other FSF Software), Emacs, its flagship program, doesn't quite follow the +regarding Makefiles and software installation (see see Other FSF Software), Emacs, its flagship program, doesn’t quite follow the rules. In particular, most GNU software allows you to write: +

+
+
make
+make install prefix=/usr/local/stow/package
+
-
     make
-     make install prefix=/usr/local/stow/package
-
-

If you try this with Emacs, then the new value for prefix in the -‘make install’ step will cause some files to get recompiled with -the new value of prefix wired into them. In Emacs 19.23 and -later,1 +

If you try this with Emacs, then the new value for prefix in the +‘make install’ step will cause some files to get recompiled with +the new value of prefix wired into them. In Emacs 19.23 and +later,8 the way to work around this problem is: +

+
+
make
+make install-arch-dep install-arch-indep prefix=/usr/local/stow/emacs
+
-
     make
-     make install-arch-dep install-arch-indep prefix=/usr/local/stow/emacs
-
-

In 19.22 and some prior versions of Emacs, the workaround was: +

In 19.22 and some prior versions of Emacs, the workaround was: +

+
+
make
+make do-install prefix=/usr/local/stow/emacs
+
-
     make
-     make do-install prefix=/usr/local/stow/emacs
-
- -
+
+
-

Footnotes

[1] As I write this, the current version of Emacs is 19.31.

+

Footnotes

-
+
(8)
+

As I write this, the current version of Emacs is 19.31.

+
- + + + diff --git a/local/share/doc/stow/manual-split/GNU-General-Public-License.html b/local/share/doc/stow/manual-split/GNU-General-Public-License.html index 32b3c18..6f3ee1f 100644 --- a/local/share/doc/stow/manual-split/GNU-General-Public-License.html +++ b/local/share/doc/stow/manual-split/GNU-General-Public-License.html @@ -1,411 +1,786 @@ - + + + -GNU General Public License - Stow - - - - - - - - +GNU General Public License (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- + + +
+

-Next: , -Previous: Known Bugs, -Up: Top +Next: , Previous:   [Contents][Index]

+
+

GNU General Public License

+ +
Version 3, 29 June 2007
-

GNU General Public License

+
+
Copyright © 2007 Free Software Foundation, Inc. https://fsf.org/
 
-
Version 2, June 1991

+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
-
     Copyright © 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.
-
-

Preamble

+

Preamble

-

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

When we speak of free software, we are referring to freedom, not +

The GNU General Public License is a free, copyleft license for +software and other kinds of works. +

+

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—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. +

+

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

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

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

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

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

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

The precise terms and conditions for copying, distribution and +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. +

+

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

+

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

+

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

+

For the developers’ and authors’ protection, the GPL clearly explains +that there is no warranty for this free software. For both users’ and +authors’ 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. +

+

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’ 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. +

+

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

+

The precise terms and conditions for copying, distribution and modification follow. +

+

TERMS AND CONDITIONS

-
    -
  1. 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 “Program”, below, -refers to any such program or work, and a “work based on the Program” -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 “modification”.) Each licensee is addressed as “you”. +
      +
    1. Definitions. -

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

      “This License” refers to version 3 of the GNU General Public License. +

      +

      “Copyright” also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. +

      +

      “The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations. +

      +

      To “modify” 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 “modified version” of +the earlier work or a work “based on” the earlier work. +

      +

      A “covered work” means either the unmodified Program or a work based +on the Program. +

      +

      To “propagate” 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. +

      +

      To “convey” 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. +

      +

      An interactive user interface displays “Appropriate Legal Notices” 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. +

      +
    2. Source Code. -
    3. 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. +

      The “source code” for a work means the preferred form of the work for +making modifications to it. “Object code” means any non-source form +of a work. +

      +

      A “Standard Interface” 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. +

      +

      The “System Libraries” 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 +“Major Component”, 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. +

      +

      The “Corresponding Source” 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’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. +

      +

      The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. +

      +

      The Corresponding Source for a work in source code form is that same +work. +

      +
    4. Basic Permissions. -

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

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

      +

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

      +

      Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. +

      +
    5. Protecting Users’ Legal Rights From Anti-Circumvention Law. -
    6. 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: +

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

      +

      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’s users, your or third parties’ legal rights to forbid +circumvention of technological measures. +

      +
    7. Conveying Verbatim Copies. -
        -
      1. You must cause the modified files to carry prominent notices -stating that you changed the files and the date of any change. +

        You may convey 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; +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. +

        +

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

        +
      2. Conveying Modified Source Versions. -
      3. 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. +

        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: +

        +
          +
        1. The work must carry prominent notices stating that you modified it, +and giving a relevant date. -
        2. 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.) -
        +
      4. 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 “keep intact all +notices”. -

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

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

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

      6. 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. +
      -

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

      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 +“aggregate” if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation’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. +

      +
    8. Conveying Non-Source Forms. -
    9. 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: +

      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: +

      +
        +
      1. 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. -
          -
        1. 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, +
        2. 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. -
        3. 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, +
        4. 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. -
        5. 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.) -
        +
      2. 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. -

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

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

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

      -
    10. 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. +

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

      +

      A “User Product” is either (1) a “consumer product”, 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, +“normally used” 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. +

      +

      “Installation Information” 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. +

      +

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

      +

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

      +

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

      +
    11. Additional Terms. -
    12. 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. +

      “Additional permissions” 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. +

      +

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

      +

      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: +

      +
        +
      1. Disclaiming warranty or limiting liability differently from the terms +of sections 15 and 16 of this License; or -
      2. 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 +
      3. 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 + +
      4. 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 + +
      5. Limiting the use for publicity purposes of names of licensors or +authors of the material; or + +
      6. Declining to grant rights under trademark law for use of some trade +names, trademarks, or service marks; or + +
      7. 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. +
      + +

      All other non-permissive additional terms are considered “further +restrictions” 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. +

      +

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

      +

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

      +
    13. Termination. + +

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

      +

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

      +

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

      +

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

      +
    14. Acceptance Not Required for Having Copies. + +

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

      +
    15. Automatic Licensing of Downstream Recipients. + +

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

      +

      An “entity transaction” 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’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. +

      +

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

      +
    16. Patents. + +

      A “contributor” 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’s “contributor version”. +

      +

      A contributor’s “essential patent claims” 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, “control” includes the right to grant +patent sublicenses in a manner consistent with the requirements of this License. +

      +

      Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor’s essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. +

      +

      In the following three paragraphs, a “patent license” 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 “grant” such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. +

      +

      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. “Knowingly relying” means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient’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. +

      +

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

      +

      A patent license is “discriminatory” 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. +

      +

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

      +
    17. No Surrender of Others’ Freedom. -
    18. 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 +

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

      +
    19. Use with the GNU Affero General Public License. -

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

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

      +
    20. Revised Versions of this License. -

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

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

      +

      Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License “or any later version” 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. +

      +

      If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy’s public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. +

      +

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

      +
    21. Disclaimer of Warranty. -

      This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. +

      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 “AS IS” 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. +

      +
    22. Limitation of Liability. -
    23. 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. +

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

      +
    24. Interpretation of Sections 15 and 16. -
    25. 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. +

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

      +
    -

    Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and “any -later version”, 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. +

    END OF TERMS AND CONDITIONS

    -
  2. 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. - -
  3. 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 “AS IS” 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. - -
  4. 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. -
- -

How to Apply These Terms to Your New Programs

+

How to Apply These Terms to Your New Programs

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

To do so, attach the following notices to the program. It is safest +free software which everyone can redistribute and change under these +terms. +

+

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 +state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found. +

+
+
one line to give the program's name and a brief idea of what it does.
+Copyright (C) year name of author
 
-
     one line to give the program's name and an idea of what it does.
-     Copyright (C) 19yy  name of author
-     
-     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.
-

-   
Also add information on how to contact you by electronic and paper mail.
+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.
 
-   
If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
+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.
 
-
     Gnomovision version 69, Copyright (C) 19yy name of author
-     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.
-

-   
The hypothetical commands ‘show w’ and ‘show c’ should show
-the appropriate parts of the General Public License.  Of course, the
-commands you use may be called something other than ‘show w’ and
-‘show c’; they could even be mouse-clicks or menu items—whatever
-suits your program.
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see https://www.gnu.org/licenses/.
+
-

You should also get your employer (if you work as a programmer) or your -school, if any, to sign a “copyright disclaimer” for the program, if -necessary. Here is a sample; alter the names: +

Also add information on how to contact you by electronic and paper mail. +

+

If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: +

+
+
program Copyright (C) year name of author
+This program 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.
+
-
     Yoyodyne, Inc., hereby disclaims all copyright
-     interest in the program `Gnomovision'
-     (which makes passes at compilers) written
-     by James Hacker.
-     
-     signature of Ty Coon, 1 April 1989
-     Ty Coon, President of Vice
-
-

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

The hypothetical commands ‘show w’ and ‘show c’ should show +the appropriate parts of the General Public License. Of course, your +program’s commands might be different; for a GUI interface, you would +use an “about box”. +

+

You should also get your employer (if you work as a programmer) or school, +if any, to sign a “copyright disclaimer” for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +https://www.gnu.org/licenses/. +

+

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 https://www.gnu.org/licenses/why-not-lgpl.html. +

+
+
+
+

+Next: Index, Previous: Known Bugs   [Contents][Index]

+
- + + + diff --git a/local/share/doc/stow/manual-split/Ignore-Lists.html b/local/share/doc/stow/manual-split/Ignore-Lists.html index 219962e..f2e123b 100644 --- a/local/share/doc/stow/manual-split/Ignore-Lists.html +++ b/local/share/doc/stow/manual-split/Ignore-Lists.html @@ -1,77 +1,86 @@ - + + + -Ignore Lists - Stow - - - - - - - - +Ignore Lists (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- + + + -

4 Ignore Lists

-

- -

- - - + + diff --git a/local/share/doc/stow/manual-split/Installing-Packages.html b/local/share/doc/stow/manual-split/Installing-Packages.html index a0abce2..6ab3683 100644 --- a/local/share/doc/stow/manual-split/Installing-Packages.html +++ b/local/share/doc/stow/manual-split/Installing-Packages.html @@ -1,156 +1,187 @@ - + + + -Installing Packages - Stow - - - - - - - - +Installing Packages (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- + + +
+

-Next: , -Previous: Ignore Lists, -Up: Top -

+Next: , Previous:   [Contents][Index]

+
+

5 Installing Packages

-

5 Installing Packages

- -

The default action of Stow is to install a package. This means creating + +

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

- -

5.1 Tree folding

- -

For example, suppose that no packages have yet been installed in -/usr/local; it's completely empty (except for the stow -subdirectory, of course). Now suppose the Perl package is installed. +

+ +
+

5.1 Tree folding

+ + + +

For example, suppose that no packages have yet been installed in +/usr/local; it’s completely empty (except for the stow +subdirectory, of course). Now suppose the Perl package is installed. Recall that it includes the following directories in its installation -image: bin; info; lib/perl; man/man1. -Rather than creating the directory /usr/local/bin and populating -it with symlinks to ../stow/perl/bin/perl and -../stow/perl/bin/a2p (and so on), Stow will create a -single symlink, /usr/local/bin, which points to -stow/perl/bin. In this way, it still works to refer to -/usr/local/bin/perl and /usr/local/bin/a2p, and fewer -symlinks have been created. This is called tree folding, since an +image: bin; info; lib/perl; man/man1. +Rather than creating the directory /usr/local/bin and populating +it with symlinks to ../stow/perl/bin/perl and +../stow/perl/bin/a2p (and so on), Stow will create a +single symlink, /usr/local/bin, which points to +stow/perl/bin. In this way, it still works to refer to +/usr/local/bin/perl and /usr/local/bin/a2p, and fewer +symlinks have been created. This is called tree folding, since an entire subtree is “folded” into a single symlink. - -

To complete this example, Stow will also create the symlink -/usr/local/info pointing to stow/perl/info; the symlink -/usr/local/lib pointing to stow/perl/lib; and the symlink -/usr/local/man pointing to stow/perl/man. - -

Now suppose that instead of installing the Perl package into an empty +

+

To complete this example, Stow will also create the symlink +/usr/local/info pointing to stow/perl/info; the symlink +/usr/local/lib pointing to stow/perl/lib; and the symlink +/usr/local/man pointing to stow/perl/man. +

+

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, /usr/local/bin -already exists and is a directory, as are /usr/local/lib and -/usr/local/man/man1. In this case, Stow will descend into -/usr/local/bin and create symlinks to -../stow/perl/bin/perl and ../stow/perl/bin/a2p (etc.), -and it will descend into /usr/local/lib and create the -tree-folding symlink perl pointing to -../stow/perl/lib/perl, and so on. As a rule, Stow only +system-administration philosophy. In particular, /usr/local/bin +already exists and is a directory, as are /usr/local/lib and +/usr/local/man/man1. In this case, Stow will descend into +/usr/local/bin and create symlinks to +../stow/perl/bin/perl and ../stow/perl/bin/a2p (etc.), +and it will descend into /usr/local/lib and create the +tree-folding symlink perl pointing to +../stow/perl/lib/perl, 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 --no-folding option; see Invoking Stow. - -

- -

5.2 Tree unfolding

- -

The time often comes when a tree-folding symlink has to be undone +the --no-folding option; see Invoking Stow. +

+
+
+

5.2 Tree unfolding

+ + + + +

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 or -unfolding a folded tree. It involves removing the original symlink from +its installation image. This operation is called splitting open or +unfolding 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 and to +new directory with symlinks to the newly-installed package and to the old package that used the old symlink. For example, suppose that -after installing Perl into an empty /usr/local, we wish to -install Emacs. Emacs's installation image includes a bin -directory containing the emacs and etags executables, +after installing Perl into an empty /usr/local, we wish to +install Emacs. Emacs’s installation image includes a bin +directory containing the emacs and etags executables, among others. Stow must make these files appear to be installed -in /usr/local/bin, but presently /usr/local/bin is a -symlink to stow/perl/bin. Stow therefore takes the -following steps: the symlink /usr/local/bin is deleted; the -directory /usr/local/bin is created; links are made from -/usr/local/bin to ../stow/emacs/bin/emacs and -../stow/emacs/bin/etags; and links are made from -/usr/local/bin to ../stow/perl/bin/perl and -../stow/perl/bin/a2p. - -

5.3 Ownership

- -

When splitting open a folded tree, Stow makes sure that the +in /usr/local/bin, but presently /usr/local/bin is a +symlink to stow/perl/bin. Stow therefore takes the +following steps: the symlink /usr/local/bin is deleted; the +directory /usr/local/bin is created; links are made from +/usr/local/bin to ../stow/emacs/bin/emacs and +../stow/emacs/bin/etags; and links are made from +/usr/local/bin to ../stow/perl/bin/perl and +../stow/perl/bin/a2p. +

+
+
+

5.3 Ownership

+ +

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. Stow will never delete anything -that it doesn't own. Stow “owns” everything living in the +current stow directory. Stow will never delete anything +that it doesn’t own. Stow “owns” 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 -“owns”. Note that by this definition, Stow doesn't “own” anything -in the stow directory or in any of the packages. - -

5.4 Conflicts during installation

- -

If Stow needs to create a directory or a symlink in the target +“owns”. Note that by this definition, Stow doesn’t “own” anything +in the stow directory or in any of the packages. +

+
+
+

5.4 Conflicts during installation

+ + +

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 Conflicts. +by Stow, then a conflict has arisen. See Conflicts. +

- - +
+
+
+
+

+Next: Deleting Packages, Previous: Ignore Lists   [Contents][Index]

+
+ + + + diff --git a/local/share/doc/stow/manual-split/Introduction.html b/local/share/doc/stow/manual-split/Introduction.html index 0d971de..b9c02f9 100644 --- a/local/share/doc/stow/manual-split/Introduction.html +++ b/local/share/doc/stow/manual-split/Introduction.html @@ -1,119 +1,170 @@ - + + + -Introduction - Stow - - - - - - - - +Introduction (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- + + +
+

-Next: , -Previous: Top, -Up: Top -

+Next:   [Contents][Index]

+
+

1 Introduction

-

1 Introduction

+

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

+

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. When one does so, one winds up with the following +files1 in +/usr/local/man/man1: +

+
+
a2p.1
+ctags.1
+emacs.1
+etags.1
+h2ph.1
+perl.1
+s2p.1
+
-

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 /usr/local. When one does so, one -winds up with the following files1 in /usr/local/man/man1: - -

     a2p.1
-     ctags.1
-     emacs.1
-     etags.1
-     h2ph.1
-     perl.1
-     s2p.1
-
-

Now suppose it's time to uninstall Perl. Which man pages -get removed? Obviously perl.1 is one of them, but it should not -be the administrator's responsibility to memorize the ownership of +

Now suppose it’s time to uninstall Perl. Which man pages +get removed? Obviously 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. - -

The approach used by Stow is to install each package into its own +

+

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. +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 bin directory -containing executables, a man/man1 directory containing section 1 +tree; i.e. (in the typical case) there should be a bin directory +containing executables, a man/man1 directory containing section 1 man pages, 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 +directory2, +especially when coupled with version control +systems3. +

+

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

+

For information about the latest version of Stow, you can refer to +http://www.gnu.org/software/stow/. +

-

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

For information about the latest version of Stow, you can refer to -http://www.gnu.org/software/stow/. - - -

+
+
-

Footnotes

[1] As of Perl 4.036 and Emacs -19.22.

+

Footnotes

-
+
(1)
+

As of Perl 4.036 and Emacs 19.22. These are now +ancient releases but the example still holds valid.

+
(2)
+

http://brandon.invergo.net/news/2012-05-26-using-gnu-stow-to-manage-your-dotfiles.html

+
(3)
+

http://lists.gnu.org/archive/html/info-stow/2011-12/msg00000.html

+
+
+
+

+Next: Terminology   [Contents][Index]

+
- + + + diff --git a/local/share/doc/stow/manual-split/Invoking-Stow.html b/local/share/doc/stow/manual-split/Invoking-Stow.html index ba12b4d..abdcc19 100644 --- a/local/share/doc/stow/manual-split/Invoking-Stow.html +++ b/local/share/doc/stow/manual-split/Invoking-Stow.html @@ -1,206 +1,290 @@ - + + + -Invoking Stow - Stow - - - - - - - - +Invoking Stow (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- + + +
+

-Next: , -Previous: Terminology, -Up: Top -

+Next: , Previous:   [Contents][Index]

+
+

3 Invoking Stow

-

3 Invoking Stow

+

The syntax of the stow command is: +

+
+
stow [options] [action flag] package ...
+
-

The syntax of the stow command is: - -

     stow [options] [action flag] package ...
-
-

Each package is the name of a package (e.g., ‘perl’) in the stow -directory that we wish to install into (or delete from) the target directory. +

Each package is the name of a package (e.g., ‘perl’) 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 action flag. - -

The following options are supported: - -

-
‘-d dir’
‘--dir=dir’
Set the stow directory to dir. Defaults to the value of the environment -variable STOW_DIR if set, or the current directory otherwise. - -
‘-t dir’
‘--target=dir’
Set the target directory to dir instead of the parent of the stow +may be specified by preceding the package name(s) with an action flag. +

+

The following options are supported: +

+
+
‘-d dir’
+
‘--dir=dir’
+

Set the stow directory to dir. Defaults to the value of the environment +variable STOW_DIR if set, or the current directory otherwise. +

+
+
‘-t dir’
+
‘--target=dir’
+

Set the target directory to dir instead of the parent of the stow directory. Defaults to the parent of the stow directory, so it is typical to -execute stow from the directory /usr/local/stow. +execute stow from the directory /usr/local/stow. +

+
+
‘--ignore=regexp’
+

This (repeatable) option lets you suppress acting on files that match the +given Perl regular expression. For example, using the options +

+
+
--ignore='.*\.orig' --ignore='.*\.dist'
+
-
‘--ignore=regexp’
This (repeatable) option lets you suppress acting on files that match the -given perl regular expression. For example, using the options - - 
          --ignore='*.orig' --ignore='*.dist'
-
-

will cause stow to ignore files ending in .orig or .dist. - -

Note that the regular expression is anchored to the end of the filename, +

will cause stow to ignore files ending in .orig or .dist. +

+

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

Also note that by default Stow automatically ignores a “sensible” -built-in list of files and directories such as CVS, editor -backup files, and so on. See Ignore Lists, for more details. - -

‘--defer=regexp’
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 --override. - -

(N.B. the name --defer was chosen in the sense that the package +

+

Also note that by default Stow automatically ignores a “sensible” +built-in list of files and directories such as CVS, editor +backup files, and so on. See Ignore Lists, for more details. +

+
+
‘--defer=regexp’
+

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 --override. +

+

(N.B. the name --defer 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 Deferred Operation.) +this nomenclature with the wording used in Deferred Operation.) +

+

For example, the following options +

+
+
--defer=man --defer=info
+
-

For example, the following options - - 

          --defer=man --defer=info
-
-

will cause stow to skip over pre-existing man and info pages. - -

Equivalently, you could use ‘--defer='man|info'’ since the -argument is just a Perl regex. - -

Note that the regular expression is anchored to the beginning of the path +

will cause stow to skip over pre-existing man and info pages. +

+

Equivalently, you could use ‘--defer='man|info'’ since the +argument is just a Perl regular expression. +

+

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

‘--override=regexp’
This (repeatable) option forces any file matching the regular expression to be +

+
+
‘--override=regexp’
+

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 +

+
+
--override=man --override=info
+
- 
          --override=man --override=info
-
-

will permit stow to overwrite links that point to pre-existing man and info +

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

The regular expression is anchored to the beginning of the path relative to +

+

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

‘--no-folding’
-This disables any further tree folding or tree refolding. -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. - -


‘--adopt’
Warning! This behaviour is specifically intended to alter the +

+
+
‘--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, +stow/dot-bashrc and stow/dot-emacs.d/init.el. With this +option, Stow will create symlinks from .bashrc to +stow/dot-bashrc and from .emacs.d/init.el to +stow/dot-emacs.d/init.el. Any other files, whose name does not +begin with ‘dot-’, will be processed as usual. +

+
+
‘--no-folding’
+
+

This disables any further tree folding (see tree folding) or +refolding (see tree refolding). 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. +

+
+
‘--adopt’
+

Warning! 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. - -

When stowing, if a target is encountered which already exists but is a +

+

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

This is particularly useful when the stow package is under the control +

+

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 ‘git diff ...’ -inside the stow package, and finally either kept (e.g. via ‘git -commit ...’) or discarded (‘git checkout HEAD ...’). - -


‘-n’
‘--no’
‘--simulate’
Do not perform any operations that modify the file system; in combination with --v can be used to merely show what would happen. - -


‘-v’
‘--verbose[=n]’
Send verbose output to standard error describing what Stow is -doing. Verbosity levels are 0, 1, 2, and 3; 0 is the default. Using --v or --verbose increases the verbosity by one; using -‘--verbose=n’ sets it to n. - -
‘-p’
‘--compat’
Scan the whole target tree when unstowing. By default, only -directories specified in the installation image are scanned +in the stow package’s installation image, to be adopted into the +package, then compared by running something like ‘git diff ...’ +inside the stow package, and finally either kept (e.g. via ‘git +commit ...’) or discarded (‘git checkout HEAD ...’). +

+
+
+‘-n’
+
‘--no’
+
‘--simulate’
+

Do not perform any operations that modify the file system; in combination with +-v can be used to merely show what would happen. +

+
+
‘-v’
+
‘--verbose[=n]’
+

Send verbose output to standard error describing what Stow is +doing. Verbosity levels are from 0 to 5; 0 is the default. Using +-v or --verbose increases the verbosity by one; using +‘--verbose=n’ sets it to n. +

+
+
‘-p’
+
‘--compat’
+

Scan the whole target tree when unstowing. By default, only +directories specified in the installation image 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 --badlinks option to the -chkstow utility may be a better way of ensuring that your -installation does not have any dangling symlinks (see Target Maintenance). - -

‘-V’
‘--version’
Show Stow version number, and exit. - -
‘-h’
‘--help’
Show Stow command syntax, and exit. +the legacy behaviour; however, the --badlinks option to the +chkstow utility may be a better way of ensuring that your +installation does not have any dangling symlinks (see Target Maintenance). +

+
+
‘-V’
+
‘--version’
+

Show Stow version number, and exit. +

+
+
‘-h’
+
‘--help’
+

Show Stow command syntax, and exit. +

-

The following action flags are supported: - -

-
‘-D’
‘--delete’
Delete (unstow) the package name(s) that follow this option from the target -directory. This option may be repeated any number of times. - -
‘-R’
‘--restow’
Restow (first unstow, then stow again) the package names that follow this +

The following action flags are supported: +

+
+
‘-D’
+
‘--delete’
+

Delete (unstow) the package name(s) that follow this option from the target +directory. This option may be repeated any number of times. +

+
+
‘-R’
+
‘--restow’
+

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

‘-S’
‘--stow’
explictly stow the package name(s) that follow this option. May be -omitted if you are not using the -D or -R options in the -same invocation. See Mixing Operations, for details of when you +

+
+
‘-S’
+
‘--stow’
+

explictly stow the package name(s) that follow this option. May be +omitted if you are not using the -D or -R options in the +same invocation. See Mixing Operations, for details of when you might like to use this feature. This option may be repeated any number -of times. +of times. +

- - +
+
+
+

+Next: Ignore Lists, Previous: Terminology   [Contents][Index]

+
+ + + + + diff --git a/local/share/doc/stow/manual-split/Justification-For-Yet-Another-Set-Of-Ignore-Files.html b/local/share/doc/stow/manual-split/Justification-For-Yet-Another-Set-Of-Ignore-Files.html index c6cc9c3..b77c82b 100644 --- a/local/share/doc/stow/manual-split/Justification-For-Yet-Another-Set-Of-Ignore-Files.html +++ b/local/share/doc/stow/manual-split/Justification-For-Yet-Another-Set-Of-Ignore-Files.html @@ -1,93 +1,101 @@ - + + + -Justification For Yet Another Set Of Ignore Files - Stow - - - - - - - - +Justification For Yet Another Set Of Ignore Files (Stow) + + + + + + + + + + + + + + - 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. - --> - - - -
- -

-Previous: Types And Syntax Of Ignore Lists, -Up: Ignore Lists -

-
-

4.3 Justification For Yet Another Set Of Ignore Files

+ +
+
+

+Previous: , Up: Ignore Lists   [Contents][Index]

+
+
+

4.3 Justification For Yet Another Set Of Ignore Files

The reader may note that this format is very similar to existing -ignore list file formats, such as those for cvs, git, -rsync etc., and wonder if another set of ignore lists is +ignore list file formats, such as those for cvs, git, +rsync 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, .cvsignore, and use that if it +check for the presence of say, .cvsignore, 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. - -

Secondly even if it did, version control system ignore lists generally -reflect build-time ignores rather than install-time, and +it didn’t already exist. +

+

Secondly even if it did, version control system ignore lists generally +reflect build-time ignores rather than install-time, 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 not in the version control -system's ignore list, there is no way of knowing whether the file is +stowed. Similarly, if a file is not 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. - -

Therefore it seems clear that ignore lists provided by version control +

+

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

+
- - + + + diff --git a/local/share/doc/stow/manual-split/Known-Bugs.html b/local/share/doc/stow/manual-split/Known-Bugs.html index bef4833..7003823 100644 --- a/local/share/doc/stow/manual-split/Known-Bugs.html +++ b/local/share/doc/stow/manual-split/Known-Bugs.html @@ -1,76 +1,81 @@ - + + + -Known Bugs - Stow - - - - - - - - +Known Bugs (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- + + +
+

-Next: , -Previous: Reporting Bugs, -Up: Top +Next: , Previous:   [Contents][Index]

+
+

15 Known Bugs

+ +

There are no known bugs in Stow version 2.3.2-fixbug56727! +If you think you have found one, please see Reporting Bugs. +

+
-

15 Known Bugs

-

There are no known bugs in Stow version 2.2.2! -If you think you have found one, please see Reporting Bugs. - - - - - - - + + diff --git a/local/share/doc/stow/manual-split/Mixing-Operations.html b/local/share/doc/stow/manual-split/Mixing-Operations.html index 1267fc1..65aed1f 100644 --- a/local/share/doc/stow/manual-split/Mixing-Operations.html +++ b/local/share/doc/stow/manual-split/Mixing-Operations.html @@ -1,90 +1,104 @@ - + + + -Mixing Operations - Stow - - - - - - - - +Mixing Operations (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -

- + + +
+

-Next: , -Previous: Conflicts, -Up: Top -

+Next: , Previous:   [Contents][Index]

+
+

8 Mixing Operations

+ -

8 Mixing Operations

- -

-Since version 2.0, multiple distinct actions can be specified in a single +

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: +

+
+
stow -D emacs-21.3 -S emacs-21.4a
+
-
     stow -D emacs-21.3 -S emacs-21.4a
-
-

which will replace emacs-21.3 with emacs-21.4a using a single invocation. - -

This is much faster and cleaner than performing two separate +

which will replace emacs-21.3 with emacs-21.4a using a single invocation. +

+ +

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 Deferred Operation), so the +and merged before being executed (see Deferred Operation), so the amount of of time in which GNU Emacs is unavailable is minimised. +

+

You can mix and match any number of actions, for example, +

+
+
stow -S pkg1 pkg2 -D pkg3 pkg4 -S pkg5 -R pkg6
+
-

You can mix and match any number of actions, for example, +

will unstow pkg3, pkg4 and pkg6, then stow pkg1, pkg2, pkg5 and pkg6. +

+
-
     stow -S pkg1 pkg2 -D pkg3 pkg4 -S pkg5 -R pkg6
-
-

will unstow pkg3, pkg4 and pkg6, then stow pkg1, pkg2, pkg5 and pkg6. - - + + diff --git a/local/share/doc/stow/manual-split/Motivation-For-Ignore-Lists.html b/local/share/doc/stow/manual-split/Motivation-For-Ignore-Lists.html index 37461e4..679c7fb 100644 --- a/local/share/doc/stow/manual-split/Motivation-For-Ignore-Lists.html +++ b/local/share/doc/stow/manual-split/Motivation-For-Ignore-Lists.html @@ -1,94 +1,102 @@ - + + + -Motivation For Ignore Lists - Stow - - - - - - - - - +Motivation For Ignore Lists (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -

- -

-Next: , -Previous: Ignore Lists, -Up: Ignore Lists -

-
-

4.1 Motivation For Ignore Lists

+ +
+
+

+Next: , Previous: , Up: Ignore Lists   [Contents][Index]

+
+
+

4.1 Motivation For Ignore Lists

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 -.gitignore, CVS, *,v (RCS files) should typically +.gitignore, CVS, *,v (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. - -

In these cases, it can be rather cumbersome to specify a ---ignore parameter for each file or directory to be ignored. +

+

In these cases, it can be rather cumbersome to specify a +--ignore parameter for each file or directory to be ignored. This could be worked around by ensuring the existence of -~/.stowrc containing multiple --ignore lines, or if a +~/.stowrc containing multiple --ignore lines, or if a different set of files/directories should be ignored depending on -which stow package is involved, a .stowrc file for each stow +which stow package is involved, a .stowrc 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 -.stowrc onto ARGV at run-time, it could clutter up the process +.stowrc 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. - -

Therefore in addition to --ignore parameters, Stow provides a +operating system’s limit for process arguments. +

+ +

Therefore in addition to --ignore parameters, Stow provides a way to specify lists of files and directories to ignore. +

+
- - + + + diff --git a/local/share/doc/stow/manual-split/Multiple-Stow-Directories.html b/local/share/doc/stow/manual-split/Multiple-Stow-Directories.html index e8573d1..946a100 100644 --- a/local/share/doc/stow/manual-split/Multiple-Stow-Directories.html +++ b/local/share/doc/stow/manual-split/Multiple-Stow-Directories.html @@ -1,86 +1,94 @@ - + + + -Multiple Stow Directories - Stow - - - - - - - - +Multiple Stow Directories (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- -

-Next: , -Previous: Mixing Operations, -Up: Top -

-
-

9 Multiple Stow Directories

+ +
+
+

+Next: , Previous:   [Contents][Index]

+
+
+

9 Multiple Stow Directories

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 .stow -in each stow directory. The presence of /usr/local/foo/.stow -informs Stow that, though foo is not the current stow +stow directories, it can be done by creating a file named .stow +in each stow directory. The presence of /usr/local/foo/.stow +informs Stow that, though foo is not the current stow directory, even if it is a subdirectory of the target directory, -nevertheless it is a stow directory and as such Stow -doesn't “own” anything in it (see Installing Packages). This will -protect the contents of foo from a ‘stow -D’, for instance. +nevertheless it is a stow directory and as such Stow +doesn’t “own” anything in it (see Installing Packages). This will +protect the contents of foo from a ‘stow -D’, for instance. +

- -

When multiple stow directories share a target tree, if a tree-folding +

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 .stow, Stow knows how to split +existing symlink points contains .stow, Stow knows how to split open the tree in the correct manner. +

+
- - + + + diff --git a/local/share/doc/stow/manual-split/Other-FSF-Software.html b/local/share/doc/stow/manual-split/Other-FSF-Software.html index 46a1d20..7efab66 100644 --- a/local/share/doc/stow/manual-split/Other-FSF-Software.html +++ b/local/share/doc/stow/manual-split/Other-FSF-Software.html @@ -1,85 +1,95 @@ - + + + -Other FSF Software - Stow - - - - - - - - - +Other FSF Software (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- -

-Next: , -Previous: GNU Emacs, -Up: Compile-time vs Install-time -

-
-

12.3 Other FSF Software

+ +
+
+

+Next: , Previous: , Up: Compile-time vs Install-time   [Contents][Index]

+
+
+

12.3 Other FSF Software

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 ‘autoconf’ and ‘automake’, most packages +has been unifying the build procedure for its tools for some time. +Thanks to its tools ‘autoconf’ and ‘automake’, most packages now respond well to these simple steps, with no other intervention necessary: +

+
+
./configure options
+make
+make install prefix=/usr/local/stow/package
+
-
     ./configure options
-     make
-     make install prefix=/usr/local/stow/package
-
-

Hopefully, these tools can evolve to be aware of Stow-managed packages, -such that providing an option to ‘configure’ can allow ‘make’ -and ‘make install’ steps to work correctly without needing to +

Hopefully, these tools can evolve to be aware of Stow-managed packages, +such that providing an option to ‘configure’ can allow ‘make’ +and ‘make install’ steps to work correctly without needing to “fool” the build process. +

+
- - + + + diff --git a/local/share/doc/stow/manual-split/Perl-and-Perl-5-Modules.html b/local/share/doc/stow/manual-split/Perl-and-Perl-5-Modules.html index 6c082bb..00cb9ec 100644 --- a/local/share/doc/stow/manual-split/Perl-and-Perl-5-Modules.html +++ b/local/share/doc/stow/manual-split/Perl-and-Perl-5-Modules.html @@ -1,150 +1,178 @@ - + + + -Perl and Perl 5 Modules - Stow - - - - - - - - +Perl and Perl 5 Modules (Stow) + + + + + + + + + + + + + + - 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. - --> - - - -
- -

-Previous: Cygnus Software, -Up: Compile-time vs Install-time -

-
-

12.5 Perl and Perl 5 Modules

+ +
+
+

+Previous: , Up: Compile-time vs Install-time   [Contents][Index]

+
+
+

12.5 Perl and Perl 5 Modules

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

Unfortunately, the authors of Perl believed that only AFS sites need +

+

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

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 unless you're running AFS. Fortunately, after you've -entered all the configuration settings, Perl's setup script gives you +

+

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 unless 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 -config.sh. When prompted, you should edit this file and replace +config.sh. When prompted, you should edit this file and replace occurrences of +

+
+
inst.../usr/local...
+
-
     inst.../usr/local...
-
-

with +

with +

+
+
inst.../usr/local/stow/perl...
+
-
     inst.../usr/local/stow/perl...
-
-

You can do this with the following Unix command: +

You can do this with the following Unix command: +

+
+
sed 's,^\(inst.*/usr/local\),\1/stow/perl,' config.sh > config.sh.new
+mv config.sh.new config.sh
+
-
     sed 's,^\(inst.*/usr/local\),\1/stow/perl,' config.sh > config.sh.new
-     mv config.sh.new config.sh
-
-

Hopefully, the Perl authors will correct this deficiency in Perl 5's +

Hopefully, the Perl authors will correct this deficiency in Perl 5’s configuration mechanism. - -

Perl 5 modules—i.e., extensions to Perl 5—generally conform to a set +

+

Perl 5 modules—i.e., extensions to Perl 5—generally conform to a set of standards for building and installing them. The standard says that -the package comes with a top-level Makefile.PL, which is a Perl -script. When it runs, it generates a Makefile. - -

If you followed the instructions above for editing config.sh when -Perl was built, then when you create a Makefile from a -Makefile.PL, it will contain separate locations for run-time -(/usr/local) and install-time (/usr/local/stow/perl). +the package comes with a top-level Makefile.PL, which is a Perl +script. When it runs, it generates a Makefile. +

+

If you followed the instructions above for editing config.sh when +Perl was built, then when you create a Makefile from a +Makefile.PL, it will contain separate locations for run-time +(/usr/local) and install-time (/usr/local/stow/perl). Thus you can do +

+
+
perl Makefile.PL
+make
+make install
+
-
     perl Makefile.PL
-     make
-     make install
-
-

and the files will be installed into /usr/local/stow/perl. +

and the files will be installed into /usr/local/stow/perl. However, you might prefer each Perl module to be stowed separately. In that case, you must edit the resulting Makefile, replacing -/usr/local/stow/perl with /usr/local/stow/module. +/usr/local/stow/perl with /usr/local/stow/module. The best way to do this is: +

+
+
perl Makefile.PL
+find . -name Makefile -print | \
+  xargs perl -pi~ -e 's,^(INST.*/stow)/perl,$1/module,;'
+make
+make install
+
-
     perl Makefile.PL
-     find . -name Makefile -print | \
-       xargs perl -pi~ -e 's,^(INST.*/stow)/perl,$1/module,;'
-     make
-     make install
-
-

(The use of ‘find’ and ‘xargs’ ensures that all Makefiles in -the module's source tree, even those in subdirectories, get edited.) A +

(The use of ‘find’ and ‘xargs’ 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 -module cpan.module, where ‘cpan’ stands for +module cpan.module, where ‘cpan’ 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 /usr/local/stow are Perl 5 +the source of most Perl 5 extensions. This way, it’s easy to tell at a +glance which of the subdirectories of /usr/local/stow are Perl 5 extensions. - -

When you stow separate Perl 5 modules separately, you are likely to -encounter conflicts (see Conflicts) with files named .exists -and perllocal.pod. One way to work around this is to remove +

+

When you stow separate Perl 5 modules separately, you are likely to +encounter conflicts (see Conflicts) with files named .exists +and perllocal.pod. One way to work around this is to remove those files before stowing the module. If you use the -cpan.module naming convention, you can simply do this: +cpan.module naming convention, you can simply do this: +

+
+
cd /usr/local/stow
+find cpan.* \( -name .exists -o -name perllocal.pod \) -print | \
+  xargs rm
+
-
     cd /usr/local/stow
-     find cpan.* \( -name .exists -o -name perllocal.pod \) -print | \
-       xargs rm
-
- - +
+
+
+

+Previous: Cygnus Software, Up: Compile-time vs Install-time   [Contents][Index]

+
+ + + + + diff --git a/local/share/doc/stow/manual-split/Reporting-Bugs.html b/local/share/doc/stow/manual-split/Reporting-Bugs.html index 6f3f6c2..45fa491 100644 --- a/local/share/doc/stow/manual-split/Reporting-Bugs.html +++ b/local/share/doc/stow/manual-split/Reporting-Bugs.html @@ -1,98 +1,107 @@ - + + + -Reporting Bugs - Stow - - - - - - - - +Reporting Bugs (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- -

-Next: , -Previous: Bootstrapping, -Up: Top -

-
-

14 Reporting Bugs

+ +
+
+

+Next: , Previous:   [Contents][Index]

+
+
+

14 Reporting Bugs

Please send bug reports to the current maintainers by electronic -mail. The address to use is ‘<bug-stow@gnu.org>’. Please +mail. The address to use is ‘<bug-stow@gnu.org>’. Please include: +

+
    +
  • the version number of Stow (‘stow --version’); -
      -
    • the version number of Stow (‘stow --version’); +
    • the version number of Perl (‘perl -v’); -
    • the version number of Perl (‘perl -v’); +
    • the system information, which can often be obtained with ‘uname +-a’; -
    • the system information, which can often be obtained with ‘uname --a’; +
    • a description of the bug; -
    • a description of the bug; +
    • the precise command you gave; -
    • the precise command you gave; +
    • the output from the command (preferably verbose output, obtained by +adding ‘--verbose=3’ to the Stow command line). +
    -
  • the output from the command (preferably verbose output, obtained by -adding ‘--verbose=3’ to the Stow command line). -
- -

If you are really keen, consider developing a minimal test case and -creating a new test. See the t/ directory in the source for +

If you are really keen, consider developing a minimal test case and +creating a new test. See the t/ directory in the source for lots of examples. +

+

Before reporting a bug, please read the manual carefully, especially +Known Bugs, to see whether you’re encountering +something that doesn’t need reporting. +(see Conflicts). +

+
-

Before reporting a bug, please read the manual carefully, especially -Known Bugs, to see whether you're encountering -something that doesn't need reporting. -(see Conflicts). - - + + diff --git a/local/share/doc/stow/manual-split/Resource-Files.html b/local/share/doc/stow/manual-split/Resource-Files.html index 7abb7fc..ff3626f 100644 --- a/local/share/doc/stow/manual-split/Resource-Files.html +++ b/local/share/doc/stow/manual-split/Resource-Files.html @@ -1,108 +1,146 @@ - + + + -Resource Files - Stow - - - - - - - - +Resource Files (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -

- + + +
+

-Next: , -Previous: Target Maintenance, -Up: Top -

+Next: , Previous:   [Contents][Index]

+
+

11 Resource Files

+ + -

11 Resource Files

- -

-Default command line options may be set in .stowrc (current directory) or -~/.stowrc (home directory). These are parsed in that order, and effectively -prepended to you command line. This feature can be used for some interesting -effects. - -

For example, suppose your site uses more than one stow directory, perhaps in +

Default command line options may be set in .stowrc (current +directory) or ~/.stowrc (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. +

+

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 -~/.stowrc file: +~/.stowrc file: +

+
+
--dir=/usr/local/stow2
+--target=/usr/local
+--ignore='~'
+--ignore='^CVS'
+
-
     --dir=/usr/local/stow2
-     --target=/usr/local
-     --ignore='~'
-     --ignore='^CVS'
-
-

so that the stow command will default to operating on the -/usr/local/stow2 directory, with /usr/local as the +

so that the stow command will default to operating on the +/usr/local/stow2 directory, with /usr/local as the target, and ignoring vi backup files and CVS directories. - -

If you had a stow directory /usr/local/stow/perl-extras that +

+

If you had a stow directory /usr/local/stow/perl-extras that was only used for Perl modules, then you might place the following in -/usr/local/stow/perl-extras/.stowrc: +/usr/local/stow/perl-extras/.stowrc: +

+
+
--dir=/usr/local/stow/perl-extras
+--target=/usr/local
+--override=bin
+--override=man
+--ignore='perllocal\.pod'
+--ignore='\.packlist'
+--ignore='\.bs'
+
-
     --dir=/usr/local/stow/perl-extras
-     --target=/usr/local
-     --override=bin
-     --override=man
-     --ignore='perllocal\.pod'
-     --ignore='\.packlist'
-     --ignore='\.bs'
-
-

so that when you are in the /usr/local/stow/perl-extras -directory, stow will regard any subdirectories as stow -packages, with /usr/local as the target (rather than the -immediate parent directory /usr/local/stow), overriding any +

so that when you are in the /usr/local/stow/perl-extras +directory, stow will regard any subdirectories as stow +packages, with /usr/local as the target (rather than the +immediate parent directory /usr/local/stow), overriding any pre-existing links to bin files or man pages, and ignoring some cruft that gets installed by default. +

+

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 --target or --dir, the command line +option will overwrite any options in the resource file. For options that can +be given more than once, --ignore for example, command line +options and resource options are appended together. +

+

For options that take a file path, environment variables and the tilde +character (~) are expanded. An environment variable can be +given in either the $VAR or ${VAR} form. To +prevent expansion, escape the $ or ~ with a +backslash. +

+

The options -D, -S, and -R are ignored in +resource files. This is also true of any package names given in the +resource file. +

+
+
+
+

+Next: Compile-time vs Install-time, Previous: Target Maintenance   [Contents][Index]

+
- - + + + diff --git a/local/share/doc/stow/manual-split/Target-Maintenance.html b/local/share/doc/stow/manual-split/Target-Maintenance.html index d283e35..b58f836 100644 --- a/local/share/doc/stow/manual-split/Target-Maintenance.html +++ b/local/share/doc/stow/manual-split/Target-Maintenance.html @@ -1,98 +1,122 @@ - + + + -Target Maintenance - Stow - - - - - - - - +Target Maintenance (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- + + +
+

-Next: , -Previous: Multiple Stow Directories, -Up: Top -

+Next: , Previous:   [Contents][Index]

+
+

10 Target Maintenance

-

10 Target Maintenance

- -

From time to time you will need to clean up your target tree. Since -version 2, Stow provides a new utility chkstow to help with + +

From time to time you will need to clean up your target tree. Since +version 2, Stow provides a new utility chkstow 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. +

+

The syntax of the chkstow command is: +

+
+
chkstow [options]
+
-

The syntax of the chkstow command is: - -

     chkstow [options]
-
-

The following options are supported: - -

-
‘-t dir’
‘--target=dir’
Set the target directory to dir instead of the parent of the stow +

The following options are supported: +

+
+
‘-t dir’
+
‘--target=dir’
+

Set the target directory to dir instead of the parent of the stow directory. Defaults to the parent of the stow directory, so it is typical to -execute stow from the directory /usr/local/stow. - -

‘-b’
‘--badlinks’
Checks target directory for bogus symbolic links. That is, links that point to +execute stow from the directory /usr/local/stow. +

+
+
‘-b’
+
‘--badlinks’
+

Checks target directory for bogus symbolic links. That is, links that point to non-existent files. - -

‘-a’
‘--aliens’
Checks for files in the target directory that are not symbolic links. The +

+
+
‘-a’
+
‘--aliens’
+

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 .stow file. - -

‘-l’
‘--list’
Will display the target package for every symbolic link in the stow target +contain a .stow file. +

+
+
‘-l’
+
‘--list’
+

Will display the target package for every symbolic link in the stow target directory. +

+
+
-
+
- - + + + diff --git a/local/share/doc/stow/manual-split/Terminology.html b/local/share/doc/stow/manual-split/Terminology.html index a7b403e..3c92bb6 100644 --- a/local/share/doc/stow/manual-split/Terminology.html +++ b/local/share/doc/stow/manual-split/Terminology.html @@ -1,113 +1,135 @@ - + + + -Terminology - Stow - - - - - - - - +Terminology (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- + + +
+

-Next: , -Previous: Introduction, -Up: Top -

+Next: , Previous:   [Contents][Index]

+
+

2 Terminology

-

2 Terminology

- -

A package is a related collection of files and directories that + +

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., with -bin, lib, and man subdirectories. - -

A target directory is the root of a tree in which one or more -packages wish to appear to be installed. A common, but by no -means the only such location is /usr/local. The examples in this -manual will use /usr/local as the target directory. - -

A stow directory is the root of a tree containing separate +bin, lib, and man subdirectories. +

+ +

A target directory is the root of a tree in which one or more +packages wish to appear to be installed. A common, but by no +means the only such location is /usr/local. The examples in this +manual will use /usr/local as the target directory. +

+ +

A stow directory 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 /usr/local/stow as the stow directory, so that -individual packages will be, for example, /usr/local/stow/perl -and /usr/local/stow/emacs. - -

An installation image is the layout of files and directories +will use /usr/local/stow as the stow directory, so that +individual packages will be, for example, /usr/local/stow/perl +and /usr/local/stow/emacs. +

+ +

An installation image is the layout of files and directories required by a package, relative to the target directory. Thus, the -installation image for Perl includes: a bin directory containing -perl and a2p (among others); an info directory -containing Texinfo documentation; a lib/perl directory containing -Perl libraries; and a man/man1 directory containing man pages. - -

A package directory is the root of a tree containing the +installation image for Perl includes: a bin directory containing +perl and a2p (among others); an info directory +containing Texinfo documentation; a lib/perl directory containing +Perl libraries; and a man/man1 directory containing man pages. +

+ + +

A package directory 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 -/usr/local/stow/perl must reside in the stow directory -/usr/local/stow. The name of a package is the name of its -directory within the stow directory — e.g., perl. - -

Thus, the Perl executable might reside in -/usr/local/stow/perl/bin/perl, where /usr/local is the -target directory, /usr/local/stow is the stow directory, -/usr/local/stow/perl is the package directory, and -bin/perl within is part of the installation image. - -

A symlink is a symbolic link. A symlink can be relative or -absolute. An absolute symlink names a full path; that is, one -starting from /. A relative symlink names a relative path; that -is, one not starting from /. The target of a relative symlink is -computed starting from the symlink's own directory. Stow only +/usr/local/stow/perl must reside in the stow directory +/usr/local/stow. The name of a package is the name of its +directory within the stow directory — e.g., perl. +

+

Thus, the Perl executable might reside in +/usr/local/stow/perl/bin/perl, where /usr/local is the +target directory, /usr/local/stow is the stow directory, +/usr/local/stow/perl is the package directory, and +bin/perl within is part of the installation image. +

+ + + +

A symlink is a symbolic link. A symlink can be relative or +absolute. An absolute symlink names a full path; that is, one +starting from /. A relative symlink names a relative path; that +is, one not starting from /. The target of a relative symlink is +computed starting from the symlink’s own directory. Stow only creates relative symlinks. +

+
+
+
+

+Next: Invoking Stow, Previous: Introduction   [Contents][Index]

+
- - + + + diff --git a/local/share/doc/stow/manual-split/Tree-unfolding.html b/local/share/doc/stow/manual-split/Tree-unfolding.html index f9d21bf..3928441 100644 --- a/local/share/doc/stow/manual-split/Tree-unfolding.html +++ b/local/share/doc/stow/manual-split/Tree-unfolding.html @@ -1 +1,55 @@ - + + + + + + + +Tree unfolding (Stow) + + + + + + + + + + + + + + +

The node you are looking for is at Tree unfolding.

+ diff --git a/local/share/doc/stow/manual-split/Types-And-Syntax-Of-Ignore-Lists.html b/local/share/doc/stow/manual-split/Types-And-Syntax-Of-Ignore-Lists.html index 879192c..350d372 100644 --- a/local/share/doc/stow/manual-split/Types-And-Syntax-Of-Ignore-Lists.html +++ b/local/share/doc/stow/manual-split/Types-And-Syntax-Of-Ignore-Lists.html @@ -1,167 +1,182 @@ - + + + -Types And Syntax Of Ignore Lists - Stow - - - - - - - - - +Types And Syntax Of Ignore Lists (Stow) + + + + + + + + + + + + + + + - 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. - --> - - - -
- -

-Next: , -Previous: Motivation For Ignore Lists, -Up: Ignore Lists -

-
-

4.2 Types And Syntax Of Ignore Lists

+ +
+
+

+Next: , Previous: , Up: Ignore Lists   [Contents][Index]

+
+
+

4.2 Types And Syntax Of Ignore Lists

If you put Perl regular expressions, one per line, in a -.stow-local-ignore file within any top level package directory, +.stow-local-ignore 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 -~/.stow-global-ignore, if it exists. If neither the +~/.stow-global-ignore, 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: +

+
+
# Comments and blank lines are allowed.
 
-
     # 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
-

-   
Stow first iterates through the chosen ignore list (built-in, global,
+RCS
+.+,v
+
+CVS
+\.\#.+       # CVS conflict files / emacs lock files
+\.cvsignore
+
+\.svn
+_darcs
+\.hg
+
+\.git
+\.gitignore
+
+.+~          # emacs backup files
+\#.*\#       # emacs autosave files
+
+^/README.*
+^/LICENSE.*
+^/COPYING
+
+ +

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 ‘#’ symbol in a regular expression, escape it with a +include the ‘#’ 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 ‘/’ forward +of two sets depending on whether it contains the ‘/’ forward slash symbol. - -

Then in order to determine whether a file or directory should be +

+

Then in order to determine whether a file or directory should be ignored: - -

    -
  1. Stow calculates its path relative to the top-level package directory, -prefixing that with ‘/’. If any of the regular expressions -containing a ‘/’ exactly1 match -a subpath2 of this relative path, then the file or +

    +
      +
    1. Stow calculates its path relative to the top-level package directory, +prefixing that with ‘/’. If any of the regular expressions +containing a ‘/’ exactly4 match +a subpath5 of this relative path, then the file or directory will be ignored. -
    2. If none of the regular expressions containing a ‘/’ match in the +
    3. If none of the regular expressions containing a ‘/’ match in the manner described above, Stow checks whether the -basename3 of the file or directory matches -exactly against the remaining regular expressions which do not -contain a ‘/’, and if so, ignores the file or directory. +basename6 of the file or directory matches +exactly against the remaining regular expressions which do not +contain a ‘/’, and if so, ignores the file or directory. -
    4. Otherwise, the file or directory is not ignored. -
    +
  2. Otherwise, the file or directory is not ignored. +
- - -

For example, if a file bazqux is in the foo/bar + +

For example, if a file bazqux is in the foo/bar subdirectory of the package directory, Stow would use -‘/foo/bar/bazqux’ as the text for matching against regular -expressions which contain ‘/’, and ‘bazqux’ as the text for -matching against regular expressions which don't contain ‘/’. -Then regular expressions ‘bazqux’, ‘baz.*’, ‘.*qux’, -‘bar/.*x’, and ‘^/foo/.*qux’ would all match (causing the -file to be ignored), whereas ‘bar’, ‘baz’, ‘qux’, and -‘o/bar/b’ would not (although ‘bar’ would cause its parent +‘/foo/bar/bazqux’ as the text for matching against regular +expressions which contain ‘/’, and ‘bazqux’ as the text for +matching against regular expressions which don’t contain ‘/’. +Then regular expressions ‘bazqux’, ‘baz.*’, ‘.*qux’, +‘bar/.*x’, and ‘^/foo/.*qux’ would all match (causing the +file to be ignored), whereas ‘bar’, ‘baz’, ‘qux’, and +‘o/bar/b’ would not (although ‘bar’ would cause its parent directory to be ignored and prevent Stow from recursing into that -anyway, in which case the file bazqux would not even be +anyway, in which case the file bazqux would not even be considered for stowing). - -

As a special exception to the above algorithm, any -.stow-local-ignore present in the top-level package directory -is always ignored, regardless of the contents of any ignore +

+

As a special exception to the above algorithm, any +.stow-local-ignore present in the top-level package directory +is always ignored, regardless of the contents of any ignore list, because this file serves no purpose outside the stow directory. - - -

+

+
+
-

Footnotes

[1] Exact matching means the +

Footnotes

+ +
(4)
+

Exact matching means the regular expression is anchored at the beginning and end, in contrast to unanchored regular expressions which will match a substring.

- -

[2] In this context, “subpath” means a contiguous +

(5)
+

In this context, “subpath” means a contiguous subset of path segments; e.g for the relative path -one/two/three, there are six valid subpaths: one, -two, three, one/two, two/three, -one/two/three.

- -

[3] The “basename” is the name of the file or +one/two/three, there are six valid subpaths: one, +two, three, one/two, two/three, +one/two/three.

+
(6)
+

The “basename” is the name of the file or directory itself, excluding any directory path prefix - as returned by -the basename command.

+the basename command.

+
+
+
+

+Next: Justification For Yet Another Set Of Ignore Files, Previous: Motivation For Ignore Lists, Up: Ignore Lists   [Contents][Index]

+
-
- + + diff --git a/local/share/doc/stow/manual-split/index.html b/local/share/doc/stow/manual-split/index.html index e8dd536..032b93e 100644 --- a/local/share/doc/stow/manual-split/index.html +++ b/local/share/doc/stow/manual-split/index.html @@ -1,164 +1,211 @@ - + + + -Stow - - - - - - +Index (Stow) + + + + + + + + + + + + + + - 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. - --> - - - -

Stow

-
-

Table of Contents

- -
- - - -
- + +
+

-Next: , -Up: (dir) +Previous:   [Contents][Index]

+
+

Index

+ +
+
Jump to:   A +   +C +   +D +   +F +   +I +   +M +   +O +   +P +   +R +   +S +   +T +   +U +   +V +   +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Index EntrySection
A
absolute symlinkTerminology
adopting existing filesInvoking Stow
C
configuration filesResource Files
conflictsInstalling Packages
conflictsConflicts
D
deferred operationConflicts
deferred operationMixing Operations
deletionDeleting Packages
directory foldingInstalling Packages
dotfilesInvoking Stow
dry runInvoking Stow
F
folding treesInstalling Packages
I
ignore listsIgnore Lists
ignore listsMotivation For Ignore Lists
ignoring files and directoriesIgnore Lists
installationInstalling Packages
installation conflictsInstalling Packages
installation imageTerminology
M
maintenanceTarget Maintenance
mixing operationsMixing Operations
O
ownershipInstalling Packages
P
packageTerminology
package directoryTerminology
package nameTerminology
R
refolding treesDeleting Packages
relative symlinkTerminology
resource filesResource Files
S
simulated runInvoking Stow
splitting open folded treesInstalling Packages
stow directoryTerminology
symlinkTerminology
T
target directoryTerminology
tree foldingInstalling Packages
tree refoldingDeleting Packages
tree unfoldingInstalling Packages
tree unsplittingInstalling Packages
U
unfolding treesInstalling Packages
V
verbosity levelsInvoking Stow
+
Jump to:   A +   +C +   +D +   +F +   +I +   +M +   +O +   +P +   +R +   +S +   +T +   +U +   +V +   +
-

Stow

+
+
+
+

+Previous: GNU General Public License   [Contents][Index]

+
- -

--- The Detailed Node Listing --- - -

Ignore Lists - -

- -

Advice on changing compilation and installation parameters - -

- - - - + + diff --git a/local/share/doc/stow/manual-split/tree-folding.html b/local/share/doc/stow/manual-split/tree-folding.html index cc06e05..96a9b6a 100644 --- a/local/share/doc/stow/manual-split/tree-folding.html +++ b/local/share/doc/stow/manual-split/tree-folding.html @@ -1 +1,55 @@ - + + + + + + + +tree folding (Stow) + + + + + + + + + + + + + + +

The node you are looking for is at tree folding.

+ diff --git a/local/share/doc/stow/manual-split/tree-refolding.html b/local/share/doc/stow/manual-split/tree-refolding.html index 5d17385..cc01eb8 100644 --- a/local/share/doc/stow/manual-split/tree-refolding.html +++ b/local/share/doc/stow/manual-split/tree-refolding.html @@ -1 +1,55 @@ - + + + + + + + +tree refolding (Stow) + + + + + + + + + + + + + + +

The node you are looking for is at tree refolding.

+ diff --git a/local/share/doc/stow/manual.pdf b/local/share/doc/stow/manual.pdf index 38eb348..a8c02bd 100644 Binary files a/local/share/doc/stow/manual.pdf and b/local/share/doc/stow/manual.pdf differ diff --git a/local/share/doc/stow/version.texi b/local/share/doc/stow/version.texi index a9d4737..ddbcc43 100644 --- a/local/share/doc/stow/version.texi +++ b/local/share/doc/stow/version.texi @@ -1,4 +1,4 @@ -@set UPDATED 9 November 2015 -@set UPDATED-MONTH November 2015 -@set EDITION 2.2.2 -@set VERSION 2.2.2 +@set UPDATED 23 October 2023 +@set UPDATED-MONTH October 2023 +@set EDITION 2.3.2-fixbug56727 +@set VERSION 2.3.2-fixbug56727 diff --git a/local/share/info/dir b/local/share/info/dir index cd5f8a5..50ce727 100644 --- a/local/share/info/dir +++ b/local/share/info/dir @@ -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, "?" lists all Info commands, "d" returns here, + Typing "q" exits, "H" lists all Info commands, "d" returns here, "h" gives a primer for first-timers, "mEmacs" 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. diff --git a/local/share/info/stow.info b/local/share/info/stow.info index 0ee4e1d..d802194 100644 --- a/local/share/info/stow.info +++ b/local/share/info/stow.info @@ -1,15 +1,14 @@ -This is doc/stow.info, produced by makeinfo version 4.13 from -./doc/stow.texi. +This is stow.info, produced by makeinfo version 7.1 from stow.texi. -This manual describes GNU Stow version 2.2.2 (9 November 2015), a -program for managing the installation of software packages. +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: - (C) 1993, 1994, 1995, 1996 Bob Glickstein -(C) 2000, 2001 Guillaume Morin -(C) 2007 Kahlil (Kal) Hodgson -(C) 2011 Adam Spiers + © 1993, 1994, 1995, 1996 Bob Glickstein +© 2000, 2001 Guillaume Morin +© 2007 Kahlil (Kal) Hodgson +© 2011 Adam Spiers Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission @@ -24,9 +23,8 @@ program for managing the installation of software packages. 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. - + modified versions, except that this permission notice may be stated + in a translation approved by the Free Software Foundation. INFO-DIR-SECTION System administration START-INFO-DIR-ENTRY * Stow: (stow). GNU Stow. @@ -38,8 +36,10 @@ File: stow.info, Node: Top, Next: Introduction, Up: (dir) Stow **** -This manual describes GNU Stow 2.2.2 (9 November 2015), a program for -managing the installation of software packages. +This manual describes GNU Stow 2.3.2-fixbug56727 (23 October 2023), a +symlink farm manager which takes distinct sets of software and/or data +located in separate directories on the filesystem, and makes them appear +to be installed in a single directory tree. * Menu: @@ -54,14 +54,14 @@ managing the installation of software packages. * Multiple Stow Directories:: Further segregating software. * Target Maintenance:: Cleaning up mistakes. * Resource Files:: Setting default command line options. -* Compile-time vs Install-time:: Faking out `make install'. +* Compile-time vs Install-time:: Faking out 'make install'. * Bootstrapping:: When stow and perl are not yet stowed. * Reporting Bugs:: How, what, where, and when to report. * Known Bugs:: Don't report any of these. * GNU General Public License:: Copying terms. * Index:: Index of concepts. - --- The Detailed Node Listing --- + -- The Detailed Node Listing -- Ignore Lists @@ -76,19 +76,24 @@ Advice on changing compilation and installation parameters * Cygnus Software:: * Perl and Perl 5 Modules:: +  File: stow.info, Node: Introduction, Next: Terminology, Prev: Top, Up: Top 1 Introduction ************** -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 `/usr/local'. When one does so, one winds up -with the following files(1) in `/usr/local/man/man1': +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. + + 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’. When +one does so, one winds up with the following files(1) in +‘/usr/local/man/man1’: a2p.1 ctags.1 @@ -99,7 +104,7 @@ with the following files(1) in `/usr/local/man/man1': s2p.1 Now suppose it's time to uninstall Perl. Which man pages get removed? -Obviously `perl.1' is one of them, but it should not be the +Obviously ‘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. @@ -109,25 +114,53 @@ 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 `bin' directory -containing executables, a `man/man1' directory containing section 1 man +tree; i.e. (in the typical case) there should be a ‘bin’ directory +containing executables, a ‘man/man1’ directory containing section 1 man pages, 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(2), especially when coupled with version control systems(3). + 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'). +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. For information about the latest version of Stow, you can refer to -`http://www.gnu.org/software/stow/'. +. ---------- Footnotes ---------- - (1) As of Perl 4.036 and Emacs 19.22. + (1) As of Perl 4.036 and Emacs 19.22. These are now ancient releases +but the example still holds valid. + + (2) + + + (3) +  File: stow.info, Node: Terminology, Next: Invoking Stow, Prev: Introduction, Up: Top @@ -135,49 +168,49 @@ File: stow.info, Node: Terminology, Next: Invoking Stow, Prev: Introduction, 2 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., with -`bin', `lib', and `man' subdirectories. + 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., with ‘bin’, +‘lib’, and ‘man’ subdirectories. - A "target directory" is the root of a tree in which one or more + A “target directory” is the root of a tree in which one or more packages wish to _appear_ to be installed. A common, but by no means -the only such location is `/usr/local'. The examples in this manual -will use `/usr/local' as the target directory. +the only such location is ‘/usr/local’. The examples in this manual +will use ‘/usr/local’ as the target directory. - A "stow directory" 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 `/usr/local/stow' as the stow directory, so that individual -packages will be, for example, `/usr/local/stow/perl' and -`/usr/local/stow/emacs'. + A “stow directory” 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 +‘/usr/local/stow’ as the stow directory, so that individual packages +will be, for example, ‘/usr/local/stow/perl’ and +‘/usr/local/stow/emacs’. - An "installation image" is the layout of files and directories + An “installation image” is the layout of files and directories required by a package, relative to the target directory. Thus, the -installation image for Perl includes: a `bin' directory containing -`perl' and `a2p' (among others); an `info' directory containing Texinfo -documentation; a `lib/perl' directory containing Perl libraries; and a -`man/man1' directory containing man pages. +installation image for Perl includes: a ‘bin’ directory containing +‘perl’ and ‘a2p’ (among others); an ‘info’ directory containing Texinfo +documentation; a ‘lib/perl’ directory containing Perl libraries; and a +‘man/man1’ directory containing man pages. - A "package directory" is the root of a tree containing the + A “package directory” 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 -`/usr/local/stow/perl' must reside in the stow directory -`/usr/local/stow'. The "name" of a package is the name of its -directory within the stow directory -- e.g., `perl'. +‘/usr/local/stow/perl’ must reside in the stow directory +‘/usr/local/stow’. The “name” of a package is the name of its directory +within the stow directory -- e.g., ‘perl’. Thus, the Perl executable might reside in -`/usr/local/stow/perl/bin/perl', where `/usr/local' is the target -directory, `/usr/local/stow' is the stow directory, -`/usr/local/stow/perl' is the package directory, and `bin/perl' within +‘/usr/local/stow/perl/bin/perl’, where ‘/usr/local’ is the target +directory, ‘/usr/local/stow’ is the stow directory, +‘/usr/local/stow/perl’ is the package directory, and ‘bin/perl’ within is part of the installation image. - A "symlink" is a symbolic link. A symlink can be "relative" or -"absolute". An absolute symlink names a full path; that is, one -starting from `/'. A relative symlink names a relative path; that is, -one not starting from `/'. The target of a relative symlink is -computed starting from the symlink's own directory. Stow only creates -relative symlinks. + A “symlink” is a symbolic link. A symlink can be “relative” or +“absolute”. An absolute symlink names a full path; that is, one +starting from ‘/’. A relative symlink names a relative path; that is, +one not starting from ‘/’. The target of a relative symlink is computed +starting from the symlink's own directory. Stow only creates relative +symlinks.  File: stow.info, Node: Invoking Stow, Next: Ignore Lists, Prev: Terminology, Up: Top @@ -185,11 +218,11 @@ File: stow.info, Node: Invoking Stow, Next: Ignore Lists, Prev: Terminology, 3 Invoking Stow *************** -The syntax of the `stow' command is: +The syntax of the ‘stow’ command is: stow [OPTIONS] [ACTION FLAG] PACKAGE ... -Each PACKAGE is the name of a package (e.g., `perl') in the stow +Each PACKAGE is the name of a package (e.g., ‘perl’) 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 @@ -197,41 +230,41 @@ name(s) with an ACTION FLAG. The following options are supported: -`-d DIR' -`--dir=DIR' +‘-d DIR’ +‘--dir=DIR’ Set the stow directory to DIR. Defaults to the value of the - environment variable `STOW_DIR' if set, or the current directory + environment variable ‘STOW_DIR’ if set, or the current directory otherwise. -`-t DIR' -`--target=DIR' +‘-t DIR’ +‘--target=DIR’ Set the target directory to DIR instead of the parent of the stow directory. Defaults to the parent of the stow directory, so it is - typical to execute `stow' from the directory `/usr/local/stow'. + typical to execute ‘stow’ from the directory ‘/usr/local/stow’. -`--ignore=REGEXP' +‘--ignore=REGEXP’ This (repeatable) option lets you suppress acting on files that - match the given perl regular expression. For example, using the + match the given Perl regular expression. For example, using the options - --ignore='*.orig' --ignore='*.dist' + --ignore='.*\.orig' --ignore='.*\.dist' - will cause stow to ignore files ending in `.orig' or `.dist'. + will cause stow to ignore files ending in ‘.orig’ or ‘.dist’. 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. Also note that by default Stow automatically ignores a "sensible" - built-in list of files and directories such as `CVS', editor - backup files, and so on. *Note Ignore Lists::, for more details. + built-in list of files and directories such as ‘CVS’, editor backup + files, and so on. *Note Ignore Lists::, for more details. -`--defer=REGEXP' +‘--defer=REGEXP’ 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 `--override'. + package. This is effectively the opposite of ‘--override’. - (N.B. the name `--defer' was chosen in the sense that the package + (N.B. the name ‘--defer’ 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 @@ -244,17 +277,17 @@ The following options are supported: will cause stow to skip over pre-existing man and info pages. - Equivalently, you could use `--defer='man|info'' since the - argument is just a Perl regex. + Equivalently, you could use ‘--defer='man|info'’ since the argument + is just a Perl regular expression. 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. + the path relative to the target directory, because this is what you + will want to do most of the time. -`--override=REGEXP' +‘--override=REGEXP’ 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 + another package. For example, the following options --override=man --override=info @@ -266,93 +299,109 @@ The following options are supported: relative to the target directory, because this is what you will want to do most of the time. -`--no-folding' - This disables any further *note tree folding:: or *note tree - refolding::. 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. +‘--dotfiles’ -`--adopt' - *Warning!* This behaviour is specifically intended to alter the + 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, + ‘stow/dot-bashrc’ and ‘stow/dot-emacs.d/init.el’. With this + option, Stow will create symlinks from ‘.bashrc’ to + ‘stow/dot-bashrc’ and from ‘.emacs.d/init.el’ to + ‘stow/dot-emacs.d/init.el’. Any other files, whose name does not + begin with ‘dot-’, will be processed as usual. + +‘--no-folding’ + + This disables any further tree folding (*note tree folding::) or + refolding (*note tree refolding::). 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. + +‘--adopt’ + *Warning!* 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. 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. + 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. 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 `git diff ...' inside the stow package, and finally either - kept (e.g. via `git commit ...') or discarded (`git checkout HEAD - ...'). + 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 ‘git diff + ...’ inside the stow package, and finally either kept (e.g. via + ‘git commit ...’) or discarded (‘git checkout HEAD ...’). -`-n' -`--no' -`--simulate' +‘-n’ +‘--no’ +‘--simulate’ Do not perform any operations that modify the file system; in - combination with `-v' can be used to merely show what would happen. + combination with ‘-v’ can be used to merely show what would happen. -`-v' -`--verbose[=N]' +‘-v’ +‘--verbose[=N]’ Send verbose output to standard error describing what Stow is - doing. Verbosity levels are 0, 1, 2, and 3; 0 is the default. - Using `-v' or `--verbose' increases the verbosity by one; using - `--verbose=N' sets it to N. + doing. Verbosity levels are from 0 to 5; 0 is the default. Using + ‘-v’ or ‘--verbose’ increases the verbosity by one; using + ‘--verbose=N’ sets it to N. -`-p' -`--compat' +‘-p’ +‘--compat’ Scan the whole target tree when unstowing. By default, only - directories specified in the "installation image" are scanned + directories specified in the “installation image” 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 `--badlinks' option to - the `chkstow' utility may be a better way of ensuring that your + restores the legacy behaviour; however, the ‘--badlinks’ option to + the ‘chkstow’ utility may be a better way of ensuring that your installation does not have any dangling symlinks (*note Target Maintenance::). -`-V' -`--version' +‘-V’ +‘--version’ Show Stow version number, and exit. -`-h' -`--help' +‘-h’ +‘--help’ Show Stow command syntax, and exit. The following ACTION FLAGS are supported: -`-D' -`--delete' +‘-D’ +‘--delete’ Delete (unstow) the package name(s) that follow this option from - the "target directory". This option may be repeated any number of + the “target directory”. This option may be repeated any number of times. -`-R' -`--restow' +‘-R’ +‘--restow’ 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. -`-S' - -`--stow' +‘-S’ +‘--stow’ explictly stow the package name(s) that follow this option. May be - omitted if you are not using the `-D' or `-R' options in the same + omitted if you are not using the ‘-D’ or ‘-R’ options in the same invocation. *Note Mixing Operations::, for details of when you - might like to use this feature. This option may be repeated any + might like to use this feature. This option may be repeated any number of times.  @@ -373,27 +422,26 @@ File: stow.info, Node: Motivation For Ignore Lists, Next: Types And Syntax Of 4.1 Motivation For Ignore Lists =============================== -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 -`.gitignore', `CVS', `*,v' (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. +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 ‘.gitignore’, ‘CVS’, +‘*,v’ (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. - In these cases, it can be rather cumbersome to specify a `--ignore' + In these cases, it can be rather cumbersome to specify a ‘--ignore’ parameter for each file or directory to be ignored. This could be -worked around by ensuring the existence of `~/.stowrc' containing -multiple `--ignore' lines, or if a different set of files/directories +worked around by ensuring the existence of ‘~/.stowrc’ containing +multiple ‘--ignore’ lines, or if a different set of files/directories should be ignored depending on which stow package is involved, a -`.stowrc' file for each stow package, but this would require the user -to ensure that they were in the correct directory before invoking stow, +‘.stowrc’ 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 `.stowrc' onto ARGV at run-time, it could clutter up -the process table with excessively long parameter lists, or even worse, +parameters from ‘.stowrc’ 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. - Therefore in addition to `--ignore' parameters, Stow provides a way + Therefore in addition to ‘--ignore’ parameters, Stow provides a way to specify lists of files and directories to ignore.  @@ -403,76 +451,76 @@ File: stow.info, Node: Types And Syntax Of Ignore Lists, Next: Justification F ==================================== If you put Perl regular expressions, one per line, in a -`.stow-local-ignore' file within any top level package directory, in +‘.stow-local-ignore’ 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 -`~/.stow-global-ignore', if it exists. If neither the package-local or +‘~/.stow-global-ignore’, 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: # 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 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 `#' symbol in a regular expression, escape it with a +include the ‘#’ 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 `/' forward slash +of two sets depending on whether it contains the ‘/’ forward slash symbol. Then in order to determine whether a file or directory should be ignored: 1. Stow calculates its path relative to the top-level package - directory, prefixing that with `/'. If any of the regular - expressions containing a `/' _exactly_(1) match a subpath(2) of + directory, prefixing that with ‘/’. If any of the regular + expressions containing a ‘/’ _exactly_(1) match a subpath(2) of this relative path, then the file or directory will be ignored. - 2. If none of the regular expressions containing a `/' match in the + 2. If none of the regular expressions containing a ‘/’ match in the manner described above, Stow checks whether the _basename_(3) of the file or directory matches _exactly_ against the remaining - regular expressions which do not contain a `/', and if so, ignores + regular expressions which do not contain a ‘/’, and if so, ignores the file or directory. 3. Otherwise, the file or directory is not ignored. - For example, if a file `bazqux' is in the `foo/bar' subdirectory of -the package directory, Stow would use `/foo/bar/bazqux' as the text for -matching against regular expressions which contain `/', and `bazqux' as + For example, if a file ‘bazqux’ is in the ‘foo/bar’ subdirectory of +the package directory, Stow would use ‘/foo/bar/bazqux’ as the text for +matching against regular expressions which contain ‘/’, and ‘bazqux’ as the text for matching against regular expressions which don't contain -`/'. Then regular expressions `bazqux', `baz.*', `.*qux', `bar/.*x', -and `^/foo/.*qux' would all match (causing the file to be ignored), -whereas `bar', `baz', `qux', and `o/bar/b' would not (although `bar' +‘/’. Then regular expressions ‘bazqux’, ‘baz.*’, ‘.*qux’, ‘bar/.*x’, +and ‘^/foo/.*qux’ would all match (causing the file to be ignored), +whereas ‘bar’, ‘baz’, ‘qux’, and ‘o/bar/b’ would not (although ‘bar’ would cause its parent directory to be ignored and prevent Stow from -recursing into that anyway, in which case the file `bazqux' would not +recursing into that anyway, in which case the file ‘bazqux’ would not even be considered for stowing). As a special exception to the above algorithm, any -`.stow-local-ignore' present in the top-level package directory is -_always_ ignored, regardless of the contents of any ignore list, -because this file serves no purpose outside the stow directory. +‘.stow-local-ignore’ present in the top-level package directory is +_always_ ignored, regardless of the contents of any ignore list, because +this file serves no purpose outside the stow directory. ---------- Footnotes ---------- @@ -481,12 +529,12 @@ beginning and end, in contrast to unanchored regular expressions which will match a substring. (2) In this context, "subpath" means a contiguous subset of path -segments; e.g for the relative path `one/two/three', there are six -valid subpaths: `one', `two', `three', `one/two', `two/three', -`one/two/three'. +segments; e.g for the relative path ‘one/two/three’, there are six valid +subpaths: ‘one’, ‘two’, ‘three’, ‘one/two’, ‘two/three’, +‘one/two/three’. (3) The "basename" is the name of the file or directory itself, -excluding any directory path prefix - as returned by the `basename' +excluding any directory path prefix - as returned by the ‘basename’ command.  @@ -496,28 +544,28 @@ File: stow.info, Node: Justification For Yet Another Set Of Ignore Files, Prev ===================================================== The reader may note that this format is very similar to existing ignore -list file formats, such as those for `cvs', `git', `rsync' etc., and +list file formats, such as those for ‘cvs’, ‘git’, ‘rsync’ 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, -`.cvsignore', 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. +‘.cvsignore’, 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. Secondly even if it did, version control system ignore lists generally reflect _build-time_ ignores rather than _install-time_, 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 +(binaries, libraries, documentation etc.) certainly do need to be stowed. Similarly, if a file is _not_ 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. +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. 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. +determine which files and directories to stow, and so it makes sense for +Stow to support independent ignore lists.  File: stow.info, Node: Installing Packages, Next: Deleting Packages, Prev: Ignore Lists, Up: Top @@ -536,35 +584,35 @@ directory in the target tree and populate it with symlinks. ================ For example, suppose that no packages have yet been installed in -`/usr/local'; it's completely empty (except for the `stow' -subdirectory, of course). Now suppose the Perl package is installed. -Recall that it includes the following directories in its installation -image: `bin'; `info'; `lib/perl'; `man/man1'. Rather than creating -the directory `/usr/local/bin' and populating it with symlinks to -`../stow/perl/bin/perl' and `../stow/perl/bin/a2p' (and so on), Stow -will create a single symlink, `/usr/local/bin', which points to -`stow/perl/bin'. In this way, it still works to refer to -`/usr/local/bin/perl' and `/usr/local/bin/a2p', and fewer symlinks have -been created. This is called "tree folding", since an entire subtree -is "folded" into a single symlink. +‘/usr/local’; it's completely empty (except for the ‘stow’ subdirectory, +of course). Now suppose the Perl package is installed. Recall that it +includes the following directories in its installation image: ‘bin’; +‘info’; ‘lib/perl’; ‘man/man1’. Rather than creating the directory +‘/usr/local/bin’ and populating it with symlinks to +‘../stow/perl/bin/perl’ and ‘../stow/perl/bin/a2p’ (and so on), Stow +will create a single symlink, ‘/usr/local/bin’, which points to +‘stow/perl/bin’. In this way, it still works to refer to +‘/usr/local/bin/perl’ and ‘/usr/local/bin/a2p’, and fewer symlinks have +been created. This is called “tree folding”, since an entire subtree is +"folded" into a single symlink. To complete this example, Stow will also create the symlink -`/usr/local/info' pointing to `stow/perl/info'; the symlink -`/usr/local/lib' pointing to `stow/perl/lib'; and the symlink -`/usr/local/man' pointing to `stow/perl/man'. +‘/usr/local/info’ pointing to ‘stow/perl/info’; the symlink +‘/usr/local/lib’ pointing to ‘stow/perl/lib’; and the symlink +‘/usr/local/man’ pointing to ‘stow/perl/man’. 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, `/usr/local/bin' -already exists and is a directory, as are `/usr/local/lib' and -`/usr/local/man/man1'. In this case, Stow will descend into -`/usr/local/bin' and create symlinks to `../stow/perl/bin/perl' and -`../stow/perl/bin/a2p' (etc.), and it will descend into -`/usr/local/lib' and create the tree-folding symlink `perl' pointing to -`../stow/perl/lib/perl', and so on. As a rule, Stow only descends as +system-administration philosophy. In particular, ‘/usr/local/bin’ +already exists and is a directory, as are ‘/usr/local/lib’ and +‘/usr/local/man/man1’. In this case, Stow will descend into +‘/usr/local/bin’ and create symlinks to ‘../stow/perl/bin/perl’ and +‘../stow/perl/bin/a2p’ (etc.), and it will descend into ‘/usr/local/lib’ +and create the tree-folding symlink ‘perl’ pointing to +‘../stow/perl/lib/perl’, 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 `--no-folding' +symlink. However, this behaviour can be changed via the ‘--no-folding’ option; *note Invoking Stow::. 5.2 Tree unfolding @@ -572,41 +620,41 @@ option; *note Invoking Stow::. 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" or -"unfolding" a folded tree. It involves removing the original symlink +its installation image. This operation is called “splitting open” or +“unfolding” 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 _and_ to the old package that used the old symlink. For -example, suppose that after installing Perl into an empty `/usr/local', -we wish to install Emacs. Emacs's installation image includes a `bin' -directory containing the `emacs' and `etags' executables, among others. -Stow must make these files appear to be installed in `/usr/local/bin', -but presently `/usr/local/bin' is a symlink to `stow/perl/bin'. Stow -therefore takes the following steps: the symlink `/usr/local/bin' is -deleted; the directory `/usr/local/bin' is created; links are made from -`/usr/local/bin' to `../stow/emacs/bin/emacs' and -`../stow/emacs/bin/etags'; and links are made from `/usr/local/bin' to -`../stow/perl/bin/perl' and `../stow/perl/bin/a2p'. +example, suppose that after installing Perl into an empty ‘/usr/local’, +we wish to install Emacs. Emacs's installation image includes a ‘bin’ +directory containing the ‘emacs’ and ‘etags’ executables, among others. +Stow must make these files appear to be installed in ‘/usr/local/bin’, +but presently ‘/usr/local/bin’ is a symlink to ‘stow/perl/bin’. Stow +therefore takes the following steps: the symlink ‘/usr/local/bin’ is +deleted; the directory ‘/usr/local/bin’ is created; links are made from +‘/usr/local/bin’ to ‘../stow/emacs/bin/emacs’ and +‘../stow/emacs/bin/etags’; and links are made from ‘/usr/local/bin’ to +‘../stow/perl/bin/perl’ and ‘../stow/perl/bin/a2p’. 5.3 Ownership ============= 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. _Stow will never delete anything that it doesn't own_. -Stow "owns" 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 "owns". Note that by -this definition, Stow doesn't "own" anything _in_ the stow directory or -in any of the packages. +directory. _Stow will never delete anything that it doesn't own_. Stow +"owns" 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 "owns". Note that by this +definition, Stow doesn't "own" anything _in_ the stow directory or in +any of the packages. 5.4 Conflicts during installation ================================= 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. *Note Conflicts::. +then a “conflict” has arisen. *Note Conflicts::.  File: stow.info, Node: Deleting Packages, Next: Conflicts, Prev: Installing Packages, Up: Top @@ -614,18 +662,18 @@ File: stow.info, Node: Deleting Packages, Next: Conflicts, Prev: Installing P 6 Deleting Packages ******************* -When the `-D' 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 _not_ mean removing it from -the stow directory or discarding the package tree. +When the ‘-D’ 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 _not_ mean removing it from the +stow directory or discarding the package tree. - To delete a package, Stow recursively scans the target tree, -skipping over any directory that is not included in the installation -image.(1) For example, if the target directory is `/usr/local' and the -installation image for the package being deleted has only a `bin' -directory and a `man' directory at the top level, then we only scan -`/usr/local/bin' and `/usr/local/bin/man', and not `/usr/local/lib' or -`/usr/local/share', or for that matter `/usr/local/stow'. Any symlink + To delete a package, Stow recursively scans the target tree, skipping +over any directory that is not included in the installation image.(1) +For example, if the target directory is ‘/usr/local’ and the +installation image for the package being deleted has only a ‘bin’ +directory and a ‘man’ directory at the top level, then we only scan +‘/usr/local/bin’ and ‘/usr/local/man’, and not ‘/usr/local/lib’ or +‘/usr/local/share’, or for that matter ‘/usr/local/stow’. 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. @@ -638,7 +686,7 @@ contains only symlinks to a single other package is considered to be a previously "folded" tree that was "split open." 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 `--no-folding' option; +However, this behaviour can be prevented via the ‘--no-folding’ option; *note Invoking Stow::. ---------- Footnotes ---------- @@ -649,9 +697,9 @@ 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 `-p' option. Alternatively, you can use the -`--badlinks' option get stow to search for dangling links in your -target tree and remove the offenders manually. +approach with the ‘-p’ option. Alternatively, you can use the +‘--badlinks’ option get stow to search for dangling links in your target +tree and remove the offenders manually.  File: stow.info, Node: Conflicts, Next: Mixing Operations, Prev: Deleting Packages, Up: Top @@ -660,13 +708,13 @@ File: stow.info, Node: Conflicts, Next: Mixing Operations, Prev: Deleting Pac *********** 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 -"conflict" 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.) +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 “conflict” 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.) For complex packages, scanning the stow and target trees in tandem, and deciding whether to make directories or links, split-open or fold @@ -677,12 +725,12 @@ take into account all of these operations. 7.1 Deferred Operation ====================== -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. +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. 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 @@ -706,8 +754,8 @@ invocation. 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 (*note Deferred Operation::), so the -amount of of time in which GNU Emacs is unavailable is minimised. +merged before being executed (*note Deferred Operation::), so the amount +of of time in which GNU Emacs is unavailable is minimised. You can mix and match any number of actions, for example, @@ -723,18 +771,18 @@ File: stow.info, Node: Multiple Stow Directories, Next: Target Maintenance, 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 `.stow' in -each stow directory. The presence of `/usr/local/foo/.stow' informs -Stow that, though `foo' is not the current stow directory, even if it -is a subdirectory of the target directory, nevertheless it is _a_ stow +stow directories, it can be done by creating a file named ‘.stow’ in +each stow directory. The presence of ‘/usr/local/foo/.stow’ informs +Stow that, though ‘foo’ is not the current stow directory, even if it is +a subdirectory of the target directory, nevertheless it is _a_ stow directory and as such Stow doesn't "own" anything in it (*note -Installing Packages::). This will protect the contents of `foo' from a -`stow -D', for instance. +Installing Packages::). This will protect the contents of ‘foo’ from a +‘stow -D’, for instance. 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 `.stow', Stow knows how to split open +existing symlink points contains ‘.stow’, Stow knows how to split open the tree in the correct manner.  @@ -744,38 +792,37 @@ File: stow.info, Node: Target Maintenance, Next: Resource Files, Prev: Multip ********************* From time to time you will need to clean up your target tree. Since -version 2, Stow provides a new utility `chkstow' to help with this. It +version 2, Stow provides a new utility ‘chkstow’ 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. - The syntax of the `chkstow' command is: + The syntax of the ‘chkstow’ command is: chkstow [OPTIONS] The following options are supported: -`-t DIR' -`--target=DIR' +‘-t DIR’ +‘--target=DIR’ Set the target directory to DIR instead of the parent of the stow directory. Defaults to the parent of the stow directory, so it is - typical to execute `stow' from the directory `/usr/local/stow'. + typical to execute ‘stow’ from the directory ‘/usr/local/stow’. -`-b' -`--badlinks' - Checks target directory for bogus symbolic links. That is, links +‘-b’ +‘--badlinks’ + Checks target directory for bogus symbolic links. That is, links that point to non-existent files. -`-a' -`--aliens' +‘-a’ +‘--aliens’ 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 `.stow' file. - -`-l' -`--list' - Will display the target package for every symbolic link in the - stow target directory. + links. The target directory should be managed by stow alone, + except for directories that contain a ‘.stow’ file. +‘-l’ +‘--list’ + Will display the target package for every symbolic link in the stow + target directory.  File: stow.info, Node: Resource Files, Next: Compile-time vs Install-time, Prev: Target Maintenance, Up: Top @@ -783,28 +830,29 @@ File: stow.info, Node: Resource Files, Next: Compile-time vs Install-time, Pr 11 Resource Files ***************** -Default command line options may be set in `.stowrc' (current -directory) or `~/.stowrc' (home directory). These are parsed in that -order, and effectively prepended to you command line. This feature can -be used for some interesting effects. +Default command line options may be set in ‘.stowrc’ (current directory) +or ‘~/.stowrc’ (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. 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 `~/.stowrc' file: +systems administrators. One of the administrators might have the +following in their ‘~/.stowrc’ file: --dir=/usr/local/stow2 --target=/usr/local --ignore='~' --ignore='^CVS' - so that the `stow' command will default to operating on the -`/usr/local/stow2' directory, with `/usr/local' as the target, and + so that the ‘stow’ command will default to operating on the +‘/usr/local/stow2’ directory, with ‘/usr/local’ as the target, and ignoring vi backup files and CVS directories. - If you had a stow directory `/usr/local/stow/perl-extras' that was + If you had a stow directory ‘/usr/local/stow/perl-extras’ that was only used for Perl modules, then you might place the following in -`/usr/local/stow/perl-extras/.stowrc': +‘/usr/local/stow/perl-extras/.stowrc’: --dir=/usr/local/stow/perl-extras --target=/usr/local @@ -814,12 +862,27 @@ only used for Perl modules, then you might place the following in --ignore='\.packlist' --ignore='\.bs' - so that when you are in the `/usr/local/stow/perl-extras' directory, -`stow' will regard any subdirectories as stow packages, with -`/usr/local' as the target (rather than the immediate parent directory -`/usr/local/stow'), overriding any pre-existing links to bin files or + so that when you are in the ‘/usr/local/stow/perl-extras’ directory, +‘stow’ will regard any subdirectories as stow packages, with +‘/usr/local’ as the target (rather than the immediate parent directory +‘/usr/local/stow’), overriding any pre-existing links to bin files or man pages, and ignoring some cruft that gets installed by default. + 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 ‘--target’ or ‘--dir’, the command line +option will overwrite any options in the resource file. For options +that can be given more than once, ‘--ignore’ for example, command line +options and resource options are appended together. + + For options that take a file path, environment variables and the +tilde character (‘~’) are expanded. An environment variable can be +given in either the ‘$VAR’ or ‘${VAR}’ form. To prevent expansion, +escape the ‘$’ or ‘~’ with a backslash. + + The options ‘-D’, ‘-S’, and ‘-R’ are ignored in resource files. This +is also true of any package names given in the resource file. +  File: stow.info, Node: Compile-time vs Install-time, Next: Bootstrapping, Prev: Resource Files, Up: Top @@ -827,19 +890,19 @@ File: stow.info, Node: Compile-time vs Install-time, Next: Bootstrapping, Pre ******************************* Software whose installation is managed with Stow needs to be installed -in one place (the package directory, e.g. `/usr/local/stow/perl') but +in one place (the package directory, e.g. ‘/usr/local/stow/perl’) but needs to appear to run in another place (the target tree, e.g., -`/usr/local'). Why is this important? What's wrong with Perl, for -instance, looking for its files in `/usr/local/stow/perl' instead of in -`/usr/local'? +‘/usr/local’). Why is this important? What's wrong with Perl, for +instance, looking for its files in ‘/usr/local/stow/perl’ instead of in +‘/usr/local’? The answer is that there may be another package, e.g., -`/usr/local/stow/perl-extras', stowed under `/usr/local'. If Perl is -configured to find its files in `/usr/local/stow/perl', it will never -find the extra files in the `perl-extras' package, even though they're +‘/usr/local/stow/perl-extras’, stowed under ‘/usr/local’. If Perl is +configured to find its files in ‘/usr/local/stow/perl’, it will never +find the extra files in the ‘perl-extras’ package, even though they're intended to be found by Perl. On the other hand, if Perl looks for its -files in `/usr/local', then it will find the intermingled Perl and -`perl-extras' files. +files in ‘/usr/local’, then it will find the intermingled Perl and +‘perl-extras’ files. 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 @@ -851,35 +914,33 @@ must place it in the stow tree. Some software packages allow you to specify, at compile-time, separate locations for installation and for run-time. Perl is one such package; see *note Perl and Perl 5 Modules::. Others allow you to compile the -package, then give a different destination in the `make install' step +package, then give a different destination in the ‘make install’ step without causing the binaries or other files to get rebuilt. Most GNU software falls into this category; Emacs is a notable exception. *Note GNU Emacs::, and *note Other FSF Software::. Still other software packages cannot abide the idea of separate -installation and run-time locations at all. If you try to `make -install prefix=/usr/local/stow/FOO', then first the whole package will -be recompiled to hardwire the `/usr/local/stow/FOO' path. With these -packages, it is best to compile normally, then run `make -n install', +installation and run-time locations at all. If you try to ‘make install +prefix=/usr/local/stow/FOO’, then first the whole package will be +recompiled to hardwire the ‘/usr/local/stow/FOO’ path. With these +packages, it is best to compile normally, then run ‘make -n install’, 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 `make install'. Be sure to execute the script using the same -shell that `make install' would have used. +to remove recompilation steps and to reflect the Stow-based installation +location, and execute the edited file as a shell script in place of +‘make install’. Be sure to execute the script using the same shell that +‘make install’ would have used. (If you use GNU Make and a shell [such as GNU bash] that understands -`pushd' and `popd', you can do the following: +‘pushd’ and ‘popd’, you can do the following: - 1. Replace all lines matching `make[N]: Entering directory DIR' with - `pushd DIR'. + 1. Replace all lines matching ‘make[N]: Entering directory DIR’ with + ‘pushd DIR’. + 2. Replace all lines matching ‘make[N]: Leaving directory DIR’ with + ‘popd’. + 3. Delete all lines matching ‘make[N]: Nothing to be done for RULE’. - 2. Replace all lines matching `make[N]: Leaving directory DIR' with - `popd'. - - 3. Delete all lines matching `make[N]: Nothing to be done for RULE'. - - Then find other lines in the output containing `cd' or `make' + Then find other lines in the output containing ‘cd’ or ‘make’ commands and rewrite or delete them. In particular, you should be able to delete sections of the script that resemble this: @@ -914,10 +975,10 @@ rules. In particular, most GNU software allows you to write: make make install prefix=/usr/local/stow/PACKAGE -If you try this with Emacs, then the new value for PREFIX in the `make -install' step will cause some files to get recompiled with the new -value of PREFIX wired into them. In Emacs 19.23 and later,(1) the way -to work around this problem is: +If you try this with Emacs, then the new value for PREFIX in the ‘make +install’ step will cause some files to get recompiled with the new value +of PREFIX wired into them. In Emacs 19.23 and later,(1) the way to work +around this problem is: make make install-arch-dep install-arch-indep prefix=/usr/local/stow/emacs @@ -939,18 +1000,17 @@ File: stow.info, Node: Other FSF Software, Next: Cygnus Software, Prev: GNU E 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 `autoconf' and `automake', most packages now -respond well to these simple steps, with no other intervention -necessary: +Thanks to its tools ‘autoconf’ and ‘automake’, most packages now respond +well to these simple steps, with no other intervention necessary: ./configure OPTIONS make make install prefix=/usr/local/stow/PACKAGE Hopefully, these tools can evolve to be aware of Stow-managed -packages, such that providing an option to `configure' can allow `make' -and `make install' steps to work correctly without needing to "fool" -the build process. +packages, such that providing an option to ‘configure’ can allow ‘make’ +and ‘make install’ steps to work correctly without needing to "fool" the +build process.  File: stow.info, Node: Cygnus Software, Next: Perl and Perl 5 Modules, Prev: Other FSF Software, Up: Compile-time vs Install-time @@ -961,25 +1021,25 @@ File: stow.info, Node: Cygnus Software, Next: Perl and Perl 5 Modules, Prev: 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 `gdb', -`gnats', and `dejagnu'. +other packages. Among the packages released by Cygnus are ‘gdb’, +‘gnats’, and ‘dejagnu’. 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 _all_ of Cygnus' packages, any number of which may reside under the top-level directory. In other words, even if you're only building -`gnats', the top-level Makefile will look for, and try to build, `gdb' -and `dejagnu' subdirectories, among many others. +‘gnats’, the top-level Makefile will look for, and try to build, ‘gdb’ +and ‘dejagnu’ subdirectories, among many others. - The result is that if you try `make -n install -prefix=/usr/local/stow/PACKAGE' at the top level of a Cygnus package, + The result is that if you try ‘make -n install +prefix=/usr/local/stow/PACKAGE’ 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. - In cases like this, the best approach is to run your `make install -prefix=...', but be ready to interrupt it if you detect that it is + In cases like this, the best approach is to run your ‘make install +prefix=...’, but be ready to interrupt it if you detect that it is recompiling files. Usually it will work just fine; otherwise, install manually. @@ -999,15 +1059,15 @@ 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 +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. 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 _unless_ 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 `config.sh'. When +trees _unless_ 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 ‘config.sh’. When prompted, you should edit this file and replace occurrences of inst.../usr/local... @@ -1026,22 +1086,22 @@ configuration mechanism. Perl 5 modules--i.e., extensions to Perl 5--generally conform to a set of standards for building and installing them. The standard says -that the package comes with a top-level `Makefile.PL', which is a Perl -script. When it runs, it generates a `Makefile'. +that the package comes with a top-level ‘Makefile.PL’, which is a Perl +script. When it runs, it generates a ‘Makefile’. - If you followed the instructions above for editing `config.sh' when -Perl was built, then when you create a `Makefile' from a `Makefile.PL', -it will contain separate locations for run-time (`/usr/local') and -install-time (`/usr/local/stow/perl'). Thus you can do + If you followed the instructions above for editing ‘config.sh’ when +Perl was built, then when you create a ‘Makefile’ from a ‘Makefile.PL’, +it will contain separate locations for run-time (‘/usr/local’) and +install-time (‘/usr/local/stow/perl’). Thus you can do perl Makefile.PL make make install -and the files will be installed into `/usr/local/stow/perl'. However, +and the files will be installed into ‘/usr/local/stow/perl’. However, you might prefer each Perl module to be stowed separately. In that case, you must edit the resulting Makefile, replacing -`/usr/local/stow/perl' with `/usr/local/stow/MODULE'. The best way to +‘/usr/local/stow/perl’ with ‘/usr/local/stow/MODULE’. The best way to do this is: perl Makefile.PL @@ -1050,18 +1110,18 @@ do this is: make make install -(The use of `find' and `xargs' 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 -MODULE `cpan.MODULE', where `cpan' 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 `/usr/local/stow' are Perl 5 extensions. +(The use of ‘find’ and ‘xargs’ 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 MODULE +‘cpan.MODULE’, where ‘cpan’ 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 ‘/usr/local/stow’ are Perl 5 extensions. When you stow separate Perl 5 modules separately, you are likely to -encounter conflicts (*note Conflicts::) with files named `.exists' and -`perllocal.pod'. One way to work around this is to remove those files -before stowing the module. If you use the `cpan.MODULE' naming +encounter conflicts (*note Conflicts::) with files named ‘.exists’ and +‘perllocal.pod’. One way to work around this is to remove those files +before stowing the module. If you use the ‘cpan.MODULE’ naming convention, you can simply do this: cd /usr/local/stow @@ -1075,20 +1135,20 @@ File: stow.info, Node: Bootstrapping, Next: Reporting Bugs, Prev: Compile-tim **************** Suppose you have a stow directory all set up and ready to go: -`/usr/local/stow/perl' contains the Perl installation, -`/usr/local/stow/stow' contains Stow itself, and perhaps you have other +‘/usr/local/stow/perl’ contains the Perl installation, +‘/usr/local/stow/stow’ contains Stow itself, and perhaps you have other packages waiting to be stowed. You'd like to be able to do this: cd /usr/local/stow stow -vv * -but `stow' is not yet in your `PATH'. Nor can you do this: +but ‘stow’ is not yet in your ‘PATH’. Nor can you do this: cd /usr/local/stow stow/bin/stow -vv * -because the `#!' line at the beginning of `stow' tries to locate Perl -(usually in `/usr/local/bin/perl'), and that won't be found. The +because the ‘#!’ line at the beginning of ‘stow’ tries to locate Perl +(usually in ‘/usr/local/bin/perl’), and that won't be found. The solution you must use is: cd /usr/local/stow @@ -1101,24 +1161,24 @@ File: stow.info, Node: Reporting Bugs, Next: Known Bugs, Prev: Bootstrapping, ***************** Please send bug reports to the current maintainers by electronic mail. -The address to use is `'. Please include: +The address to use is ‘’. Please include: - * the version number of Stow (`stow --version'); + • the version number of Stow (‘stow --version’); - * the version number of Perl (`perl -v'); + • the version number of Perl (‘perl -v’); - * the system information, which can often be obtained with `uname - -a'; + • the system information, which can often be obtained with ‘uname + -a’; - * a description of the bug; + • a description of the bug; - * the precise command you gave; + • the precise command you gave; - * the output from the command (preferably verbose output, obtained by - adding `--verbose=3' to the Stow command line). + • the output from the command (preferably verbose output, obtained by + adding ‘--verbose=3’ to the Stow command line). If you are really keen, consider developing a minimal test case and -creating a new test. See the `t/' directory in the source for lots of +creating a new test. See the ‘t/’ directory in the source for lots of examples. Before reporting a bug, please read the manual carefully, especially @@ -1131,8 +1191,8 @@ File: stow.info, Node: Known Bugs, Next: GNU General Public License, Prev: Re 15 Known Bugs ************* -There are no known bugs in Stow version 2.2.2! If you think you have -found one, please *note Reporting Bugs::. +There are no known bugs in Stow version 2.3.2-fixbug56727! If you think +you have found one, please *note Reporting Bugs::.  File: stow.info, Node: GNU General Public License, Next: Index, Prev: Known Bugs, Up: Top @@ -1140,295 +1200,659 @@ File: stow.info, Node: GNU General Public License, Next: Index, Prev: Known B GNU General Public License ************************** - Version 2, June 1991 + Version 3, 29 June 2007 - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 675 Mass Ave, Cambridge, MA 02139, USA + Copyright © 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. + Everyone is permitted to copy and distribute verbatim copies of this + license document, but changing it is not allowed. Preamble ======== -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--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 +The GNU General Public License is a free, copyleft license for software +and other kinds of works. + + 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--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. 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. +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. - 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. + 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. 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. +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. - 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. + 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. - 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. + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' 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. - 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. + 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' 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. + + 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. The precise terms and conditions for copying, distribution and modification follow. - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - 0. 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 "Program", - below, refers to any such program or work, and a "work based on - the Program" 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 "modification".) Each - licensee is addressed as "you". +TERMS AND CONDITIONS +==================== - 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. + 0. Definitions. - 1. 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. + "This License" refers to version 3 of the GNU General Public + License. - 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. + "Copyright" also means copyright-like laws that apply to other + kinds of works, such as semiconductor masks. - 2. 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: + "The Program" refers to any copyrightable work licensed under this + License. Each licensee is addressed as "you". "Licensees" and + "recipients" may be individuals or organizations. - a. You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. + To "modify" 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 "modified + version" of the earlier work or a work "based on" the earlier work. - b. 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. + A "covered work" means either the unmodified Program or a work + based on the Program. - c. 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.) + To "propagate" 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. - 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. + To "convey" 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. - 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. + An interactive user interface displays "Appropriate Legal Notices" + 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. - 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. + 1. Source Code. - 3. 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: + The "source code" for a work means the preferred form of the work + for making modifications to it. "Object code" means any non-source + form of a work. - a. 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, + A "Standard Interface" 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. - b. 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, + The "System Libraries" 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 "Major Component", 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. - c. 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.) + The "Corresponding Source" 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'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. - 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. + The Corresponding Source need not include anything that users can + regenerate automatically from other parts of the Corresponding + Source. - 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. + The Corresponding Source for a work in source code form is that + same work. - 4. 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. + 2. Basic Permissions. - 5. 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. + 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. - 6. 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. + 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. - 7. 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. + Conveying under any other circumstances is permitted solely under + the conditions stated below. Sublicensing is not allowed; section + 10 makes it unnecessary. - 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. + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - 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. + 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. - This section is intended to make thoroughly clear what is believed - to be a consequence of the rest of this License. + 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's users, your or third parties' legal + rights to forbid circumvention of technological measures. - 8. 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. + 4. Conveying Verbatim Copies. - 9. The Free Software Foundation may publish revised and/or new - versions of the General Public License from time to time. Such + You may convey 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; + 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. + + 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. + + 5. Conveying Modified Source Versions. + + 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: + + a. The work must carry prominent notices stating that you + modified it, and giving a relevant date. + + b. 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 "keep intact all notices". + + c. 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. + + d. 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. + + 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 "aggregate" if the compilation and its resulting + copyright are not used to limit the access or legal rights of the + compilation'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. + + 6. Conveying Non-Source Forms. + + 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: + + a. 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. + + b. 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. + + c. 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. + + d. 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. + + e. 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. + + 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. + + A "User Product" is either (1) a "consumer product", 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, + "normally used" 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. + + "Installation Information" 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. + + 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). + + 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. + + 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. + + 7. Additional Terms. + + "Additional permissions" 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. + + 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. + + 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: + + a. Disclaiming warranty or limiting liability differently from + the terms of sections 15 and 16 of this License; or + + b. 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 + + c. 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 + + d. Limiting the use for publicity purposes of names of licensors + or authors of the material; or + + e. Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f. 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. + + All other non-permissive additional terms are considered "further + restrictions" 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. + + 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. + + 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. + + 8. Termination. + + 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). + + 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. + + 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. + + 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. + + 9. Acceptance Not Required for Having Copies. + + 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. + + 10. Automatic Licensing of Downstream Recipients. + + 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. + + An "entity transaction" 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'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. + + 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. + + 11. Patents. + + A "contributor" 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's "contributor + version". + + A contributor's "essential patent claims" 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, "control" + includes the right to grant patent sublicenses in a manner + consistent with the requirements of this License. + + Each contributor grants you a non-exclusive, worldwide, + royalty-free patent license under the contributor's essential + patent claims, to make, use, sell, offer for sale, import and + otherwise run, modify and propagate the contents of its contributor + version. + + In the following three paragraphs, a "patent license" 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 "grant" + such a patent license to a party means to make such an agreement or + commitment not to enforce a patent against the party. + + 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. "Knowingly relying" means you have actual knowledge + that, but for the patent license, your conveying the covered work + in a country, or your recipient'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. + + 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. + + A patent license is "discriminatory" 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. + + 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. + + 12. No Surrender of Others' Freedom. + + 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. + + 13. Use with the GNU Affero General Public License. + + 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. + + 14. Revised Versions of this License. + + 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. Each version is given a distinguishing version number. If the - Program specifies a version number of this License which applies - to it and "any later version", 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. + Program specifies that a certain numbered version of the GNU + General Public License "or any later version" 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. - 10. 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. + If the Program specifies that a proxy can decide which future + versions of the GNU General Public License can be used, that + proxy's public statement of acceptance of a version permanently + authorizes you to choose that version for the Program. - NO WARRANTY - 11. 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 "AS IS" 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. + 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. - 12. 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. + 15. Disclaimer of Warranty. + + 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 "AS IS" + 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. + + 16. Limitation of Liability. + + 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. + + 17. Interpretation of Sections 15 and 16. + + 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. + +END OF TERMS AND CONDITIONS +=========================== - END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs ============================================= @@ -1439,61 +1863,52 @@ terms. 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 "copyright" line and a pointer to where the full notice is found. +state the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. - ONE LINE TO GIVE THE PROGRAM'S NAME AND AN IDEA OF WHAT IT DOES. - Copyright (C) 19YY NAME OF AUTHOR + ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES. + Copyright (C) YEAR NAME OF AUTHOR - 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 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. + 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. + along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. - If the program is interactive, make it output a short notice like -this when it starts in an interactive mode: + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: - Gnomovision version 69, Copyright (C) 19YY NAME OF AUTHOR - 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. + PROGRAM Copyright (C) YEAR NAME OF AUTHOR + This program 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. - The hypothetical commands `show w' and `show c' should show the -appropriate parts of the General Public License. Of course, the -commands you use may be called something other than `show w' and `show -c'; they could even be mouse-clicks or menu items--whatever suits your -program. + The hypothetical commands ‘show w’ and ‘show c’ should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". You should also get your employer (if you work as a programmer) or -your school, if any, to sign a "copyright disclaimer" for the program, -if necessary. Here is a sample; alter the names: +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . - Yoyodyne, Inc., hereby disclaims all copyright - interest in the program `Gnomovision' - (which makes passes at compilers) written - by James Hacker. - - SIGNATURE OF TY COON, 1 April 1989 - Ty Coon, President of Vice - - This General Public License does not permit incorporating your + 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 Library General Public License instead of this License. +GNU Lesser General Public License instead of this License. But first, +please read .  File: stow.info, Node: Index, Prev: GNU General Public License, Up: Top @@ -1505,19 +1920,20 @@ Index * Menu: * absolute symlink: Terminology. (line 43) -* adopting existing files: Invoking Stow. (line 97) +* adopting existing files: Invoking Stow. (line 115) * configuration files: Resource Files. (line 6) -* conflicts <1>: Conflicts. (line 6) * conflicts: Installing Packages. (line 85) -* deferred operation <1>: Mixing Operations. (line 15) +* conflicts <1>: Conflicts. (line 6) * deferred operation: Conflicts. (line 24) +* deferred operation <1>: Mixing Operations. (line 15) * deletion: Deleting Packages. (line 6) * directory folding: Installing Packages. (line 16) -* dry run: Invoking Stow. (line 120) +* dotfiles: Invoking Stow. (line 87) +* dry run: Invoking Stow. (line 137) * folding trees: Installing Packages. (line 16) -* ignore lists <1>: Motivation For Ignore Lists. - (line 26) * ignore lists: Ignore Lists. (line 6) +* ignore lists <1>: Motivation For Ignore Lists. + (line 25) * ignoring files and directories: Ignore Lists. (line 6) * installation: Installing Packages. (line 6) * installation conflicts: Installing Packages. (line 85) @@ -1531,7 +1947,7 @@ Index * refolding trees: Deleting Packages. (line 25) * relative symlink: Terminology. (line 43) * resource files: Resource Files. (line 6) -* simulated run: Invoking Stow. (line 120) +* simulated run: Invoking Stow. (line 137) * splitting open folded trees: Installing Packages. (line 51) * stow directory: Terminology. (line 16) * symlink: Terminology. (line 43) @@ -1541,45 +1957,52 @@ Index * tree unfolding: Installing Packages. (line 51) * tree unsplitting: Installing Packages. (line 51) * unfolding trees: Installing Packages. (line 51) -* verbosity levels: Invoking Stow. (line 126) +* verbosity levels: Invoking Stow. (line 143)  Tag Table: -Node: Top1445 -Node: Introduction2967 -Ref: Introduction-Footnote-15130 -Node: Terminology5172 -Node: Invoking Stow7535 -Node: Ignore Lists14338 -Node: Motivation For Ignore Lists14602 -Node: Types And Syntax Of Ignore Lists16097 -Ref: Types And Syntax Of Ignore Lists-Footnote-119260 -Ref: Types And Syntax Of Ignore Lists-Footnote-219426 -Ref: Types And Syntax Of Ignore Lists-Footnote-319642 -Node: Justification For Yet Another Set Of Ignore Files19787 -Node: Installing Packages21385 -Ref: tree folding21947 -Ref: Tree unfolding23825 -Node: Deleting Packages25893 -Ref: tree refolding26925 -Ref: Deleting Packages-Footnote-127470 -Node: Conflicts28058 -Ref: Deferred Operation29044 -Node: Mixing Operations29645 -Node: Multiple Stow Directories30637 -Node: Target Maintenance31697 -Node: Resource Files32927 -Node: Compile-time vs Install-time34533 -Node: GNU Emacs37943 -Ref: GNU Emacs-Footnote-138928 -Node: Other FSF Software38992 -Node: Cygnus Software39753 -Node: Perl and Perl 5 Modules41232 -Node: Bootstrapping44787 -Node: Reporting Bugs45568 -Node: Known Bugs46547 -Node: GNU General Public License46795 -Node: Index65935 +Node: Top1427 +Node: Introduction3088 +Ref: Introduction-Footnote-16570 +Ref: Introduction-Footnote-26679 +Ref: Introduction-Footnote-36777 +Node: Terminology6854 +Node: Invoking Stow9349 +Node: Ignore Lists17276 +Node: Motivation For Ignore Lists17540 +Node: Types And Syntax Of Ignore Lists19071 +Ref: Types And Syntax Of Ignore Lists-Footnote-122368 +Ref: Types And Syntax Of Ignore Lists-Footnote-222534 +Ref: Types And Syntax Of Ignore Lists-Footnote-322778 +Node: Justification For Yet Another Set Of Ignore Files22927 +Node: Installing Packages24542 +Ref: tree folding25104 +Ref: Tree unfolding27102 +Node: Deleting Packages29241 +Ref: tree refolding30304 +Ref: Deleting Packages-Footnote-130853 +Node: Conflicts31449 +Ref: Deferred Operation32439 +Node: Mixing Operations33039 +Node: Multiple Stow Directories34031 +Node: Target Maintenance35115 +Node: Resource Files36398 +Node: Compile-time vs Install-time38993 +Node: GNU Emacs42502 +Ref: GNU Emacs-Footnote-143491 +Node: Other FSF Software43555 +Node: Cygnus Software44336 +Node: Perl and Perl 5 Modules45847 +Node: Bootstrapping49476 +Node: Reporting Bugs50285 +Node: Known Bugs51300 +Node: GNU General Public License51560 +Node: Index89114  End Tag Table + + +Local Variables: +coding: utf-8 +End: diff --git a/local/share/man/man8/stow.8 b/local/share/man/man8/stow.8 index ff4542f..780d997 100644 --- a/local/share/man/man8/stow.8 +++ b/local/share/man/man8/stow.8 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" 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' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .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\} @@ -46,7 +30,7 @@ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" -.\" If the F register is turned on, we'll generate index entries on stderr for +.\" If the F register is >0, 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. @@ -56,122 +40,61 @@ .. .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 "IO::FILE=IO(0X81D9F0) 1" -.TH IO::FILE=IO(0X81D9F0) 1 "2015-11-09" "perl v5.20.1" "User Contributed Perl Documentation" +.IX Title "stow 8" +.TH stow 8 2023-10-23 "perl v5.38.0" "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 \- software package installation manager -.SH "SYNOPSIS" +.SH NAME +stow \- manage farms of symbolic links +.SH SYNOPSIS .IX Header "SYNOPSIS" stow [ options ] package ... -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -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. +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. .PP -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. +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. .PP -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. +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. .PP Stow was inspired by Carnegie Mellon's Depot program, but is substantially simpler and safer. Whereas Depot required database files @@ -181,38 +104,41 @@ 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). -.SH "TERMINOLOGY" +.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 .IX Header "TERMINOLOGY" -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., +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., with \fIbin\fR, \fIlib\fR, and \fIman\fR subdirectories. .PP -A \*(L"target directory\*(R" is the root of a tree in which one or more +A "target directory" 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 \*(L"stow directory\*(R" is the root of a tree containing separate +A "stow directory" 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 \*(L"installation image\*(R" is the layout of files and directories +An "installation image" 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 \*(L"package directory\*(R" is the root of a tree containing the +A "package directory" 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 \*(L"name\*(R" of a package is the name of its -directory within the stow directory \*(-- e.g., \fIperl\fR. +\&\fI/usr/local/stow\fR. The "name" 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 @@ -220,13 +146,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 \*(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 +A "symlink" is a symbolic link. A symlink can be "relative" or +"absolute". 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 @@ -236,69 +162,71 @@ 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 \s-1DIR\s0" 4 +.IP "\-d DIR" 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 \s-1DIR\s0" 4 +.IP "\-t DIR" 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 0, 1, 2, 3, and 4; 0 is the default. +doing. Verbosity levels are from 0 to 5; 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 @@ -312,32 +240,47 @@ 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 "\-V" 4 +.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 .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. @@ -360,8 +303,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 \*(L"tree folding\*(R", since an entire -subtree is \*(L"folded\*(R" into a single symlink. +have been created. This is called "tree folding", since an entire +subtree is "folded" 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 @@ -383,7 +326,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 \*(L"splitting open\*(R" +in its installation image. This operation is called "splitting open" 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 @@ -405,34 +348,55 @@ 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 \*(L"owns\*(R" everything living in the target tree that points into a +Stow "owns" 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 \*(L"own\*(R" anything +lost. Note that by this definition, Stow doesn't "own" 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 \*(L"Conflicts\*(R" section in the +Stow, then a conflict has arisen. See the "Conflicts" 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 \*(L"own\*(R". Deleting a package does \fBnot\fR mean removing it from +it doesn't "own". 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 -\&\*(L"Multiple stow directories\*(R" in the info manual). Any symlink it +"Multiple stow directories" 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 \*(L"folded\*(R" tree that was \*(L"split open.\*(R" +considered to be a previously "folded" tree that was "split open." 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. @@ -443,46 +407,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 \*(L"split open\*(R" and the contents +when stowing, \fItargetdir/bar\fR will be "split open" 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 \*(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 +.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 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 \*(L"learn\*(R" about the cooperating stow directory to +finds one, it can "learn" 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 \s-1POD\s0 format by Adam +parts of Stow's info manual, and then converted to POD 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 \*(L"\s-1GNU\s0 General Public License\*(R" can be found in the file +entitled "GNU General Public License" 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 \s-1GPL\s0 is not there, +you don't have access to a Debian system, or the GPL is not there, write to the Free Software Foundation, Inc., 59 Temple Place, Suite -330, Boston, \s-1MA, 02111\-1307, USA.\s0 -.SH "COPYRIGHT" +330, Boston, MA, 02111\-1307, USA. +.SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (C) 1993, 1994, 1995, 1996 by Bob Glickstein ; @@ -497,7 +461,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 \*(L"\s-1GNU\s0 General Public License\*(R" is included with the +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.