Commit graph

41 commits

Author SHA1 Message Date
Adam Spiers
3aa30ae1aa 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 :-/
2019-07-28 13:04:17 +01:00
Adam Spiers
27796720d5 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
2019-06-27 20:37:40 +01:00
Adam Spiers
c2a399985a remove trailing whitespace from lines 2019-06-27 13:54:36 +01:00
Adam Spiers
9c402559d2 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.
2019-06-26 13:46:37 +01:00
Adam Spiers
b4cb6e775a Add Guillaume and myself to the list of @authors 2019-06-26 13:46:37 +01:00
Charles LeDoux
dc42c34107 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
2019-06-25 19:38:43 +01:00
Adam Spiers
c3cbdeb812 Synchronise --verbose documentation
The man page was updated with regard to higher --verbose levels but
not the info manual, so fix that.
2019-06-25 17:41:17 +01:00
Adam Spiers
72ef83cebd 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
2019-06-25 16:52:33 +01:00
Adam Spiers
dd42b09a5b avoid "regex" abbreviation for consistency 2018-02-11 17:55:40 +00:00
Adam Spiers
c84de4eb14 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
2018-02-11 17:55:31 +00:00
Adam Spiers
e7e6c7fbde update the introductory text to clarify Stow's common usage
Thanks to Jean Louis for some suggestions on this.
2018-02-11 11:47:39 +00:00
Adam Spiers
ea11f266a5 fix typo in "Deleting Packages" chapter
Thanks to Hongyi Zhao for spotting this error and reporting it.
2017-03-04 14:29:06 +00:00
Adam Spiers
b160a1c807 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
2016-12-18 23:17:19 +00:00
Adam Spiers
5a8d275c47 replace a "you" typo with better text
The contents are prepended to the arguments; they still come after the
stow executable.
2016-12-18 23:14:39 +00:00
Adam Spiers
29a8b5d4e5 Add more index entries to the manual. 2015-11-09 09:03:49 +00:00
Adam Spiers
e255b27976 Fix a typo in the docs. 2015-11-09 09:03:42 +00:00
Adam Spiers
db784f0a5f Fix typo in manual. 2012-02-19 01:42:10 +00:00
Adam Spiers
037ce9ee8a Add a few more items to index. 2012-02-19 01:42:04 +00:00
Adam Spiers
ed12c787df Add --no-folding option. 2012-02-18 20:33:34 +00:00
Adam Spiers
17d3586e84 Remove -a option for safety reasons (but keep --adopt). 2012-02-18 20:33:34 +00:00
Adam Spiers
1af824908d Last known bug was fixed a long time ago :-) 2012-02-18 20:33:34 +00:00
Adam Spiers
52d7e2f384 Update structure of manual to match recommended texinfo structure.
TOC now appears after title page.
Copying information is no longer duplicated.
2012-02-18 20:33:34 +00:00
Adam Spiers
934ff5e273 Fix various formatting issues in the manual. 2012-02-18 20:20:15 +00:00
Adam Spiers
2ae90481cb Add some more index entries to the manual. 2012-02-18 20:20:13 +00:00
Adam Spiers
c6a45b7c81 Add some @sections to the manual to break larger nodes up. 2012-02-18 20:19:45 +00:00
Adam Spiers
149034de9f Use @command / @samp / @env / @var in the manual where appropriate, rather than @code. 2012-02-18 20:19:44 +00:00
Adam Spiers
2da2f44a20 Fix formatting of regexp values in the manual. 2012-02-18 20:19:44 +00:00
Adam Spiers
7e44666640 Add --adopt / -a option. 2012-01-09 21:29:34 +00:00
Adam Spiers
782836bad7 Improve the footnote which defines 'subpath'. 2011-12-21 11:45:59 +00:00
Adam Spiers
7c90000393 Add another ignore example to the manual and test suite. 2011-12-21 11:45:43 +00:00
Adam Spiers
419e31b4c6 Change @dircategory to `System administration' as suggested by Karl Berry. 2011-12-04 14:57:34 +00:00
Adam Spiers
519566f3f4 Add a missing hyperlink to the Stow homepage. 2011-12-03 16:40:20 +00:00
Adam Spiers
e046048a1c Update reference to maintainer. 2011-12-03 02:07:19 +00:00
Adam Spiers
d5aa061abe Fix documentation regarding splitting of symlinks across multiple stow directories. 2011-11-26 16:34:57 +00:00
Adam Spiers
1f41616b12 Tidy up chkstow code and documentation. 2011-11-26 16:34:57 +00:00
Adam Spiers
a8a0e360ae Add comment to manual about test_examples_in_manual() in t/ignore.t. 2011-11-26 16:34:57 +00:00
Adam Spiers
55d3f05cf2 Ditch obsolete --conflicts option and update misleading documentation. 2011-11-26 16:34:57 +00:00
Adam Spiers
6534b21d29 Tidy up the copyright attributions in the manual. 2011-11-26 16:34:50 +00:00
Adam Spiers
b87ca607ba Fix some minor issues in the manual. 2011-11-26 16:34:50 +00:00
Adam Spiers
ea82ef5b8b Add support for ignore lists. 2011-11-26 16:34:48 +00:00
Adam Spiers
58625800ee Reorganise more files into subdirectories and add CPAN support via Module::Build 2011-11-26 15:10:26 +00:00
Renamed from stow.texi (Browse further)