Skip to content

Commit

Permalink
tiny tweaks to docs (noticed during pash retreat) (#124)
Browse files Browse the repository at this point in the history
Merging even though the vagrant checks are failing---something is borked in our runners.
  • Loading branch information
mgree authored Oct 19, 2023
1 parent da18845 commit 91352e7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
26 changes: 13 additions & 13 deletions docs/try.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@ While using *try* you can choose to commit the result to the filesystem or compl

-n

: Don't prompt for commit. Just return the overlay directory.
: Don't commit or prompt for commit. Just return the overlay directory. Overrides -y.

-y

: Assume yes to all prompts (implies -n is not used)
: Assume yes to all prompts. Overrides -n.

-v

: Show version information (and exit)
: Show version information (and exit).

-h

: Show a usage message (and exit)
: Show a usage message (and exit).


## Options
Expand All @@ -57,39 +57,39 @@ This option is recommended in case OverlayFS fails.

try summary *DIR*

: Show the summary for the overlay in *DIR*
: Show the summary for the overlay in *DIR*.

try commit *DIR*

: Commit the overlay in *DIR*
: Commit the overlay in *DIR*.

try explore

: Run in interactive mode
: Run in interactive mode, i.e., start a shell in the overlay.

## Arguments

*CMD*

: Specifies the command to execute inside the overlay
: Specifies the command to execute inside the overlay.

*ARG*

: The arguments of *CMD*
: The arguments of *CMD*.

# EXIT STATUS

0

: Command ran successfully
: Command ran successfully.

1

: Consistency error/failure
: Consistency error/failure.

2

: Input error
: Input or other internal error.

# EXAMPLES

Expand Down Expand Up @@ -138,7 +138,7 @@ try commit try_dir

# SEE ALSO

checkinstall(1), chroot(1), unshare(1)
checkinstall(1), chroot(1), unshare(1), mount_namespaces(7), namespaces(7), mount(8)

# BUGS

Expand Down
4 changes: 2 additions & 2 deletions try
Original file line number Diff line number Diff line change
Expand Up @@ -478,8 +478,8 @@ usage() {
cat >&2 <<EOF
Usage: $TRY_COMMAND [-nvhy] [-i PATTERN] [-D DIR] [-U PATH] CMD [ARG ...]
-n don't prompt for commit
-y assume yes to all prompts (implies -n is not used)
-n don't commit or prompt for commit (overrides -y)
-y assume yes to all prompts (overrides -n)
-i PATTERN ignore paths that match PATTERN on summary and commit
-D DIR work in DIR (implies -n)
-U PATH path to unionfs helper (e.g., mergerfs, unionfs-fuse)
Expand Down

0 comments on commit 91352e7

Please sign in to comment.