Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
elesiuta committed Feb 23, 2020
1 parent e67ba62 commit 0fc38d5
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# BackuPy
## Quick Start
```
pip install backupy
backupy -h
```
## Installation
- Install the latest version from PyPI
```
Expand Down Expand Up @@ -129,7 +134,7 @@ optional arguments:
- force_posix_path_sep
- always use a forward slash in paths, useful for keeping the same database on a drive shared between multiple operating systems, default = False
- set_blank_crc_on_copy
- normally database entries are copied along with files, this removes the CRC from the copied entry forcing it to calculate and check the CRC on the next run to ensure a successful copy (with ATTR+, CRC mode would calculate it regardless), default = False
- normally database entries are copied along with files, this removes the CRC from the copied entry forcing BackuPy to calculate and check the CRC on the next run (with ATTR+) to ensure the copy was successful (CRC mode would calculate and check it regardless, but takes much longer since it would also recheck every file), default = False
- quit_on_db_conflict
- causes the run to automatically abort if there is any unexpected file modifications, sync conflicts, or file corruption detected, recommended if running with noprompt, default = False
## Building From Source
Expand Down

0 comments on commit 0fc38d5

Please sign in to comment.