File: intro.xml

package info (click to toggle)
debian-policy 4.7.3.0
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,320 kB
  • sloc: xml: 7,484; makefile: 234; perl: 174; python: 50
file content (91 lines) | stat: -rw-r--r-- 2,981 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<chapter id='introduction'><title>Introduction</title>

<section id='purpose'><title>Purpose</title>

<para>This standard enables:</para>
<itemizedlist>
<listitem>
<para>Software to predict the location of installed files and
directories, and</para>
</listitem>
<listitem>
<para>Users to predict the location of installed files and
directories.</para>
</listitem>
</itemizedlist>

<para>We do this by:</para>
<itemizedlist>
<listitem>
<para>Specifying guiding principles for each area of the filesystem,</para>
</listitem>
<listitem>
<para>Specifying the minimum files and directories required,</para>
</listitem>
<listitem>
<para>Enumerating exceptions to the principles, and</para>
</listitem>
<listitem>
<para>Enumerating specific cases where there has been historical conflict.</para>
</listitem>
</itemizedlist>

<para>The FHS document is used by:</para>
<itemizedlist>
<listitem>
<para>Independent software suppliers to create applications which are FHS
compliant, and work with distributions which are FHS compliant,</para>
</listitem>
<listitem>
<para>OS creators to provide systems which are FHS compliant, and</para>
</listitem>
<listitem>
<para>Users to understand and maintain the FHS compliance of a system.</para>
</listitem>
</itemizedlist>

<para>The FHS document has a limited scope:</para>
<itemizedlist>
<listitem>
<para>Local placement of local files is a local issue, so FHS does not
attempt to usurp system administrators.</para>
</listitem>
<listitem>
<para>FHS addresses issues where file placements need to be coordinated
between multiple parties such as local sites, distributions,
applications, documentation, etc.</para>
</listitem>
</itemizedlist>
</section>

<section id='conventions'><title>Conventions</title>

<para>We recommend that you read a typeset version of this document rather
than the plain text version.  In the typeset version, the names of files
and directories are displayed in a constant-width font.</para>

<para>Components of filenames that vary are represented by a description
of the contents enclosed in "<replaceable>&lt;</replaceable>" and
"<replaceable>&gt;</replaceable>" characters, 
<replaceable>&lt;thus&gt;</replaceable>.  Electronic mail addresses are also
enclosed in "&lt;" and "&gt;" but are shown in the usual
typeface.</para>

<para>Optional components of filenames are enclosed in
"<replaceable>[</replaceable>" and "<replaceable>]</replaceable>" characters and may
be combined with the "<replaceable>&lt;</replaceable>" and
"<replaceable>&gt;</replaceable>" convention.  For example, if a filename is
allowed to occur either with or without an extension, it might be
represented by
<replaceable>&lt;filename&gt;[.&lt;extension&gt;]</replaceable>.</para>

<para>Variable substrings of directory names and filenames are indicated
by "<replaceable>*</replaceable>".</para>

<para>The sections of the text marked as
<emphasis>Rationale</emphasis> are explanatory and are
non-normative.</para>

</section>

</chapter>