[PATCH] functions.pl: Reformat pakfire Usage: text.

[PATCH] functions.pl: Reformat pakfire Usage: text.

[Stephen Cuka]

 - Reformat pakfire Usage: text to make it clearer.

 - Add '-f | --force' to Usage:.

Signed-off-by: Stephen Cuka <stephen@firemypi.org>
---
 src/pakfire/lib/functions.pl | 38 +++++++++++++++++++++---------------
 1 file changed, 22 insertions(+), 16 deletions(-)

diff --git a/src/pakfire/lib/functions.pl b/src/pakfire/lib/functions.pl
index 17b04ad52..2f172c398 100644
--- a/src/pakfire/lib/functions.pl
+++ b/src/pakfire/lib/functions.pl
@@ -111,22 +111,28 @@ sub logger {
 }
 
 sub usage {
-  &Pakfire::message("Usage: pakfire <install|remove> [options] <pak(s)>");
-  &Pakfire::message("               <update> - Contact the servers for new lists of paks.");
-  &Pakfire::message("               <upgrade> - Install the latest version of all paks.");
-  &Pakfire::message("               <list> [installed|notinstalled|upgrade] - Output a list");
-  &Pakfire::message("                 of all, installed, available or upgradeable paks.");
-  &Pakfire::message("               <info> <pak> [<pak> ...] - Output pak metadata.");
-  &Pakfire::message("               <resolvedeps> <pak> [<pak> ...] - Resolve and output pak");
-  &Pakfire::message("                 dependencies.");
-  &Pakfire::message("               <status> - Output a summary of available core upgrades,");
-  &Pakfire::message("                 updates and a required reboot.");
-  &Pakfire::message("");
-  &Pakfire::message("       Global options:");
-  &Pakfire::message("               --non-interactive --> Enables the non-interactive mode.");
-  &Pakfire::message("                                     You won't see any question here.");
-  &Pakfire::message("                              -y --> Short for --non-interactive.");
-  &Pakfire::message("                     --no-colors --> Turns off the wonderful colors.");
+  &Pakfire::message("Usage: pakfire COMMAND [OPTIONS] [PACKAGE ...]");
+  &Pakfire::message("Manage IPFire add-on packages and updates.");
+  &Pakfire::message("PACKAGE:");
+  &Pakfire::message("  one or more add-on package names");
+  &Pakfire::message("COMMAND:");
+  &Pakfire::message("  install      - install one or more packages");
+  &Pakfire::message("  remove       - remove one or more packages");
+  &Pakfire::message("  update       - update the pakfire database");
+  &Pakfire::message("  upgrade      - upgrade all packages to the latest version");
+  &Pakfire::message("  list [installed | notinstalled | upgrade]");
+  &Pakfire::message("               - display a list of installed, notinstalled,");
+  &Pakfire::message("                 upgradeable or all packages");
+  &Pakfire::message("  info         - display metadata for one or more packages");
+  &Pakfire::message("  resolvedeps  - display dependencies for one or more packages");
+  &Pakfire::message("  status       - display pakfire database status,");
+  &Pakfire::message("                 available updates and whether a reboot");
+  &Pakfire::message("                 is required to complete any upgrades");
+  &Pakfire::message("OPTIONS:");
+  &Pakfire::message("  --no-colors             - turn off colors");
+  &Pakfire::message("  -y | --non-interactive  - automatic yes to prompts");
+  &Pakfire::message("  -f | --force            - for the update command, force");
+  &Pakfire::message("                            a pakfire database update");
   &Pakfire::message("");
   exit 1;
 }
-- 
2.43.0

Re: [PATCH] functions.pl: Reformat pakfire Usage: text.

[Michael Tremer]

Hello Stephen,

Thank you. This applied cleanly and I pushed it into next.

What is coming next? :)

-Michael

> On 8 May 2025, at 20:11, Stephen Cuka <stephen@firemypi.org> wrote:
> 
> - Reformat pakfire Usage: text to make it clearer.
> 
> - Add '-f | --force' to Usage:.
> 
> Signed-off-by: Stephen Cuka <stephen@firemypi.org>
> ---
> src/pakfire/lib/functions.pl | 38 +++++++++++++++++++++---------------
> 1 file changed, 22 insertions(+), 16 deletions(-)
> 
> diff --git a/src/pakfire/lib/functions.pl b/src/pakfire/lib/functions.pl
> index 17b04ad52..2f172c398 100644
> --- a/src/pakfire/lib/functions.pl
> +++ b/src/pakfire/lib/functions.pl
> @@ -111,22 +111,28 @@ sub logger {
> }
> 
> sub usage {
> -  &Pakfire::message("Usage: pakfire <install|remove> [options] <pak(s)>");
> -  &Pakfire::message("               <update> - Contact the servers for new lists of paks.");
> -  &Pakfire::message("               <upgrade> - Install the latest version of all paks.");
> -  &Pakfire::message("               <list> [installed|notinstalled|upgrade] - Output a list");
> -  &Pakfire::message("                 of all, installed, available or upgradeable paks.");
> -  &Pakfire::message("               <info> <pak> [<pak> ...] - Output pak metadata.");
> -  &Pakfire::message("               <resolvedeps> <pak> [<pak> ...] - Resolve and output pak");
> -  &Pakfire::message("                 dependencies.");
> -  &Pakfire::message("               <status> - Output a summary of available core upgrades,");
> -  &Pakfire::message("                 updates and a required reboot.");
> -  &Pakfire::message("");
> -  &Pakfire::message("       Global options:");
> -  &Pakfire::message("               --non-interactive --> Enables the non-interactive mode.");
> -  &Pakfire::message("                                     You won't see any question here.");
> -  &Pakfire::message("                              -y --> Short for --non-interactive.");
> -  &Pakfire::message("                     --no-colors --> Turns off the wonderful colors.");
> +  &Pakfire::message("Usage: pakfire COMMAND [OPTIONS] [PACKAGE ...]");
> +  &Pakfire::message("Manage IPFire add-on packages and updates.");
> +  &Pakfire::message("PACKAGE:");
> +  &Pakfire::message("  one or more add-on package names");
> +  &Pakfire::message("COMMAND:");
> +  &Pakfire::message("  install      - install one or more packages");
> +  &Pakfire::message("  remove       - remove one or more packages");
> +  &Pakfire::message("  update       - update the pakfire database");
> +  &Pakfire::message("  upgrade      - upgrade all packages to the latest version");
> +  &Pakfire::message("  list [installed | notinstalled | upgrade]");
> +  &Pakfire::message("               - display a list of installed, notinstalled,");
> +  &Pakfire::message("                 upgradeable or all packages");
> +  &Pakfire::message("  info         - display metadata for one or more packages");
> +  &Pakfire::message("  resolvedeps  - display dependencies for one or more packages");
> +  &Pakfire::message("  status       - display pakfire database status,");
> +  &Pakfire::message("                 available updates and whether a reboot");
> +  &Pakfire::message("                 is required to complete any upgrades");
> +  &Pakfire::message("OPTIONS:");
> +  &Pakfire::message("  --no-colors             - turn off colors");
> +  &Pakfire::message("  -y | --non-interactive  - automatic yes to prompts");
> +  &Pakfire::message("  -f | --force            - for the update command, force");
> +  &Pakfire::message("                            a pakfire database update");
>   &Pakfire::message("");
>   exit 1;
> }
> -- 
> 2.43.0
> 
>