.TH "alpm-repo-files" 5

.SH "NAME"
.PP
alpm\-files \- File format for listing files and directories contained in an \fBalpm\-package\fP\.

.SH "DESCRIPTION"
.PP
The \fBalpm\-files\fP format is a textual format that lists the directories and files contained in a single \fBalpm\-package\fP\.
.PP
Such files are named \fBfiles\fP and are located in \fBalpm\-repo\-database\fP files as well as \fBlibalpm\fP databases structures\.
They are created by package repository management software (such as \fBdbscripts\fP [1])\.
Package management software (e\.g\. \fBpacman\fP) uses them to list and query the paths of directories and files contained in a package file\.

.SS "General Format"
.PP
An \fBalpm\-files\fP file is a UTF\-8 encoded, newline\-delimited file\.
It contains a single section header and zero or more section entries\.
Empty lines are ignored\.
Comments are not supported\.
.PP
The first line must be the string literal `\f[CR]%FILES%\fP`, which represents the section header\.
.PP
All subsequent lines are interpreted as section entries, one per line, sorted in lexical order\.
Each section entry represents either a single file or directory path\.
The following formatting rules apply to the paths:
.RS
.Bl
.IP \(bu 4
Directories are always listed with a trailing slash (`\f[CR]/\fP`)\.
.El
.Bl
.IP \(bu 4
All paths are relative to the system root (i\.e\., `\f[CR]/usr/bin/foo\fP` is represented as `\f[CR]usr/bin/foo\fP`)\.
.El
.RE

.SH "EXAMPLES"
.PP
The following is an example of a \fBalpm\-files\fP file for a package named `\f[CR]foo\fP`:
.RS
.PP
.nf
%FILES%
usr/
usr/bin/
usr/bin/foo
usr/share/
usr/share/bash\-completion/
usr/share/bash\-completion/completions/
usr/share/bash\-completion/completions/foo
usr/share/doc/
usr/share/doc/foo/
usr/share/doc/foo/README\.md
usr/share/fish/
usr/share/fish/vendor_completions\.d/
usr/share/fish/vendor_completions\.d/foo\.fish
usr/share/licenses/
usr/share/licenses/foo/
usr/share/licenses/foo/LICENSE\-MIT
usr/share/zsh/
usr/share/zsh/site\-functions/
usr/share/zsh/site\-functions/_foo
.fi
.RE
.PP
The installed package will contain a binary (`\f[CR]usr/bin/foo\fP`), a README file (`\f[CR]usr/share/doc/foo/README\.md\fP`), and a license file (`\f[CR]usr/share/licenses/foo/LICENSE\-MIT\fP`), among other files such as completion scripts for various shells\.

.SH "SEE ALSO"
.PP
\fBlibalpm\fP(3), \fBalpm\-package\fP(7), \fBalpm\-repo\-database\fP(7), \fBpacman\fP(8)

.SH "NOTES"
.RS
.Bl
.IP 1. 4
\fBdbscripts\fP
.sp
https://gitlab\.archlinux\.org/archlinux/dbscripts/
.El
.RE