search

void-linux / xbps

The X Binary Package System (XBPS)
https://voidlinux.org/xbps/
Other
822 stars 124 forks source link

document package properties (xbps-query -p)? #470

Closed classabbyamp closed 2 years ago

classabbyamp commented 2 years ago

It would be nice to have the list of possible properties used in xbps-query -p documented somewhere other than the shell completion files (some users on IRC were trying to figure out what the list of all properties were). Not quite sure what that would look like and where it would go, but if y'all have any idea for that, I can take a stab at writing it.

Duncaen commented 2 years ago

xbps-query -S shows all available pairs for a given package, not sure if we should be maintaining a list in xbps-query.1 or just refer to -S. One downside of referring to -S is that some keys are optional like install-script, remove-script and automatic so they don't show up for every package. Maybe it is also necessary to document what some of the keys are there for, like automatic when a package is installed automatically as a dependency and not manually by the user.

classabbyamp commented 2 years ago

It's definitely not obvious to me that -S shows the possible arguments for -p, and I think that even if it were documented to refer to -S, it'd not be enough in some cases, not only for the optional keys reason. For example: -S shows install-msg: 114B, which makes me assume that -p install-msg would print the same info, not the install message itself.

I think a section in the manpage documenting the list of options is probably the best option, despite the cost of maintaining it.

classabbyamp commented 2 years ago

solved by 2f7feb807427bf6923ae7cd4a1b97387211815eb