Update README.md

Added planned features and license
This commit is contained in:
Jarno Rankinen 2020-08-02 22:01:49 +03:00 committed by GitHub
parent c639801fbc
commit 1bc7e6d596
1 changed files with 13 additions and 0 deletions

View File

@ -13,3 +13,16 @@ Btrfs snapshot managing bash script
- Taking snapshots requires root priviledges. Take a snapshot with `snapsh -s SUBVOLUME` or `snapsh --snapshot SUBVOLUME`, where `SUBVOLUME` is the name of the source subvolume. You can add a description for the snapshot with the `-d | --description` option (must be used before the `-s` option)<br><br>Example with Fedora default btrfs layout with `root` and `home` subvolumes: <br> `snapsh -d "This is a snapshot" -s root` <br> This will create a snapshot called `root_snapshot_YYYY.MM.DD-hh:mm:ss` to the `snapshots` subvolume (or the one you defined with `SNAPSHOTS_LOCATION`), with a description "This is a snapshot"
- Snapshots can be listed with `snapsh -l` or `snapsh --list`
- Delete snapshots with the `-r` or `--remove` option. List snapshots first with `snapsh -l`, then delete snapshot with e.g. `snapsh -r 2`, where 2 is the number of the deletable snapshot in the `-l` listing. The list numbers always start from 1 and increment from there, so always check the number before deletion. Batch deletion might be implemented later.
### Planned features:
- separate config file
- `--install` option to integrate script into system
- Batch deletion of snapshots
- `systemd` timer for automating snapshots
- `--auto` option (quiet) for automated snapshots
- Option to snapshot multiple/all subvolumes
Root access is required for `btrfs-progs`.
### License:
GPL v3.0