From 72ed442f019c26fea0f949935e353a68803ee188 Mon Sep 17 00:00:00 2001 From: Marco Cetica Date: Thu, 16 Mar 2023 11:43:14 +0100 Subject: [PATCH] Updated documentation --- Makefile | 4 ++-- README.md | 4 ++-- backup.sh.1 | 4 ++-- man.md | 2 +- backup_sources.bk => sources.bk | 0 tests.sh | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) rename backup_sources.bk => sources.bk (100%) diff --git a/Makefile b/Makefile index d7f5647..60d8ee9 100644 --- a/Makefile +++ b/Makefile @@ -4,12 +4,12 @@ all: install: mkdir -p /usr/local/share/man/man1 cp -R backup.sh /usr/local/bin/backup.sh - cp -R backup_sources.bk /usr/local/etc/backup_sources.bk + cp -R sources.bk /usr/local/etc/sources.bk cp -R backup.sh.1 /usr/local/share/man/man1/backup.sh.1 chmod 755 /usr/local/bin/backup.sh chmod 644 /usr/local/etc/backup_sources.bk uninstall: rm -rf /usr/local/bin/backup.sh - rm -ff /usr/local/etc/backup_sources.bk + rm -ff /usr/local/etc/sources.bk rm -rf /usr/local/share/man/man1/backup.sh.1 diff --git a/README.md b/README.md index 520fa3d..005d3ef 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Alternatively, you can install the script, the default sources file and the man ```sh $> sudo make install ``` -This will copy `backup.sh` into `/usr/local/bin/backup.sh`, `backup_sources.bk` into `/usr/local/etc/backup_sources.bk` and +This will copy `backup.sh` into `/usr/local/bin/backup.sh`, `sources.bk` into `/usr/local/etc/sources.bk` and `backup.sh.1` into `/usr/local/share/man/man1/backup.sh.1`. To uninstall the program along with the sample _sources file_ and the manual page, you can issue `sudo make uninstall`. @@ -67,7 +67,7 @@ the _sources file_, **should not** includes: - Empty lines; - Comments. -You can find a sample _sources file_ at `backup_sources.bk`(or at `/usr/local/etc/backup_sources.bk`). +You can find a sample _sources file_ at `sources.bk`(or at `/usr/local/etc/sources.bk`). After having defined the _sources file_, you can invoke `backup.sh` using the following syntax: ```sh diff --git a/backup.sh.1 b/backup.sh.1 index d2e76fd..8c72a90 100644 --- a/backup.sh.1 +++ b/backup.sh.1 @@ -99,8 +99,8 @@ In particular, the sources file, \f[I]should not\f[R] includes: \f[R] .fi .PP -You can find a sample sources file at \f[V]backup_sources.bk\f[R](or at -\f[V]/usr/local/etc/backup_sources.bk\f[R]). +You can find a sample sources file at \f[V]sources.bk\f[R](or at +\f[V]/usr/local/etc/sources.bk\f[R]). .PP After having defined the sources file, you can invoke \f[B]backup.sh\f[R] using the following syntax: diff --git a/man.md b/man.md index 7ed8146..e898fd2 100644 --- a/man.md +++ b/man.md @@ -63,7 +63,7 @@ In particular, the sources file, _should not_ includes: - Empty lines; - Comments. -You can find a sample sources file at `backup_sources.bk`(or at `/usr/local/etc/backup_sources.bk`). +You can find a sample sources file at `sources.bk`(or at `/usr/local/etc/sources.bk`). After having defined the sources file, you can invoke **backup.sh** using the following syntax: ``` diff --git a/backup_sources.bk b/sources.bk similarity index 100% rename from backup_sources.bk rename to sources.bk diff --git a/tests.sh b/tests.sh index 31cbe8c..f1af220 100755 --- a/tests.sh +++ b/tests.sh @@ -51,7 +51,7 @@ create_files() { } execute_backup() { - ./backup.sh -b backup_sources.bk "$PWD" badpw + ./backup.sh -b sources.bk "$PWD" badpw } extract_backup() {