borgmatic-collective/borgmatic
borgmatic-collective
/
borgmatic
14
58
Fork 42
Code Issues 58 Pull Requests 3 Actions Packages Releases 122 Activity

Integrate colorama for coloured output #164

Merged
witten merged 5 commits from :feature/coloured-output-first-step into master 2019-05-13 19:50:37 +00:00
Conversation 4 Commits 5 Files Changed 18 +6
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 0320d449ec - Show all commits

6
docs/how-to/set-up-backups.md
View File

@ -179,6 +179,12 @@ sudo systemctl start borgmatic.timer
Feel free to modify the timer file based on how frequently you'd like
borgmatic to run.
## Colored Output
Borgmatic uses [colorama](https://pypi.org/project/colorama/) to produce
colored terminal output by default. It is disabled when a non-interactive
terminal is detected (like a cron job). Otherwise, it can be disabled by
witten commented 2019-05-13 00:10:23 +00:00
Outdated
Review
Copy Link

Given that borgmatic is used so often from cron jobs, a reader's first reaction might be: "Wait.. Does that mean I need to specify --no-colour if I want to call borgmatic from a cron job?" To get ahead of that concern, it might be good to state here that the "by default" color won't happen on a non-interactive terminal (like a cron job).

Given that borgmatic is used so often from cron jobs, a reader's first reaction might be: "Wait.. Does that mean I need to specify `--no-colour` if I want to call borgmatic from a cron job?" To get ahead of that concern, it might be good to state here that the "by default" color won't happen on a non-interactive terminal (like a cron job).
passing `--no-color` or by setting the environment variable `PY_COLORS=False`.
## Troubleshooting