Skip to content

Commit 34ca1a0

Browse files
update doc
1 parent eab355f commit 34ca1a0

File tree

3 files changed

+40
-17
lines changed

3 files changed

+40
-17
lines changed

CHANGELOG

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
### v6.2.0
2+
- Add parameters for the last two cmds without parameters (those of the update :))
3+
- Added a kdialog trigger if a list or count cmd has an error
4+
- Added an option to retry a list or count cmd if it has an error (disabled by default)
5+
- Now list and count are refreshed at the end of an update
6+
17
### v6.1.0
28
- A new section is available in the setting if you want to check the debug log
39
- Fix a bug in the "Install all update" button

README.md

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Counts the number of *aur* and *arch* update available (so all the db - extra, c
1010

1111
Refresh each 30 minutes, on click or on the interval you set.
1212

13-
And you can launch an update console via the context menu or the middle click of your mouse !
13+
You can launch an update console via the context menu or the middle click of your mouse !
1414

15-
Custom setting for the update command and for the count command !
15+
Custom setting for ALL the command !
1616

1717
You can choose between a dot or a label if an update is available.
1818

@@ -33,30 +33,33 @@ You can install the widget from :
3333

3434
#### Plasma 6
3535

36-
- place the source (`a2n.archupdate.plasmoid` folder) in `~/.local/share/plasma/plasmoids/`
37-
- download via [the KDE store](https://www.pling.com/p/2134470/)
38-
- [Dl the package via the AUR](https://aur.archlinux.org/packages/kdeplasma-arch-update-notifier-git)
36+
- place the `a2n.archupdate.plasmoid` folder from the latest release in `~/.local/share/plasma/plasmoids/`
37+
- download via [the KDE store](https://www.pling.com/p/2134470/) (install in `~/.local/share/plasma/plasmoids/`)
38+
- [Dl the package via the AUR](https://aur.archlinux.org/packages/kdeplasma-arch-update-notifier-git) (install in `/usr/share/plasma/plasmoids/`)
3939

4040
#### plasma 5
4141

42-
If you want to use this plugin with kde plasma 5 you should use :
42+
If you want to use this plugin with kde plasma 5 you should use:
4343
- ["The new era release" (v4.2)](https://github.com/bouteillerAlan/archupdate/releases/tag/v4.2.1)
4444
- [this version on the pling store](https://www.pling.com/p/1940819/)
4545
- [this version via the AUR](https://aur.archlinux.org/packages/kdeplasma5-arch-update-notifier-git).
4646

47-
#### Dependencies and AUR helper
47+
**Please note that this version is not maintained since the v4.2.**
4848

49-
You need to have the following packages installed on your system:
50-
- [`pacman-contrib`](https://archlinux.org/packages/extra/x86_64/pacman-contrib/)
51-
- [`konsole`](https://archlinux.org/packages/extra/x86_64/konsole/)
52-
- `yay` is used by default for the update and the AUR count. If you want to use another AUR helper you just have to edit the command via the setting window.
49+
#### Dependencies and AUR helper
5350

54-
`kdialog` is used too, but it's not mandatory because it's used just for alerting if `konsole` or `pacman-contrib` is not installed.
51+
You need to have the following packages installed on your system **OR** to edit the settings with your prefered one:
52+
- [`pacman-contrib`](https://archlinux.org/packages/extra/x86_64/pacman-contrib/) is used for the list and count of the main repository.
53+
- [`yay`](https://github.com/Jguer/yay) is used for the list and count of the AUR repository.
54+
- [`konsole`](https://archlinux.org/packages/extra/x86_64/konsole/) is used to launch the cmd for the upgrade.
55+
- [`kdialog`](https://archlinux.org/packages/extra/x86_64/kdialog/) is used too, but it's not mandatory because it's used just for alerting if a cmd throw an error.
5556

5657
## How to have this in my system tray?
5758

5859
Go to the 'System Tray Settings' menu and activate it :)
5960

61+
*in some case you may need to log out / log in to see it in the list*
62+
6063
![screenshot of how to add in the systray](git-assets/img/add-systray.png)
6164

6265
## Configuration
@@ -68,11 +71,14 @@ Go to the 'System Tray Settings' menu and activate it :)
6871
| Command & Debug | | |
6972
| Interval configuration | set the interval between each execution of the update check function | the `updater` is launch each X minutes |
7073
| Debug | Enable the debug mode if set to true | Show each command launch by the plasmoid with `ARCHUPDATE` at the beggining (for regex search) |
74+
| Retry | Enable the retry mode if set to true | Retry the Count or the List cmd if `stderr` is not empty |
7175
| Do not close the terminal at the end | if true add the `--noclose` flag into the `konsole` command | Prevent the console to close at the end of the update command |
7276
| Count ARCH command | The command you want to execute for counting the packages for CORE and EXTRA (default: `checkupdates [pipe] wc -l`) | The `updater` exec this command |
7377
| Count AUR command | The command you want to execute for counting the packages for the other db (default: `yay -Qua [pipe] wc -l`) | The `updater` exec this command |
74-
| Update all command | The command for updating all the package at once | Pass the command to `konsole -e` |
75-
| Update one command | The command for updating one package via the popup | Pass the command to `konsole -e` and add the package name at the end |
78+
| Update all command | The command for updating all the package at once | Pass the command to the Terminal cmd (or the cmd with no close) |
79+
| Update one command | The command for updating one package via the popup | Pass the command to the Terminal cmd (or the cmd with no close) and add the package name at the end |
80+
| Terminal cmd | The command for launching the update all or one cmd | Launch the update cmd and automatically close at the end of it |
81+
| Terminal cmd & no close | The command for launching the update all or one cmd, executed only when "Do not close at the end" is checked | Launch the update cmd and rest open at the end of it |
7682
| Display | | |
7783
| Show a dot in place of the label | Replace the label with a colored dot | If the total count is > than 0 the dot is visible, otherwise nothing is shown (no label, no dot) |
7884
| Custom dot color | If you want to customize the color of the dot | If not checked the dot get the color from your theme via `PlasmaCore.Theme.textColor` |
@@ -87,11 +93,17 @@ Go to the 'System Tray Settings' menu and activate it :)
8793

8894
### Regarding the customization of the commands
8995

90-
Is up to you to double check the command you want to exec.
96+
If you have any problems after modifying the default settings (especially the cmds):
97+
98+
*quoting the ThinkFan repo here*
9199

92-
In no case I'm responsible of anything if your system break due to your command.
100+
> If this program steals your car, kills your horse, smokes your dope or pees on your carpet... too bad, you're on your own.
93101
94-
The program launch the update command with `konsole -e`. So you can test your command or script with `konsole -e "my_command"`.
102+
Is up to you to double check the command you want to exec. In no case I'm responsible of anything if your system break due to your command.
103+
104+
The program launch the update command with `konsole -e` or the cmd that you put in the setting. So you can test your command or script with `konsole -e "my_command"` or the cmd that you put in the settings `mycmd "my_command"`.
105+
106+
For the update command you have a demo of each cmd just between the title of the section and the setting input.
95107

96108
When you update all the packages the default command is: `konsole -e (--noclose) 'yay'` where `noclose` is optional.
97109

@@ -115,6 +127,10 @@ Because this command dosen't sync the DB at the same time so the result is wrong
115127

116128
For that we need to do something like the `-S` flag before and I prefer to use `checkupdates` for that (it's made for it so...).
117129

130+
### Why the `Do not close at the end` option when you can just update the terminal cmd
131+
132+
Because it's easier for people who don't want to update the default option to switch between not closing and closing the terminal at the end of the update.
133+
118134
### Why the update is made with yay and not pacman
119135

120136
Because `yay` cover all the db (core, extra, aur, ...) and `pacman` handle only core and extra.

a2n.archupdate.plasmoid/contents/ui/main.qml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ PlasmoidItem {
4848

4949
onExited: function (cmd, exitCode, exitStatus, stdout, stderr) {
5050
if (isOnDebug) debug.log('ARCHUPDATE - '+plasmoid.id+' - cmd exited: ' + JSON.stringify({cmd, exitCode, exitStatus, stdout, stderr}), stderr !== "")
51+
if (stderr !== '') cmd.exec("kdialog --passivepopup 'Archupdate counter throw " + stderr + " error on cmd: " + cmd + "'")
5152

5253
// handle the result for the count
5354
const cmdIsAur = cmd === plasmoid.configuration.countAurCommand

0 commit comments

Comments
 (0)