Skip to content

Commit 25311a6

Browse files
committed
improve documentation
1 parent e7085c4 commit 25311a6

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ have to be sent.
2020

2121
snapper is required.
2222

23-
2423
## Options
2524

2625
Usage: snap-sync [options]
@@ -35,6 +34,13 @@ snapper is required.
3534
-u, --UUID <UUID> Specify the UUID of the mounted BTRFS subvolume to back up to. Otherwise will prompt.
3635
If multiple mount points are found with the same UUID, will prompt user.
3736

37+
## First run
38+
39+
When you run `snap-sync` you will be prompted to choose a disk to back up to.
40+
The first time you run `snap-sync` for a particular disk (new UUID) you will be
41+
prompted to choose a backup location on that disk. If the directory you specify
42+
does not exist, it will be created.
43+
3844
## Systemd unit and timer
3945

4046
A systemd unit and timer are included. These are instantiated units. You need to
@@ -47,7 +53,9 @@ place. Example:
4753
The timer included is weekly. Edit both files to your taste.
4854

4955
You can exclude a configuration from backup by setting `SNAP_SYNC_EXCLUDE=yes`
50-
in your snapper configuration file.
56+
in your snapper configuration file. Additionally you should run snap-sync at
57+
least once for a new disk without using the service so you can be prompted for
58+
the backup location.
5159

5260
## Example command line usage
5361

@@ -90,6 +98,8 @@ to be sent.
9098

9199
### With UUID specified and no confirmations
92100

101+
This is essentially what the systemd service does.
102+
93103
# snap-sync --UUID 7360922b-c916-4d9f-a670-67fe0b91143c --noconfirm
94104
You selected the disk with UUID 7360922b-c916-4d9f-a670-67fe0b91143c.
95105
The disk is mounted at /run/media/wes/backup.

0 commit comments

Comments
 (0)