Skip to content

Commit

Permalink
Rename program borg -> borg-wrapper to avoid confusion with borg itself
Browse files Browse the repository at this point in the history
  • Loading branch information
Twi1ightSparkle committed Nov 27, 2022
1 parent 3298683 commit 0cdd98d
Show file tree
Hide file tree
Showing 24 changed files with 47 additions and 47 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,7 @@ to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
Copyright (C) 2022 Twilight Sparkle

This program is free software: you can redistribute it and/or modify
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Borg backup runner
# Borg wrapper

<!--
Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
Copyright (C) 2022 Twilight Sparkle
This program is free software: you can redistribute it and/or modify
Expand All @@ -28,8 +28,8 @@ Borg documentation: <https://borgbackup.readthedocs.io/en/stable/>
- Copy the `sample.config` directory to `config`
- Edit `config/borg.env` and add your config options
- Edit `exclude.txt` and `include.txt` with your requirements. One entry per line
- From the root of the repo, run `./borg.sh --init` to initialize the repo
- Use crontab (or the scheduler of your choice) to run `./borg.sh --backup --automated --live` periodically
- From the root of the repo, run `./borg-wrapper.sh --init` to initialize the repo
- Use crontab (or the scheduler of your choice) to run `./borg-wrapper.sh --backup --automated --live` periodically
- If you need to run multiple profiles, you can use the `--config` option to specify a different config directory

See [src/help.sh](https://github.com/Twi1ightSparkle/borg/blob/main/src/help.sh) for all command line options.
Expand Down
4 changes: 2 additions & 2 deletions borg.sh → borg-wrapper.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand All @@ -16,7 +16,7 @@
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.

PROGRAM_NAME="Borg backup runner"
PROGRAM_NAME="Borg wrapper"
PROGRAM_VERSION="0.2.0-beta"
export PROGRAM_NAME
export PROGRAM_VERSION
Expand Down
2 changes: 1 addition & 1 deletion hookshot_webhook_js_transformation.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
Copyright (C) 2022 Twilight Sparkle
This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion sample.config/borg.env
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion sample.config/exclude.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion sample.config/include.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/borg_backup.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/borg_check.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/borg_compact.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/borg_delete.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/borg_diff.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/borg_info.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/borg_init.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/borg_list.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/borg_mount.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/borg_prune.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/borg_unmount.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/gen_export.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
8 changes: 4 additions & 4 deletions src/help.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand All @@ -22,7 +22,7 @@ print_help() {
cat <<EOF
$PROGRAM_NAME
Usage: ./borg.sh <command> [options] [backup_name]
Usage: ./borg-wrapper.sh <command> [options] [backup_name]
commands:
-b, --backup Create new backup
Expand Down Expand Up @@ -58,7 +58,7 @@ Dry-run mode:
--prune
Additional documentation in the README.md file or at
https://github.com/twi1ightsparkle/borg
https://github.com/Twi1ightSparkle/borg-wrapper
Maintained by Twilight Sparkle
Version $PROGRAM_VERSION
Expand Down
4 changes: 2 additions & 2 deletions src/index.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/parse_args.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/set_vars.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down
4 changes: 2 additions & 2 deletions src/utils.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

# This script cannot be run on it's own. From the repo root, run ./borg.sh
# This script cannot be run on it's own. From the repo root, run ./borg-wrapper.sh

# Borg backup runner. An (almost) no-dependency wrapper script for basic Borg backup features.
# Borg wrapper. An (almost) no-dependency wrapper script for basic Borg backup features.
# Copyright (C) 2022 Twilight Sparkle
#
# This program is free software: you can redistribute it and/or modify
Expand Down

0 comments on commit 0cdd98d

Please sign in to comment.