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