Debian Codegraph @

upstream/debian-unstable/man7/systemd.image-filter.7

raw
1 '\" t
2 .TH "SYSTEMD\&.IMAGE\-FILTER" "7" "" "systemd 261~rc3" "systemd.image-filter"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd.image-filter \- Disk Image Dissection Filter
24 .SH "DESCRIPTION"
25 .PP
26 In systemd, whenever a disk image (DDI) implementing the
27 \m[blue]\fBUAPI\&.2 Discoverable Partitions Specification\fR\m[]\&\s-2\u[1]\d\s+2
28 is activated, a filter may be specified controlling which partitions to consider for mounting\&. Such a disk image dissection filter is a string that contains per\-partition\-type patterns, separated by colons (":")\&. The individual rules consist of a partition identifier, an equal sign ("="), and a shell globbing pattern applied to the GPT label string of the partition\&. See
29 \fBglob\fR(7)
30 for details on shell globbing\&.
31 .PP
32 The partition identifiers currently defined are:
33 \fBroot\fR,
34 \fBusr\fR,
35 \fBhome\fR,
36 \fBsrv\fR,
37 \fBesp\fR,
38 \fBxbootldr\fR,
39 \fBswap\fR,
40 \fBroot\-verity\fR,
41 \fBroot\-verity\-sig\fR,
42 \fBusr\-verity\fR,
43 \fBusr\-verity\-sig\fR,
44 \fBtmp\fR,
45 \fBvar\fR\&. These identifiers match the relevant partition types in the Discoverable Partitions Specification, but are agnostic to CPU architectures\&.
46 .SH "USE"
47 .PP
48 Various systemd components that support operating with disk images support a
49 \fB\-\-image\-filter=\fR
50 command line option to specify the image filter to use\&. If no filter is specified all partitions in partition table are considered and no per\-label filtering is applied (except that partitions with the
51 "_empty"
52 label are always ignored)\&.
53 .PP
54 For the host root file system image itself
55 \fBsystemd-gpt-auto-generator\fR(8)
56 is responsible for processing the GPT partition table and making use of the included discoverable partitions\&. It accepts an image filter via the kernel command line option
57 \fBsystemd\&.image_filter=\fR\&.
58 .SH "EXAMPLES"
59 .PP
60 The following image filter string dictates that for the root file system partition only partitions shall be considered whose label begins with
61 "ParticleOS\-"\&. For the
62 /usr/
63 partition the precise label
64 "ParticleOS_47110815"
65 is required\&.
66 .sp
67 .if n \{\
68 .RS 4
69 .\}
70 .nf
71 root=ParticleOS\-*:usr=ParticleOS_47110815
72 .fi
73 .if n \{\
74 .RE
75 .\}
76 .SH "SEE ALSO"
77 .PP
78 \fBsystemd\fR(1), \fBsystemd-dissect\fR(1), \fBsystemd-gpt-auto-generator\fR(8), \fBsystemd.image-policy\fR(7)
79 .SH "NOTES"
80 .IP " 1." 4
81 UAPI.2 Discoverable Partitions Specification
82 .RS 4
83 \%https://uapi-group.org/specifications/specs/discoverable_partitions_specification
84 .RE