backly/README.md

36 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2018-06-29 22:29:09 -04:00
# backly
A simple directory cloner
## About backly
2015-02-10 21:11:15 -05:00
backly is a simple rsync-like tool for recursively copying entire directories.
The intended use case is for making verionless incremental backups; however, it
can be used to copy the contents of any directory to any other directory,
provided you have read access to the source and write access to the
destination. Like rsync, backly uses a combination of file size and
modification date to determine if it needs to be copied over.
2018-06-29 22:29:09 -04:00
This program will **not** work properly if source is a subdirectory
2015-02-10 21:11:15 -05:00
or destination or vice-versa.
2018-06-29 22:29:09 -04:00
## Required packages
2015-02-10 21:11:15 -05:00
backly does not depend on any packages other than what typically ships with any
Linux distribution.
2018-06-29 22:29:09 -04:00
## Installation
2015-02-10 21:11:15 -05:00
2018-06-29 22:29:09 -04:00
The usual `make` and `make install` is sufficient for compiling and installing
backly. The default prefix is `/usr/local`, which means the binary will be
installed to `/usr/local/bin`. The prefix can be changed by setting it in the
install command; for example, by running `make PREFIX=/usr install`.
2015-02-10 21:11:15 -05:00
2018-06-29 22:29:09 -04:00
## How to report bugs?
2015-02-10 21:11:15 -05:00
2018-06-29 22:29:09 -04:00
Open an issue on the issue tracker.
2015-02-10 21:11:15 -05:00
Please indicate what OS and architecture you are using, as well as output from
2018-06-29 22:29:09 -04:00
the program showing the bug, if possible (hint: run backly with `--test` to
avoid destroying any files that you care about).