Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document -g option #38

Merged
merged 1 commit into from
Mar 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,20 @@ directory, creating subdirectories as necessary.

```bash
$ stowsh -h
Usage: stowsh [-D] [-n] [-s] [-v[v]] [-t TARGET] PACKAGES...
Usage: stowsh [-D] [-n] [-s] [-g] [-v[v]] [-t TARGET] PACKAGES...
```

`TARGET` is the destination directory (current directory by default).

- `-D` uninstall a package
- `-D` uninstall package(s)
- `-n` dry-run (print what would happen, but don't do anything)
- `-v` verbose (`-vv` is even more verbose)
- `-g` ignore files that are not tracked by git (uses `git ls-files`)
- `-s` skip (skip errors rather than abort)

When installing a package `stowsh` will never overwrite existing files. When
unsintalling a package `stowsh` will never delete files that are not symlinks
to the expected place in the package.
unsintalling a package `stowsh` will never delete files that are not symlinks to
the expected place in the package.

By default `stowsh` will abort without making _any_ changes if either of these
errors occurs. This is done to avoid being left with a broken half installed
Expand Down
2 changes: 1 addition & 1 deletion stowsh
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ stowsh_uninstall() {
}

stowsh_help() {
echo "Usage: $0 [-D] [-n] [-s] [-v[v]] [-t TARGET] PACKAGES..."
echo "Usage: $0 [-D] [-n] [-s] [-g] [-v[v]] [-t TARGET] PACKAGES..."
}

if [ "$0" = "$BASH_SOURCE" ]; then
Expand Down