]> git.lizzy.rs Git - plan9front.git/blob - sys/man/4/namespace
nusb manpages
[plan9front.git] / sys / man / 4 / namespace
1 .TH NAMESPACE 4
2 .SH NAME
3 namespace \- structure of conventional file name space
4 .SH SYNOPSIS
5 none
6 .SH DESCRIPTION
7 After a user's profile has run, the file name space should adhere
8 to a number of conventions if the system is to behave normally.
9 This manual page documents those conventions by traversing the
10 file hierarchy and describing the points of interest.
11 It also serves as a guide to where things reside in the file system proper.
12 The traversal is far from exhaustive.
13 .PP
14 First, here is the appearance of the file server as it appears before
15 any mounts or bindings.
16 .TF /sys/src/cmd
17 .TP
18 .B /
19 The root directory.
20 .TP
21 .B /adm
22 The administration directory for the file server.
23 .TP
24 .B /adm/users
25 List of users known to the file server; see
26 .IR users (6).
27 .TP
28 .B /adm/keys
29 Authentication keys for users.
30 .TP
31 .B /adm/netkeys
32 SecureNet keys for users; see
33 .IR securenet (8).
34 .TP
35 .B /adm/timezone
36 Directory of timezone files; see
37 .IR ctime (2).
38 .TP
39 .B /adm/timezone/EST.EDT
40 Time zone description for Eastern Time.  Other such files are in this directory too.
41 .TP
42 .B /adm/timezone/timezone
43 Time zone description for the local time zone; a copy of one of the other files in this directory.
44 .TP
45 .B /bin
46 .TP
47 .B /dev
48 .TP
49 .B /env
50 .TP
51 .B /fd
52 .TP
53 .B /net
54 .TP
55 .B /proc
56 .TP
57 .B /srv
58 .TP
59 .B /shr
60 .TP
61 .B /tmp
62 All empty unwritable directories, place holders for mounted services and directories.
63 .TP
64 .B /mnt
65 A directory containing mount points for applications.
66 .TP
67 .B /n
68 A directory containing mount points for file trees imported from
69 remote systems.
70 .TP
71 .B /386
72 .TP
73 .B /68000
74 .TP
75 .B /68020
76 .TP
77 .B /alpha
78 .TP
79 .B /arm
80 .TP
81 .B /mips
82 .TP
83 .B /power
84 .TP
85 .B /sparc
86 Each CPU architecture supported by Plan 9 has a directory in the root containing
87 architecture-specific files, to be selected according to
88 .B $objtype
89 or
90 .B $cputype
91 (see
92 .IR 2c (1)
93 and
94 .IR init (8)).
95 Here we list only those for
96 .BR /386 .
97 .TP
98 .B /386/init
99 The initialization program used during bootstrapping; see
100 .IR init (8).
101 .TP
102 .B /386/bin
103 Directory containing binaries for the Intel x86 architecture.
104 .TP
105 .B "/386/bin/aux
106 .TP
107 .B /386/bin/ip
108 .TP
109 etc.
110 Subdirectories of
111 .B /386/bin
112 containing auxiliary tools and collecting related programs.
113 .TP
114 .B /386/lib
115 Directory of object code libraries as used by
116 .B 8l
117 (see
118 .IR 2l (1)).
119 .TP
120 .B /386/include
121 Directory of x86-specific C include files.
122 .TP
123 .B /386/9*
124 The files in
125 .B /386
126 beginning with a
127 .B 9
128 are binaries of the operating system or its bootstrap loader.
129 .TP
130 .B /386/mkfile
131 Selected by
132 .IR mk (1)
133 when
134 .B $objtype
135 is
136 .BR 386 ,
137 this file configures
138 .B mk
139 to compile for the Intel x86 architecture.
140 .TP
141 .B /rc
142 Isomorphic to the architecture-dependent directories, this holds executables
143 and libraries for the shell,
144 .IR rc (1).
145 .TP
146 .B /rc/bin
147 Directory of shell executable files.
148 .TP
149 .B /rc/lib
150 Directory of shell libraries.
151 .TP
152 .B /rc/lib/rcmain
153 Startup code for
154 .IR rc (1).
155 .TP
156 .B /lib
157 Collections of data, generally not parts of programs.
158 .TP
159 .B /lib/mammals
160 .TP
161 .B /lib/sky
162 .TP
163 etc.
164 Databases.
165 .TP
166 .B /lib/ndb
167 The network database used by the networking software; see
168 .IR ndb (6)
169 and
170 .IR ndb (8).
171 .TP
172 .B /lib/namespace
173 The file used by
174 .B newns
175 (see
176 .IR auth (2))
177 to establish the default name space; see
178 .IR namespace (6).
179 .TP
180 .B /lib/font/bit
181 Bitmap font files.
182 .TP
183 .B /lib/font/hershey
184 Vector font files.
185 .TP
186 .B /lib/rfc
187 Directory of Internet `Requests For Comments',
188 ranging from trivia to specifications.
189 .TP
190 .B /lib/rfc/grabrfc
191 Maintains RFC collection; usually run from
192 .IR cron
193 (see
194 .IR auth (8)).
195 .TP
196 .B /sys
197 System software.
198 .TP
199 .B /sys/include
200 Directory of machine-independent C include files.
201 .TP
202 .B /sys/lib
203 Pieces of programs not easily held in the various
204 .BR bins .
205 .TP
206 .B /sys/lib/acid
207 Directory of
208 .IR acid (1)
209 load modules.
210 .TP
211 .B /sys/lib/dist
212 Software used to assemble the distribution's installation floppy.
213 .TP
214 .B /sys/lib/troff
215 Directory of
216 .IR troff (1)
217 font tables and macros.
218 .TP
219 .B /sys/lib/yaccpar
220 The
221 .IR yacc (1)
222 parser.
223 .TP
224 .B /sys/man
225 The manual.
226 .TP
227 .B /sys/doc
228 Other system documentation.
229 .TP
230 .B /sys/log
231 Log files created by various system services.
232 .TP
233 .B /sys/src
234 Top-level directory of system sources.
235 .TP
236 .B /sys/src/cmd
237 Source to the commands in the
238 .B bin
239 directories.
240 .TP
241 .B /sys/src/9
242 Source to the operating system for terminals and CPU servers.
243 .TP
244 .B /sys/src/fs
245 Source to the operating system for file servers.
246 .TP
247 .B /sys/src/lib*
248 Source to the libraries.
249 .TP
250 .B /usr
251 A directory containing home directories of users.
252 .TP
253 .B /mail
254 Directory of electronic mail; see
255 .IR mail (1).
256 .TP
257 .B /mail/box
258 Directory of users' mail box files.
259 .TP
260 .B /mail/lib
261 Directory of alias files, etc.
262 .TP
263 .B /acme
264 Directory of tools for
265 .IR acme (1).
266 .TP
267 .B /cron
268 Directory of files for
269 .IR cron (8).
270 .TP
271 .BI /cfg/ system
272 .IR System -specific
273 files, often addenda to their namesakes,
274 notably
275 .BR cpurc ,
276 .BR termrc ,
277 .BR namespace ,
278 and
279 .BR consoledb .
280 .PD
281 .PP
282 The following files and directories are modified in the standard
283 name space, as defined by
284 .B /lib/namespace
285 (see
286 .IR namespace (6)).
287 .TF /sys/src/cmd
288 .TP
289 .B /
290 The root of the name space.  It is a kernel device,
291 .IR root (3),
292 serving a number of local mount points such as
293 .B /bin
294 and
295 .B /dev
296 as well as the bootstrap program
297 .BR /boot .
298 Unioned with
299 .B /
300 is the root of the main file server.
301 .TP
302 .B /boot
303 Compiled into the operating system kernel, this file establishes
304 the connection to the main file server and starts
305 .BR init ;
306 see
307 .IR boot (8)
308 and
309 .IR init (8).
310 .TP
311 .B /bin
312 Mounted here is a union directory composed of
313 .BR /$objtype/bin ,
314 .BR /rc/bin ,
315 .BR $home/$objtype/bin ,
316 etc., so
317 .B /bin
318 is always the directory containing the appropriate executables
319 for the current architecture.
320 .TP
321 .B /dev
322 Mounted here is a union directory containing I/O devices such as the
323 console
324 .RI ( cons (3)),
325 the interface to the raster display
326 .RI ( draw (3)),
327 etc.
328 The window system,
329 .IR rio (1),
330 prefixes
331 this directory with its own version,
332 overriding many device
333 files with its own, multiplexed simulations of them.
334 .TP
335 .B /env
336 Mounted here is the environment device,
337 .IR env (3),
338 which holds environment variables such as
339 .BR $cputype .
340 .TP
341 .B /net
342 Mounted here is a union directory formed of all the network devices
343 available.
344 .TP
345 .B /net/cs
346 The communications point for the connection server,
347 .B ndb/cs
348 (see
349 .IR ndb (8)).
350 .TP
351 .B /net/dns
352 The communications point for the Domain Name Server,
353 .B ndb/dns
354 (see
355 .IR ndb (8)).
356 .TP
357 .B /net/tcp
358 .TP
359 .B /net/udp
360 Directories holding the IP protocol devices
361 (see
362 .IR ip (3)).
363 .TP
364 .B /proc
365 Mounted here is the process device,
366 .IR proc (3),
367 which provides debugging access to active processes.
368 .TP
369 .B /fd
370 Mounted here is the dup device,
371 .IR dup (3),
372 which holds pseudonyms for open file descriptors.
373 .TP
374 .B /shr
375 Mounted here is the global mountpoint device,
376 .IR shr (3),
377 which holds mounted filesystems visible in all namespaces.
378 .TP
379 .B /srv
380 Mounted here is the service registry,
381 .IR srv (3),
382 which holds connections to file servers.
383 .TP
384 .B /srv/boot
385 The communication channel to the main file server for the machine.
386 .TP
387 .B /mnt/factotum
388 Mount point for
389 .IR factotum (4).
390 .TP
391 .B /mnt/wsys
392 Mount point for the window system.
393 .TP
394 .B /mnt/term
395 Mount point for the terminal's name space as seen by the CPU server
396 after a
397 .IR cpu (1)
398 command.
399 .TP
400 .B /n/kremvax
401 A place where machine
402 .BR kremvax 's
403 name space may be mounted.
404 .TP
405 .B /tmp
406 Mounted here is each user's private
407 .B tmp, 
408 .BR $home/tmp .
409 .SH SEE ALSO
410 .IR intro (1),
411 .IR namespace (6)