.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "PKGFILE 1" .TH PKGFILE 1 "2020-05-27" "pkgfile 21" "pkgfile Manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" pkgfile \- an alpm .files metadata explorer .SH "SYNOPSIS" .IX Header "SYNOPSIS" Usage: \fIpkgfile\fR [operation] [options] target .SH "DESCRIPTION" .IX Header "DESCRIPTION" pkgfile searches the .files metadata created by \fBrepo-add\fR(8) to retrieve file information about packages. By default, the provided target is considered to be a filename and pkgfile will return the package(s) which contain this file. The repos which pkgfile searches is determined by those enabled in \&\fI/etc/pacman.conf\fR. .SH "OPERATIONS" .IX Header "OPERATIONS" .IP "\fB\-l\fR, \fB\-\-list\fR" 4 .IX Item "-l, --list" The target is considered to be a package name rather than a filename, and the contents of the named package are returned. This allows for repo/package style syntax (such as \*(L"core/pacman\*(R") to limit the breadth of the search, but only when \&\fB\-\-list\fR is used without the \fB\-\-glob\fR or \fB\-\-regex\fR options. .IP "\fB\-s\fR, \fB\-\-search\fR" 4 .IX Item "-s, --search" Search for packages containing the provided target. This is the default mode of operation. .IP "\fB\-u\fR, \fB\-\-update\fR" 4 .IX Item "-u, --update" Update the stored metadata files. It is recommended to create a daily cron job with this command to ensure accurate results. By default, only repos which are found to be newer on the mirror will be downloaded. Pass this option twice to force all repos to be downloaded. .SH "MATCHING" .IX Header "MATCHING" .IP "\fB\-b\fR, \fB\-\-binaries\fR" 4 .IX Item "-b, --binaries" Return only files which are contained within a bin or sbin directory. .IP "\fB\-d\fR, \fB\-\-directories\fR" 4 .IX Item "-d, --directories" Match directories in search results. .IP "\fB\-g\fR, \fB\-\-glob\fR" 4 .IX Item "-g, --glob" Enable shell-style glob pattern matching. See \fBglob\fR(7). Note that the shell wildcards \fI*\fR and \fI?\fR will never match path separators. Thus, this kind of matching is useful for searching for entries within directories, e.g. \fI/usr/bin/*\fR. .IP "\fB\-i\fR, \fB\-\-ignorecase\fR" 4 .IX Item "-i, --ignorecase" Disable case sensitivity in matching. .IP "\fB\-r\fR, \fB\-\-regex\fR" 4 .IX Item "-r, --regex" Enable regular expression matching. See \fBpcre\fR(3). .IP "\fB\-R\fR \fI\s-1REPO\s0\fR, \fB\-\-repo=\fR\fI\s-1REPO\s0\fR" 4 .IX Item "-R REPO, --repo=REPO" Search only the specific repo. .SH "OUTPUT" .IX Header "OUTPUT" .IP "\fB\-0\fR, \fB\-\-null\fR" 4 .IX Item "-0, --null" Delimit output with null bytes rather than newline characters. .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4 .IX Item "-q, --quiet" Output less. This applies to the \fB\-\-list\fR operation. .IP "\fB\-v\fR, \fB\-\-verbose\fR" 4 .IX Item "-v, --verbose" Output more. This applies to the \fB\-\-search\fR operation. .IP "\fB\-w\fR, \fB\-\-raw\fR" 4 .IX Item "-w, --raw" Avoid justification of 2 column output. .SH "DOWNLOADING" .IX Header "DOWNLOADING" .IP "\fB\-z\fR, \fB\-\-compress\fR[\fB=\fR\fI\s-1COMPRESSION\s0\fR]" 4 .IX Item "-z, --compress[=COMPRESSION]" Repack downloaded repos with the optionally supplied compression method, which may be one of \fBnone\fR, \fBgzip\fR, \fBbzip2\fR, \fBlzop\fR, \fBlz4\fR, \fBlzma\fR, or \fBxz\fR. If this flag is passed without a compression method, this defaults to \fBgzip\fR. If this flag is not passed at all, no compression will be applied. Applying any form of compression will decrease performance, but may be desirable for disk space concerns. .SH "GENERAL OPTIONS" .IX Header "GENERAL OPTIONS" .IP "\fB\-C\fR \fI\s-1FILE\s0\fR, \fB\-\-config=\fR\fI\s-1FILE\s0\fR" 4 .IX Item "-C FILE, --config=FILE" Use a config file other than the default of \fI/etc/pacman.conf\fR. .IP "\fB\-D\fR \fI\s-1DIRECTORY\s0\fR, \fB\-\-cachedir=\fR\fI\s-1DIRECTORY\s0\fR" 4 .IX Item "-D DIRECTORY, --cachedir=DIRECTORY" Use a cache path other than the compile-time default. .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Print help and exit. .IP "\fB\-V\fR, \fB\-\-version\fR" 4 .IX Item "-V, --version" Print the version and exit. .SH "MATCHING HEURISTICS" .IX Header "MATCHING HEURISTICS" In \-\-search mode and without the \-\-regex or \-\-glob option, pkgfile will attempt to match the provided target as an exact filename. If the target contains a '/' character, a full path match will be attempted. With \-\-regex and \-\-glob enabled searching, pkgfile will always match against the full pathname. .PP In \-\-list mode and without the \-\-regex or \-\-glob option, pkgfile will attempt to match the provided target as an exact package name. If the target contains a '/' character, the text before the slash will be assumed to be a repository and the search will be restricted. .SH "COMMAND NOT FOUND HOOKS" .IX Header "COMMAND NOT FOUND HOOKS" .IP "\fI/usr/share/doc/pkgfile/command\-not\-found.bash\fR" 4 .IX Item "/usr/share/doc/pkgfile/command-not-found.bash" .PD 0 .IP "\fI/usr/share/doc/pkgfile/command\-not\-found.zsh\fR" 4 .IX Item "/usr/share/doc/pkgfile/command-not-found.zsh" .IP "\fI/usr/share/doc/pkgfile/command\-not\-found.fish\fR" 4 .IX Item "/usr/share/doc/pkgfile/command-not-found.fish" .PD zsh, bash and fish compatible functions which can be included in shell initalization to run pkgfile when an executed command is not found. .Sp If the environment variable \s-1PKGFILE_PROMPT_INSTALL_MISSING\s0 is set, and only one package is found, a prompt to install the package will be shown. \fB\s-1NOTE\s0\fR: this feature requires the \fBsudo\fR(8) program, and is currently only supported by the bash implementation. .SH "AUTOMATING UPDATES" .IX Header "AUTOMATING UPDATES" pkgfile includes systemd timer and service units to automate periodic updates to the .files DBs. Assuming that pkgfile was built with systemd support, this can be enabled with: .PP .Vb 1 \& systemctl enable \-\-now pkgfile\-update.timer .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBrepo-add\fR(8), \fBpcre\fR(3), \fBglob\fR(7), \fBpacman.conf\fR(5) .SH "AUTHOR" .IX Header "AUTHOR" Dave Reisner