[pacman-dev] [PATCH v2 1/2] Document pacman -F

[Andrew Gregory]

On 10/25/15 at 05:06pm, Florian Pritz wrote:
> Signed-off-by: Florian Pritz <bluewind at xinu.at>
> ---
> 
> v2:
>  - Document --refresh
> 
>  doc/pacman.8.txt | 26 ++++++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
> 
> diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt
> index 5c57450..38b8bb7 100644
> --- a/doc/pacman.8.txt
> +++ b/doc/pacman.8.txt
> @@ -110,6 +110,11 @@ greater than `1:3.6-1`.
>  	Options>> below; also see <<HCF,Handling Config Files>> for an explanation
>  	on how pacman takes care of configuration files.
>  
> +*-F, \--files*::
> +	Query the files database. This operation allows you to look for package
> +	owning certain files or display files owned by certain packages. See
> +	<<FO,File Options>> below.

This should mention somewhere that this is for sync databases.

>  *-V, \--version*::
>  	Display version and exit.
>  
> @@ -451,6 +456,27 @@ Database Options[[QO]]
>  	a check on the sync databases to ensure all specified dependencies
>  	are available.
>  
> +File Options[[FO]]
> +------------------
> +
> +The '--list', '--search' and '--owns' options are exclusive and can not be combined.
> +
> +*-y, --refresh*::
> +	Download fresh package databases from the server. Use twice to force a
> +	refresh even if databases are up to date.
> +
> +*-l <package>, \--list <package>*::
> +	List the files owned by the queried package.

None of our other options repeat the argument name for both the short
and long forms of an option.  Unfortunately, our man page is
inconsistent as to when the argument name is included at all.  Since
'<package>' isn't actually an argument to '--list' and '--list'
doesn't actually require any targets I would say to just omit it
entirely.

> +*-s <pattern>, \--search <pattern>*::
> +	Search package file names for matching strings.

Same as above.  It makes a little more sense to include an argument
name here since this option does at least require targets, but
--search doesn't really take a pattern; it only compares the target to
the file basename and requires an exact match.

> +*-x, --regex*::
> +	Treat arguments to '--search' as regular expressions.
> +
> +*-o <file>, \--owns<file>*::
> +	Search for packages that own a particular file.

Same as above, and you're missing a space after --owns.

>  Handling Config Files[[HCF]]
>  ----------------------------
> -- 
> 2.6.2