]> git.lizzy.rs Git - plan9front.git/blob - sys/man/6/face
Import sources from 2011-03-30 iso image - sys/man
[plan9front.git] / sys / man / 6 / face
1 .TH FACE 6
2 .SH NAME
3 face \- face files
4 .SH DESCRIPTION
5 The directories
6 .B /usr/$user/lib/face
7 and
8 .B /lib/face
9 contain a hierarchy of images of people.
10 In those directories are subdirectories named by the sizes of
11 the corresponding image files:
12 .B 48x48x1
13 (48 by 48 pixels, one bit per pixel);
14 .B 48x48x2
15 (48 by 48 pixels, two (grey) bits per pixel);
16 .B 48x48x4
17 (48 by 48 pixels, four (grey) bits per pixel);
18 .B 48x48x8
19 (48 by 48 pixels, eight (color-mapped) bits per pixel);
20 .B 512x512x8
21 (512 by 512 pixels, eight (color-mapped) bits per pixel);
22 .B 512x512x24
23 (512 by 512 pixels, twenty-four bits per pixel (3 times 8 bits
24 per color)).
25 The large files serve no special purpose; they are stored
26 as images
27 (see
28 .IR image (6)).
29 The small files are the `icons'  displayed by
30 .B faces
31 and
32 .B seemail
33 (see
34 .IR faces (1));
35 for depths less than 4, their format is special.
36 .PP
37 One- and two-bit deep icons are stored as text, one line of the file to one scan line
38 of display.
39 Each line is divided into 8-bit, 16-bit, or 32-bit big-endian words,
40 stored as a list of comma-separated hexadecimal C constants,
41 such as:
42 .IP
43 .EX
44 0x9200, 0x1bb0, 0x003e,
45 .EE
46 .PP
47 This odd format is historical and the programs that read it
48 are somewhat forgiving about blanks and the need for commas.
49 .PP
50 The files
51 .BR  lib/face/*/.dict
52 hold a correspondence between users at machines
53 and face files.
54 The format is
55 .IP
56 .EX
57 .I machine\fB/\fPuser directory\fB/\fPfile\fB.\fPver
58 .EE
59 .PP
60 The
61 .I machine
62 is the domain name of the machine sending the message,
63 and
64 .I user
65 the name of the user sending it, as recorded in
66 .BR /sys/log/mail .
67 The
68 .I directory
69 is a further subdirectory of (say)
70 .BR /lib/face/48x48x1 ,
71 named by a single letter corresponding to the first character
72 of the user names.  The
73 .I file
74 is the name of the file, typically but not always the user name,
75 and
76 .I ver
77 is a number to distinguish different images, for example to
78 distinguish the image for Bill Gates from the image for Bill Joy,
79 both of which might otherwise be called
80 .BR b/bill .
81 For example, Bill Gates might be represented by the line
82 .IP
83 .EX
84 microsoft.com/bill b/bill.1
85 .EE
86 .PP
87 If multiple entries exist for a user in the various
88 .B .dict
89 files,
90 .I faces
91 chooses the highest pixel size less than or equal to that of the
92 display on which it is running.
93 .PP
94 Finally, or rather firstly, the file
95 .B /lib/face/.machinelist
96 contains a list of machine/domain pairs, one per line,
97 to map any of a set of machines to a single domain name to
98 be looked up in the
99 .B .dict
100 files.  The machine name may be a regular expression,
101 so for example the entry
102 .IP
103 .EX
104 \&.*research\e.bell-labs\e.com    astro
105 .EE
106 .PP
107 maps any of the machines in Bell Labs Research into the
108 shorthand name
109 .BR astro ,
110 which then appears as a domain name in the
111 .B .dict
112 files.
113 .SH "SEE ALSO"
114 .IR mail (1),
115 .IR tweak (1),
116 .IR image (6)