You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[Support and Contributions](#support-and-contributions)
43
43
-[How to Contribute](#how-to-contribute)
44
44
-[Development Setup](#development-setup)
45
45
-[Code Style](#code-style)
@@ -51,7 +51,7 @@ It works on Linux, macOS, and Windows (via WSL or Cygwin). The main advantage ov
51
51
52
52
<!-- SECTION:features:START -->
53
53
54
-
## :star2:Features
54
+
## Features
55
55
56
56
* 📁 Each backup is in its own folder named after the current timestamp.
57
57
* 🔒 Backup to/from remote destinations over SSH.
@@ -64,7 +64,7 @@ It works on Linux, macOS, and Windows (via WSL or Cygwin). The main advantage ov
64
64
65
65
<!-- SECTION:features:END -->
66
66
67
-
## :books:Usage
67
+
## Usage
68
68
69
69
To use `rsync-time-machine.py`, you'll need to provide source and destination paths, along with any desired options:
70
70
@@ -148,7 +148,7 @@ Please refer to the original [`rsync-time-backup`](https://github.com/laurent22/
148
148
149
149
<!-- SECTION:installation:START -->
150
150
151
-
## :hammer_and_wrench: Installation
151
+
## Installation
152
152
153
153
To install `rsync-time-machine.py`, simply clone the repository:
154
154
@@ -169,7 +169,7 @@ and use it like `./rsync_time_machine.py --help`
169
169
170
170
<!-- SECTION:examples:START -->
171
171
172
-
## :bulb: Examples
172
+
## Examples
173
173
174
174
* Backup the home folder to backup_drive:
175
175
@@ -189,15 +189,15 @@ For more examples and detailed usage instructions, please refer to the original
189
189
190
190
<!-- SECTION:expiration:START -->
191
191
192
-
## :calendar: Backup Expiration Logic
192
+
## Backup Expiration Logic
193
193
194
194
Backup sets are automatically deleted following a simple expiration strategy defined with the `--strategy` flag. The default strategy is `1:1 30:7 365:30`. Please see the original README for a detailed explanation.
195
195
196
196
<!-- SECTION:expiration:END -->
197
197
198
198
<!-- SECTION:exclusion:START -->
199
199
200
-
## :page_facing_up: Exclusion File
200
+
## Exclusion File
201
201
202
202
An optional exclude file can be provided as a third parameter, compatible with the `--exclude-from` parameter of rsync.
203
203
@@ -244,31 +244,31 @@ See [this tutorial](https://web.archive.org/web/20230126121643/https://sites.goo
244
244
245
245
<!-- SECTION:lock:START -->
246
246
247
-
## :lock: Built-in Lock
247
+
## Built-in Lock
248
248
249
249
The script is designed so that only one backup operation can be active for a given directory, avoiding conflicts.
250
250
251
251
<!-- SECTION:lock:END -->
252
252
253
253
<!-- SECTION:rsync-options:START -->
254
254
255
-
## :gear: Rsync Options
255
+
## Rsync Options
256
256
257
257
To display, add, or remove rsync options, use the `--rsync-get-flags`, `--rsync-append-flags`, or `--rsync-set-flags` options.
258
258
259
259
<!-- SECTION:rsync-options:END -->
260
260
261
261
<!-- SECTION:no-auto-expire:START -->
262
262
263
-
## :no_entry_sign: No Automatic Backup Expiration
263
+
## No Automatic Backup Expiration
264
264
265
265
Use the `--no-auto-expire` flag to disable the default behavior of purging old backups when out of space.
266
266
267
267
<!-- SECTION:no-auto-expire:END -->
268
268
269
269
<!-- SECTION:restore:START -->
270
270
271
-
## :arrows_counterclockwise: How to Restore
271
+
## How to Restore
272
272
273
273
Restoring files from the backup is simple, as the script creates a backup in a regular directory. You can easily copy the files back to the original directory using a command like:
274
274
@@ -284,7 +284,7 @@ You can also restore files using any file explorer, including Finder on macOS or
284
284
285
285
<!-- SECTION:featured:START -->
286
286
287
-
## :star: Featured on
287
+
## Featured on
288
288
289
289
- the Real Python podcast: [Episode 158: Building Python CI With Docker & Applying for a Hacker Initiative Grant @ 00:26:28](https://realpython.com/podcasts/rpp/158/#t=1588)
290
290
- Y Combinator Hacker News: [Python Port of 600 Line Bash Script: rsync-time-machine.py for Rsync Backups](https://news.ycombinator.com/item?id=35933238) (self-posted)
@@ -294,7 +294,7 @@ You can also restore files using any file explorer, including Finder on macOS or
294
294
295
295
<!-- SECTION:support:START -->
296
296
297
-
## :heart: Support and Contributions
297
+
## Support and Contributions
298
298
299
299
We appreciate your feedback and contributions! If you encounter any issues or have suggestions for improvements, please file an issue on the GitHub repository. We also welcome pull requests for bug fixes or new features.
0 commit comments