Skip to content

Commit

Permalink
docs(manpage): Elaborate --dry-run and --verbose
Browse files Browse the repository at this point in the history
  • Loading branch information
hirak99 committed Jan 4, 2025
1 parent 27adeee commit a49fbf5
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion artifacts/yabsnap.manpage
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,18 @@ View the inbuilt help.

View the inbuilt help for a particular command.

.SS yabsnap --verbose ...

Enables info loging to trace certain parts of the code on the terminal.

.SS yabsnap --dry-run ...

Applicable to commands which create or delete snapshots.

.SS yabsnap --sync ...

Returns only after all btrfs operations finish.
Applicable to commands which create or delete snapshots.

.SS yabsnap --config-file CONFIG-FILE ...

Expand Down Expand Up @@ -66,7 +75,7 @@ delete /.snapshots/@root-20221006183032`, or specify just the suffix, e.g.
`yabsnap delete 20221006183032`. If you specify just the suffix, it will delete
matching snapshots from all configs.

.SS yabsnap batch-delete [--start TIMESTAMP] [--end TIMESTAMP] [--indicator S|I|U]
.SS yabsnap [--dry-run] [--sync] batch-delete [--start TIMESTAMP] [--end TIMESTAMP] [--indicator S|I|U]

Batch delete snapshots. All snaps with start <= snap.time < end, optionally
matching the `--indicator` will be deleted. Matching snapshots will be displayed
Expand Down

0 comments on commit a49fbf5

Please sign in to comment.