appimaged icon indicating copy to clipboard operation
appimaged copied to clipboard

[Enhancement] `appimaged -h` should print the list of monitored directories

Open pdfkungfoo opened this issue 8 years ago • 4 comments

The appimaged utility has a -h, --help CLI parameter, which currently prints this:

$> appimaged --help
Usage:
  appimaged [OPTION...] 

Help Options:
  -h, --help           Show help options

Application Options:
  -v, --verbose        Be verbose
  -i, --install        Install this appimaged instance to $HOME
  -u, --uninstall      Uninstall an appimaged instance from $HOME
  -n, --no-install     Force run without installation
  --version            Show version number

I. Add explanatory line on top

This help screen should print one or more additional lines giving a short explanatory info about what appimaged is good for at all:

An (optional) userland daemon which monitors various directories for AppImages.
If it detects some, it registers them with the system, so that they show up in
menus, displaying their icons, associating MIME types, etc. It also automatically 
unregisters deleted AppImages from the system. If firejail is installed, it runs
AppImages with it.

or, a bit shorter:

Optional userland daemon to auto-discover AppImages from a pre-defined set of directories
and register/un-register them (create menu entries with icons; associate MIME types, etc). 

II. Add an option to 'discover' monitored directories

The main README for AppImageKit lists the directories which are scanned by appimaged as:

$HOME/Downloads
$HOME/.local/bin
$HOME/bin
/Applications
/isodevice/Applications
/isofrom/Applications
/run/archiso/img_dev/Applications
/opt
/usr/local/bin

In the interest of better discoverability of how the different AppImageKit tools work, there should be a way to enumerate the list of scanned directories.

One possible solution would be to implement an additional flag, -l, --listmon, which would lead to the following output:

$>  appimaged --listmon

Directories monitored by appimaged for added, renamed and removed AppImage(s):
  $HOME/Downloads
  $HOME/.local/bin
  $HOME/bin
  /Applications
  /isodevice/Applications
  /isofrom/Applications
  /run/archiso/img_dev/Applications
  /opt
  /usr/local/bin

III. Complete new help screen

After implementing this request, the new -h could look like this below:

$>  appimaged -h

Optional userland daemon to automatically register and un-register AppImages
(creating menu entries with icons, associating MIME types, etc.), which are
stored in a pre-defined set of directories.

Usage:
  appimaged [OPTION...] 

Help Options:
  -h, --help           Show help options

Application Options:
  -v, --verbose        Be verbose
  -i, --install        Install this appimaged instance to $HOME
  -l, --listmon        List all directories monitored by appimaged
  -u, --uninstall      Uninstall an appimaged instance from $HOME
  -n, --no-install     Force run without installation
  --version            Show version number

pdfkungfoo avatar Jan 01 '18 16:01 pdfkungfoo

While I like the ideas, I am not sure whether all of this is possible with the library we are using for the command line parsing:

https://developer.gnome.org/glib/stable/glib-Commandline-option-parser.html

PRs welcome.

That being said, normal users are probably never going to see the command line options at all...

probonopd avatar Jan 01 '18 19:01 probonopd

"normal users are probably never going to see the command line options at all..."

Whether or not "normal users" see command line options at all -- that's completely irrelevant.

Command line options are relevant only for those (few) users who use and see them anyway, aren't they.

Otherwise one may ask -- why bother giving out any -h output at all?!?

pdfkungfoo avatar Jan 02 '18 00:01 pdfkungfoo

@KurtPfeifle as @probonopd noted, this won't work as requested with the glib option parser.

However, we could provide a flag that lists those directories, e.g., appimaged --list-monitored-directories or something similar. Suggestions welcome.

TheAssassin avatar Feb 02 '18 16:02 TheAssassin

Please move to the appimaged repo

azubieta avatar Nov 26 '18 18:11 azubieta