Updated documentation

This commit is contained in:
Marco Cetica 2023-03-16 11:43:14 +01:00
parent 126efbc5ab
commit 72ed442f01
No known key found for this signature in database
GPG Key ID: 0EE8E2CF315D6F8E
6 changed files with 8 additions and 8 deletions

View File

@ -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

View File

@ -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

View File

@ -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:

2
man.md
View File

@ -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:
```

View File

@ -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() {