Skip to content

Commit

Permalink
Merge pull request #21 from fuchs-fabian/14-update-the-images-in-the-…
Browse files Browse the repository at this point in the history
…readme-file-and-customise-the-examples-with-the-notifier

14 update the images in the readme file and customise the examples with the notifier
  • Loading branch information
fuchs-fabian authored Dec 1, 2024
2 parents c2ee608 + 1ce608f commit c78f36a
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 3 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -365,10 +365,20 @@ Usage: (sudo) simbashlog

### Console output

> **Note**: There is an internal `simbashlog` warning, because the `simbashlog-example-notifier` is not installed.
![normal usage console output](./images/normal-usage-console-ouput.png)

### System log content

Command with `journalctl`:

```bash
journalctl -t <tag>
```

Replace `<tag>` with the actual tag from the `simbashlog` **summary**.

![normal usage system log content](./images/normal-usage-system-log-content.png)

### `.log` file
Expand Down
2 changes: 1 addition & 1 deletion examples/advanced-usage.bash
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ ENABLE_GUI_POPUPS_FOR_LOGGING_NOTIFICATIONS=false
LOG_POPUP_NOTIFICATION_WINDOW_WIDTH=500
LOG_POPUP_NOTIFICATION_WINDOW_HEIGHT=100

SIMBASHLOG_NOTIFIER="example-notifier.py" # This notifier does not exist -> Supported notifiers: https://github.com/fuchs-fabian/simbashlog-notifiers
SIMBASHLOG_NOTIFIER="simbashlog-example-notifier" # This notifier does not exist -> Supported notifiers: https://github.com/fuchs-fabian/simbashlog-notifiers
SIMBASHLOG_NOTIFIER_CONFIG_PATH=""

ENABLE_SUMMARY_ON_EXIT=true # Default: false
Expand Down
2 changes: 1 addition & 1 deletion examples/normal-usage.bash
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ ENABLE_PARENT_SCRIPT_NAME_IN_CONSOLE_OUTPUTS_FOR_LOGGING=false

ENABLE_GUI_POPUPS_FOR_LOGGING_NOTIFICATIONS=false

SIMBASHLOG_NOTIFIER="example-notifier.py" # This notifier does not exist -> Supported notifiers: https://github.com/fuchs-fabian/simbashlog-notifiers
SIMBASHLOG_NOTIFIER="simbashlog-example-notifier" # This notifier does not exist -> Supported notifiers: https://github.com/fuchs-fabian/simbashlog-notifiers
SIMBASHLOG_NOTIFIER_CONFIG_PATH=""

ENABLE_SUMMARY_ON_EXIT=true # Default: false
Expand Down
Binary file modified images/normal-usage-console-ouput.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/normal-usage-json-log-file-content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/normal-usage-log-file-content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/normal-usage-system-log-content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/simbashlog.bash
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
#
# e.g.:
# ```bash
# ./simbashlog.bash -a json -s error --message "An error occured" --notifier example-simbashlog-notifier.py
# ./simbashlog.bash -a json -s error --message "An error occured" --notifier simbashlog-example-notifier
# ```
#
# To summarize briefly:
Expand Down

0 comments on commit c78f36a

Please sign in to comment.