Skip to content

Commit

Permalink
minor adjustments in help text
Browse files Browse the repository at this point in the history
  • Loading branch information
striezel committed Jan 31, 2025
1 parent 8dc1bbb commit f3daa83
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
16 changes: 8 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The updater is a command-line program, there is no graphical user interface yet
Operations or commands define the main action of the program. Only one of
these may be specified. Valid operations are:

* **check** - displays which installed software can be updated, but does not
* **check** - Displays which installed software can be updated, but does not
actually perform the updates. This will display something like

```
Expand Down Expand Up @@ -63,7 +63,7 @@ these may be specified. Valid operations are:
+-------------------------------------+--------+--------------+--------------+---------+
```

* **update** - updates every software that can be updated, i.e. downloads and
* **update** - Updates every software that can be updated, i.e. downloads and
installs new versions / updates. Possible output could be:

```
Expand All @@ -86,18 +86,18 @@ these may be specified. Valid operations are:
2022-11-08 19:13:34 - 2 applications were updated.
```

* **help** - shows a help message.
* **version** - shows version of the program.
* **license** - shows license information for the program.
* **list-id** - prints a list of software IDs to the standard output. These IDs
* **help** - Shows a help message.
* **version** - Shows the version of the program.
* **license** - Shows license information for the program.
* **list-id** - Prints a list of software IDs to the standard output. These IDs
can be used to exclude certain software from updates. See the
option `--exclude` below for more information.

### Options
Options can change behaviour of the update process. Available options are:

--auto-get-newer | --newer | -n
automatically tries to get information about newer versions of the soft-
Automatically tries to get information about newer versions of the soft-
ware from the internet. The updater has a list of known newest software
versions, but that information can get outdated quickly. That is why
this option exists - it helps to get the latest software version.
Expand All @@ -112,7 +112,7 @@ Options can change behaviour of the update process. Available options are:
default timeout is 1800 seconds.
--exclude ID | --except ID | -e ID
Excludes the software with the given ID from the update process. To get
the ID for a specific software, run the program with the --list-id
the ID for a specific software, run the program with the list-id
option which lists all software IDs. You can use this option several
times to exclude more than one software from the update process.
--show-progress | --progress | -p
Expand Down
18 changes: 9 additions & 9 deletions updater/operations/Help.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
This file is part of the updater command line interface.
Copyright (C) 2017, 2018, 2024 Dirk Stolle
Copyright (C) 2017, 2018, 2024, 2025 Dirk Stolle
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand Down Expand Up @@ -32,22 +32,22 @@ public int perform()
+ " Operations or commands define the main action of the program. Only one of\r\n"
+ " these may be specified. Valid operations are:" + Environment.NewLine
+ Environment.NewLine
+ " check - displays which installed software can be updated, but does not\r\n"
+ " check - Displays which installed software can be updated, but does not\r\n"
+ " actually perform the updates." + Environment.NewLine
+ " update - updates every software that can be updated, i.e. downloads and\r\n"
+ " update - Updates every software that can be updated, i.e. downloads and\r\n"
+ " installs new versions / updates." + Environment.NewLine
+ " help - shows this help message." + Environment.NewLine
+ " version - shows version of the program." + Environment.NewLine
+ " license - shows license information for the program." + Environment.NewLine
+ " list-id - prints a list of software IDs to the standard output. These IDs\r\n"
+ " help - Shows this help message." + Environment.NewLine
+ " version - Shows the version of the program." + Environment.NewLine
+ " license - Shows license information for the program." + Environment.NewLine
+ " list-id - Prints a list of software IDs to the standard output. These IDs\r\n"
+ " can be used to exclude certain software from updates. See the\r\n"
+ " option --exclude below for more information.\r\n"
+ Environment.NewLine
+ "Options:" + Environment.NewLine
+ " Options can change behaviour of the update process. Available options are:\r\n"
+ Environment.NewLine
+ " --auto-get-newer | --newer | -n" + Environment.NewLine
+ " automatically tries to get information about newer versions of the soft-\r\n"
+ " Automatically tries to get information about newer versions of the soft-\r\n"
+ " ware from the internet. The updater has a list of known newest software\r\n"
+ " versions, but that information can get outdated quickly. That is why\r\n"
+ " this option exists - it helps to get the latest software version.\r\n"
Expand All @@ -62,7 +62,7 @@ public int perform()
+ " default timeout is " + Update.defaultTimeout.ToString() + " seconds.\r\n"
+ " --exclude ID | --except ID | -e ID" + Environment.NewLine
+ " Excludes the software with the given ID from the update process. To get\r\n"
+ " the ID for a specific software, run the program with the --list-id\r\n"
+ " the ID for a specific software, run the program with the list-id\r\n"
+ " option which lists all software IDs. You can use this option several\r\n"
+ " times to exclude more than one software from the update process.\r\n"
+ " --show-progress | --progress | -p" + Environment.NewLine
Expand Down

0 comments on commit f3daa83

Please sign in to comment.