| @@ -1,285 +1,285 @@ | | | @@ -1,285 +1,285 @@ |
1 | .\" $NetBSD: contents,v 1.4.4.3 2020/07/20 18:32:55 martin Exp $ | | 1 | .\" $NetBSD: contents,v 1.4.4.4 2020/07/26 11:07:56 martin Exp $ |
2 | .\" | | 2 | .\" |
3 | .\" Copyright (c) 1999-2020 The NetBSD Foundation, Inc. | | 3 | .\" Copyright (c) 1999-2020 The NetBSD Foundation, Inc. |
4 | .\" All rights reserved. | | 4 | .\" All rights reserved. |
5 | .\" | | 5 | .\" |
6 | .\" Redistribution and use in source and binary forms, with or without | | 6 | .\" Redistribution and use in source and binary forms, with or without |
7 | .\" modification, are permitted provided that the following conditions | | 7 | .\" modification, are permitted provided that the following conditions |
8 | .\" are met: | | 8 | .\" are met: |
9 | .\" 1. Redistributions of source code must retain the above copyright | | 9 | .\" 1. Redistributions of source code must retain the above copyright |
10 | .\" notice, this list of conditions and the following disclaimer. | | 10 | .\" notice, this list of conditions and the following disclaimer. |
11 | .\" 2. Redistributions in binary form must reproduce the above copyright | | 11 | .\" 2. Redistributions in binary form must reproduce the above copyright |
12 | .\" notice, this list of conditions and the following disclaimer in the | | 12 | .\" notice, this list of conditions and the following disclaimer in the |
13 | .\" documentation and/or other materials provided with the distribution. | | 13 | .\" documentation and/or other materials provided with the distribution. |
14 | .\" | | 14 | .\" |
15 | .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS | | 15 | .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS |
16 | .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED | | 16 | .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED |
17 | .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | | 17 | .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
18 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS | | 18 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS |
19 | .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | | 19 | .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
20 | .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | | 20 | .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
21 | .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | | 21 | .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
22 | .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | | 22 | .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
23 | .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | | 23 | .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
24 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | | 24 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
25 | .\" POSSIBILITY OF SUCH DAMAGE. | | 25 | .\" POSSIBILITY OF SUCH DAMAGE. |
26 | .\" | | 26 | .\" |
27 | . | | 27 | . |
28 | .Ss2 NetBSD/\*M subdirectory structure | | 28 | .Ss2 NetBSD/\*M subdirectory structure |
29 | The \*M-specific portion of the | | 29 | The \*M-specific portion of the |
30 | .Nx | | 30 | .Nx |
31 | \*V release is found in the | | 31 | \*V release is found in the |
32 | .Pa \*M | | 32 | .Pa \*M |
33 | subdirectory of the distribution: | | 33 | subdirectory of the distribution: |
34 | .Pa \&.../NetBSD-\*V/\*M/ . | | 34 | .Pa \&.../NetBSD-\*V/\*M/ . |
35 | It contains the following files and directories: | | 35 | It contains the following files and directories: |
36 | .Pp | | 36 | .Pp |
37 | .(tag INSTALL.html -compact \" top level | | 37 | .(tag INSTALL.html -compact \" top level |
38 | . It Pa INSTALL.html | | 38 | . It Pa INSTALL.html |
39 | . It Pa INSTALL.ps | | 39 | . It Pa INSTALL.ps |
40 | . It Pa INSTALL.txt | | 40 | . It Pa INSTALL.txt |
41 | . It Pa INSTALL.more | | 41 | . It Pa INSTALL.more |
42 | Installation notes in various file formats, including this file. | | 42 | Installation notes in various file formats, including this file. |
43 | The | | 43 | The |
44 | .Pa \&.more | | 44 | .Pa \&.more |
45 | file contains underlined text using the | | 45 | file contains underlined text using the |
46 | .Xr more 1 | | 46 | .Xr more 1 |
47 | conventions for indicating italic and bold display. | | 47 | conventions for indicating italic and bold display. |
48 | . It Pa binary/ | | 48 | . It Pa binary/ |
49 | . (tag kernel/ -compact \" binary/ | | 49 | . (tag kernel/ -compact \" binary/ |
50 | . It Pa gzimg/ | | 50 | . It Pa gzimg/ |
51 | . (tag armv7.img.gz -compact \" binary/gzimg | | 51 | . (tag armv7.img.gz -compact \" binary/gzimg |
52 | . It Pa armv7.img.gz | | 52 | . It Pa armv7.img.gz |
53 | A gzipped writable image containing the complete | | 53 | A gzipped writable image containing the complete |
54 | .Nx | | 54 | .Nx |
55 | operating system for a range of 32-bit devices (includes a GENERIC kernel). | | 55 | operating system for a range of 32-bit devices (includes a GENERIC kernel). |
56 | . It Pa arm64.img.gz | | 56 | . It Pa arm64.img.gz |
57 | A gzipped writable image containing the complete | | 57 | A gzipped writable image containing the complete |
58 | .Nx | | 58 | .Nx |
59 | operating system for a range of 64-bit devices (includes a GENERIC64 kernel). | | 59 | operating system for a range of 64-bit devices (includes a GENERIC64 kernel). |
60 | . It Pa rpi.img.gz | | 60 | . It Pa rpi.img.gz |
61 | A gzipped writable image containing the complete 32-bit | | 61 | A gzipped writable image containing the complete 32-bit |
62 | .Nx | | 62 | .Nx |
63 | operating system for Raspberry Pi variants only (includes RPI kernels). | | 63 | operating system for Raspberry Pi variants only (includes RPI kernels). |
64 | . It Pa *.dtb.gz | | | |
65 | Gzipped board-specific device trees. | | | |
66 | . tag) \" binary/gzimg/ | | 64 | . tag) \" binary/gzimg/ |
67 | . It Pa kernel/ | | 65 | . It Pa kernel/ |
68 | . (tag netbsd.gz -compact \" binary/kernel | | 66 | . (tag netbsd.gz -compact \" binary/kernel |
69 | . It Pa netbsd-GENERIC.gz | | 67 | . It Pa netbsd-GENERIC.gz |
70 | A gzipped ARMv7 kernel which supports a range of 32-bit devices that | | 68 | A gzipped ARMv7 kernel which supports a range of 32-bit devices that |
71 | do not need board-specific kernels. | | 69 | do not need board-specific kernels. |
72 | . It Pa netbsd-GENERIC64.gz | | 70 | . It Pa netbsd-GENERIC64.gz |
73 | A gzipped AArch64 kernel which supports a range of 64-bit devices that | | 71 | A gzipped AArch64 kernel which supports a range of 64-bit devices that |
74 | do not need board-specific kernels. | | 72 | do not need board-specific kernels. |
75 | . It Pa netbsd-RPI.gz | | 73 | . It Pa netbsd-RPI.gz |
76 | A gzipped ARMv6 kernel which supports the Raspberry Pi 1 only. | | 74 | A gzipped ARMv6 kernel which supports the Raspberry Pi 1 only. |
77 | . It Pa netbsd-RPI2.gz | | 75 | . It Pa netbsd-RPI2.gz |
78 | A gzipped ARMv6 kernel which supports the Raspberry Pi 2 only. | | 76 | A gzipped ARMv6 kernel which supports the Raspberry Pi 2 only. |
| | | 77 | . It Pa *.dtb.gz |
| | | 78 | Gzipped board-specific device trees. |
79 | . tag) \" binary/kernel/ | | 79 | . tag) \" binary/kernel/ |
80 | . | | 80 | . |
81 | . It Pa sets/ | | 81 | . It Pa sets/ |
82 | \*M binary distribution sets; | | 82 | \*M binary distribution sets; |
83 | see below. | | 83 | see below. |
84 | . | | 84 | . |
85 | . tag) \" binary/ | | 85 | . tag) \" binary/ |
86 | . It Pa installation/ | | 86 | . It Pa installation/ |
87 | . | | 87 | . |
88 | . (tag miniroot/ -compact \" installation/ | | 88 | . (tag miniroot/ -compact \" installation/ |
89 | . | | 89 | . |
90 | . It Pa miniroot/ | | 90 | . It Pa miniroot/ |
91 | . | | 91 | . |
92 | \*M kernel modules providing memory disk | | 92 | \*M kernel modules providing memory disk |
93 | root file systems for expert usage. | | 93 | root file systems for expert usage. |
94 | . | | 94 | . |
95 | . It Pa misc/ | | 95 | . It Pa misc/ |
96 | . (tag bootaa64.efi -compact \" misc/bootaa64.efi | | 96 | . (tag bootaa64.efi -compact \" misc/bootaa64.efi |
97 | . It Pa bootaa64.efi | | 97 | . It Pa bootaa64.efi |
98 | . (tag bootaa64.efi -compact \" misc/bootaa64.efi | | 98 | . (tag bootaa64.efi -compact \" misc/bootaa64.efi |
99 | AArch64 EFI bootloader | | 99 | AArch64 EFI bootloader |
100 | . tag) \" misc/bootaa64.efi | | 100 | . tag) \" misc/bootaa64.efi |
101 | . tag) \" misc/bootaa64.efi | | 101 | . tag) \" misc/bootaa64.efi |
102 | . | | 102 | . |
103 | . tag) \" installation/ | | 103 | . tag) \" installation/ |
104 | . | | 104 | . |
105 | .tag) \" top level | | 105 | .tag) \" top level |
106 | . | | 106 | . |
107 | . | | 107 | . |
108 | .Ss2 Binary distribution sets | | 108 | .Ss2 Binary distribution sets |
109 | The | | 109 | The |
110 | .Nx | | 110 | .Nx |
111 | \*V release for \*M is comprised of the following binary sets, which | | 111 | \*V release for \*M is comprised of the following binary sets, which |
112 | can be found in the | | 112 | can be found in the |
113 | .Pa \*M/binary/sets | | 113 | .Pa \*M/binary/sets |
114 | subdirectory | | 114 | subdirectory |
115 | of the | | 115 | of the |
116 | .Nx | | 116 | .Nx |
117 | \*V | | 117 | \*V |
118 | distribution tree: | | 118 | distribution tree: |
119 | .(tag xserver \" sets | | 119 | .(tag xserver \" sets |
120 | .\" | | 120 | .\" |
121 | .\" XXX: most sets except kern and xserver should be shared | | 121 | .\" XXX: most sets except kern and xserver should be shared |
122 | .\" | | 122 | .\" |
123 | . | | 123 | . |
124 | .It Sy base | | 124 | .It Sy base |
125 | The | | 125 | The |
126 | .Nx | | 126 | .Nx |
127 | \*V | | 127 | \*V |
128 | \*M | | 128 | \*M |
129 | .Sy base | | 129 | .Sy base |
130 | binary distribution. | | 130 | binary distribution. |
131 | You | | 131 | You |
132 | .Em must | | 132 | .Em must |
133 | install this distribution set. | | 133 | install this distribution set. |
134 | It contains the base | | 134 | It contains the base |
135 | .Nx | | 135 | .Nx |
136 | utilities that are necessary for the | | 136 | utilities that are necessary for the |
137 | system to run and be minimally functional. | | 137 | system to run and be minimally functional. |
138 | . | | 138 | . |
139 | .It Sy comp | | 139 | .It Sy comp |
140 | Things needed for compiling programs. | | 140 | Things needed for compiling programs. |
141 | This set includes the system include files | | 141 | This set includes the system include files |
142 | .Pq Pa /usr/include | | 142 | .Pq Pa /usr/include |
143 | and the various system libraries (except the shared | | 143 | and the various system libraries (except the shared |
144 | libraries, which are included as part of the | | 144 | libraries, which are included as part of the |
145 | .Sy base | | 145 | .Sy base |
146 | set). | | 146 | set). |
147 | This set also includes the manual pages for | | 147 | This set also includes the manual pages for |
148 | all of the utilities it contains, as well as the | | 148 | all of the utilities it contains, as well as the |
149 | system call and library manual pages. | | 149 | system call and library manual pages. |
150 | . | | 150 | . |
151 | .It Sy debug | | 151 | .It Sy debug |
152 | This distribution set contains debug information for | | 152 | This distribution set contains debug information for |
153 | all base system utilities. | | 153 | all base system utilities. |
154 | It is useful when reporting issues with binaries or during | | 154 | It is useful when reporting issues with binaries or during |
155 | developement. | | 155 | developement. |
156 | This set is huge, if the target disk is small, do not install it. | | 156 | This set is huge, if the target disk is small, do not install it. |
157 | . | | 157 | . |
158 | .It Sy etc | | 158 | .It Sy etc |
159 | This distribution set contains the system | | 159 | This distribution set contains the system |
160 | configuration files that reside in | | 160 | configuration files that reside in |
161 | .Pa /etc | | 161 | .Pa /etc |
162 | and in several other places. | | 162 | and in several other places. |
163 | This set | | 163 | This set |
164 | .Em must | | 164 | .Em must |
165 | be installed if you are installing the system from scratch, but should | | 165 | be installed if you are installing the system from scratch, but should |
166 | .Em not | | 166 | .Em not |
167 | be used if you are upgrading. | | 167 | be used if you are upgrading. |
168 | . | | 168 | . |
169 | .It Sy games | | 169 | .It Sy games |
170 | This set includes the games and their manual pages. | | 170 | This set includes the games and their manual pages. |
171 | . | | 171 | . |
172 | .\" Kernel set(s) | | 172 | .\" Kernel set(s) |
173 | . | | 173 | . |
174 | .It Sy kern-GENERIC | | 174 | .It Sy kern-GENERIC |
175 | This set contains a | | 175 | This set contains a |
176 | .Nx*M | | 176 | .Nx*M |
177 | \*V | | 177 | \*V |
178 | .Li GENERIC | | 178 | .Li GENERIC |
179 | kernel, named | | 179 | kernel, named |
180 | .Pa /netbsd . | | 180 | .Pa /netbsd . |
181 | You | | 181 | You |
182 | .Em must | | 182 | .Em must |
183 | install this distribution set. | | 183 | install this distribution set. |
184 | . | | 184 | . |
185 | .It Sy man | | 185 | .It Sy man |
186 | This set includes all of the manual pages for the | | 186 | This set includes all of the manual pages for the |
187 | binaries and other software contained in the | | 187 | binaries and other software contained in the |
188 | .Sy base | | 188 | .Sy base |
189 | set. | | 189 | set. |
190 | Note that it does not include any of the manual pages | | 190 | Note that it does not include any of the manual pages |
191 | that are included in the other sets. | | 191 | that are included in the other sets. |
192 | . | | 192 | . |
193 | .It Sy misc | | 193 | .It Sy misc |
194 | This set includes the system dictionaries, | | 194 | This set includes the system dictionaries, |
195 | the typesettable document set, and other files from | | 195 | the typesettable document set, and other files from |
196 | .Pa /usr/share . | | 196 | .Pa /usr/share . |
197 | . | | 197 | . |
198 | .It Sy modules | | 198 | .It Sy modules |
199 | This set includes kernel modules to add functionality to a running system. | | 199 | This set includes kernel modules to add functionality to a running system. |
200 | . | | 200 | . |
201 | .It Sy rescue | | 201 | .It Sy rescue |
202 | This set includes the statically linked emergency recover binaries installed | | 202 | This set includes the statically linked emergency recover binaries installed |
203 | in | | 203 | in |
204 | .Pa /rescue . | | 204 | .Pa /rescue . |
205 | . | | 205 | . |
206 | .It Sy text | | 206 | .It Sy text |
207 | This set includes | | 207 | This set includes |
208 | .Nx Ns 's | | 208 | .Nx Ns 's |
209 | text processing tools, including | | 209 | text processing tools, including |
210 | .Xr groff 1 , | | 210 | .Xr groff 1 , |
211 | all related programs, and their manual pages. | | 211 | all related programs, and their manual pages. |
212 | . | | 212 | . |
213 | .tag) \" sets | | 213 | .tag) \" sets |
214 | . | | 214 | . |
215 | . | | 215 | . |
216 | .\" ---------------------------- X SETS | | 216 | .\" ---------------------------- X SETS |
217 | .Pp | | 217 | .Pp |
218 | .Nx | | 218 | .Nx |
219 | maintains its own set of sources for the X Window System in order to | | 219 | maintains its own set of sources for the X Window System in order to |
220 | assure tight integration and compatibility. | | 220 | assure tight integration and compatibility. |
221 | These sources are based on | | 221 | These sources are based on |
222 | X.Org. | | 222 | X.Org. |
223 | Binary sets for the X Window System are distributed with | | 223 | Binary sets for the X Window System are distributed with |
224 | .Nx . | | 224 | .Nx . |
225 | The sets are: | | 225 | The sets are: |
226 | .(tag xserver \" x sets | | 226 | .(tag xserver \" x sets |
227 | . | | 227 | . |
228 | .It Sy xbase | | 228 | .It Sy xbase |
229 | The basic files needed for a complete X | | 229 | The basic files needed for a complete X |
230 | client environment. | | 230 | client environment. |
231 | This does not include the X servers. | | 231 | This does not include the X servers. |
232 | . | | 232 | . |
233 | .It Sy xcomp | | 233 | .It Sy xcomp |
234 | The extra libraries and include files needed to compile X source code. | | 234 | The extra libraries and include files needed to compile X source code. |
235 | . | | 235 | . |
236 | .It Sy xdebug | | 236 | .It Sy xdebug |
237 | This distribution set contains debug information for | | 237 | This distribution set contains debug information for |
238 | all X11 binaries. | | 238 | all X11 binaries. |
239 | It is useful when reporting issues with these binaries or during | | 239 | It is useful when reporting issues with these binaries or during |
240 | developement. | | 240 | developement. |
241 | This set is huge, if the target disk is small, do not install it. | | 241 | This set is huge, if the target disk is small, do not install it. |
242 | . | | 242 | . |
243 | .It Sy xfont | | 243 | .It Sy xfont |
244 | Fonts needed by the X server and by X clients. | | 244 | Fonts needed by the X server and by X clients. |
245 | . | | 245 | . |
246 | .It Sy xetc | | 246 | .It Sy xetc |
247 | Configuration files for X which could be locally modified. | | 247 | Configuration files for X which could be locally modified. |
248 | . | | 248 | . |
249 | .It Sy xserver | | 249 | .It Sy xserver |
250 | The X server. | | 250 | The X server. |
251 | This includes the modular X.Org server. | | 251 | This includes the modular X.Org server. |
252 | . | | 252 | . |
253 | .tag) \" x sets | | 253 | .tag) \" x sets |
254 | . | | 254 | . |
255 | . | | 255 | . |
256 | .\" ---------------------------- MI DISCUSSION OF BINARY SETS | | 256 | .\" ---------------------------- MI DISCUSSION OF BINARY SETS |
257 | .\" | | 257 | .\" |
258 | .\" MI DISCUSSION OF BINARY SETS ------------------------------------- | | 258 | .\" MI DISCUSSION OF BINARY SETS ------------------------------------- |
259 | .\" XXX: should be in notes/common | | 259 | .\" XXX: should be in notes/common |
260 | .\" | | 260 | .\" |
261 | . | | 261 | . |
262 | .Pp | | 262 | .Pp |
263 | The \*M binary distribution sets are distributed as gzipped tar files | | 263 | The \*M binary distribution sets are distributed as gzipped tar files |
264 | named with the extension | | 264 | named with the extension |
265 | .Sy .\*[setsuffix] | | 265 | .Sy .\*[setsuffix] |
266 | .Pq e.g., Pa base.\*[setsuffix] . | | 266 | .Pq e.g., Pa base.\*[setsuffix] . |
267 | . | | 267 | . |
268 | . | | 268 | . |
269 | .Pp | | 269 | .Pp |
270 | The instructions given for extracting the source sets work equally | | 270 | The instructions given for extracting the source sets work equally |
271 | well for the binary sets, but it is worth noting that if you use that | | 271 | well for the binary sets, but it is worth noting that if you use that |
272 | method, the filenames stored in the sets are relative and therefore | | 272 | method, the filenames stored in the sets are relative and therefore |
273 | the files are extracted | | 273 | the files are extracted |
274 | .Em below the current directory . | | 274 | .Em below the current directory . |
275 | Therefore, if you want to extract the binaries into your system, i.e., | | 275 | Therefore, if you want to extract the binaries into your system, i.e., |
276 | replace the system binaries with them, you have to run the | | 276 | replace the system binaries with them, you have to run the |
277 | .Ic "tar -xzpf" | | 277 | .Ic "tar -xzpf" |
278 | command from the root directory ( | | 278 | command from the root directory ( |
279 | .Pa / | | 279 | .Pa / |
280 | ) of your system. | | 280 | ) of your system. |
281 | . | | 281 | . |
282 | . | | 282 | . |
283 | .\" ---------------------------- MD DISCUSSION | | 283 | .\" ---------------------------- MD DISCUSSION |
284 | . | | 284 | . |
285 | .\" XXX: should be written | | 285 | .\" XXX: should be written |