.\" -*- mode: troff; coding: utf-8 -*-
.TH "" "5" ""
.SH NAME
.LP
alpm-repo-files - File format for listing files and directories contained in an \fBalpm-package\fR.
.SH DESCRIPTION
.LP
The \fBalpm-files\fR format is a textual format that lists the directories and files contained in a single \fBalpm-package\fR.
.PP
Such files are named \fBfiles\fR and are located in \fBalpm-repo-db\fR files.
They are created by package repository management software (such as \fBdbscripts\fR [1]).
Package management software (e.g. \fBpacman\fR) uses them to list and query the paths of directories and files contained in a package file.
.PP
It is important to not confuse \fBalpm-repo-files\fR with \fBalpm-db-files\fR, which uses the same file name (\fBfiles\fR) but is used in the context of an \fBalpm-db\fR.
.SS
General Format
.LP
An \fBalpm-repo-files\fR file is a UTF-8 encoded, newline-delimited file.
.PP
The file 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%\fR, which represents the section header.
Packages with no files (e.g. \fBalpm-meta-packages\fR) may contain only this 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:
.IP "\(bu" 3
Directories are always listed with a trailing slash (\f(CR/\fR).
.if n \
.sp -1
.if t \
.sp -0.25v
.IP "\(bu" 3
All paths are relative to the system root (i.e., \f(CR/usr/bin/foo\fR is represented as \f(CRusr/bin/foo\fR).
.SH EXAMPLES
.LP
The following is an example of an \fBalpm-repo-files\fR file for a package named \f(CRfoo\fR:
.LP
.EX
%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
.EE
.PP
The packaged files include a binary (\f(CRusr/bin/foo\fR), a README file (\f(CRusr/share/doc/foo/README.md\fR), and a license file (\f(CRusr/share/licenses/foo/LICENSE-MIT\fR), among other files such as completion scripts for various shells.
.SH SEE ALSO
.LP
\fBalpm-db-files\fR(5), \fBalpm\fR(7), \fBalpm-db\fR(7), \fBalpm-package\fR(7), \fBalpm-package-name\fR(7), \fBalpm-package-version\fR(7), \fBalpm-repo\fR(7), \fBalpm-repo-db\fR(7), \fBpacman\fR(8)
.SH NOTES
.IP "1." 3
\fBdbscripts\fR
.IP
.UR https://gitlab.archlinux.org/archlinux/dbscripts/
.UE