examples/pdb: fix and validate pdb_test_init() prototype via static_decl_pdb;
[sfrench/samba-autobuild/.git] / examples / validchars / readme
1 Note: All files in this directory are DOS formatted (CRLF line terminator).\r
2 \r
3 !!! VIRUS WARNING !!! I do not know if VALIDCHR.COM is virus free !!!\r
4 I think that my system is virus free here because I do not run any games\r
5 or other copied software. I only run Shareware/Freeware etc. from CD-ROMs\r
6 or from registered disks, however I do not use viral scanners because\r
7 I have not registered any (I consider `having no sex' is better than\r
8 `testing for AIDS on a regular basis', if you know what I mean).\r
9 \r
10 This is VALIDCHR, a little DOS program I wrote to create\r
11 an apropriate `valid chars =' config parameter.\r
12 It is freeware and is thought to be distributed freely with Samba.\r
13 \r
14 WARNING:\r
15         Your SMB driver may use another character map as the one VALIDCHR\r
16         sees. The only way you can tell this is that some file names fail.\r
17         Under Win95 everything is fine, though.\r
18 \r
19 Usage:\r
20         c:\r
21         mkdir junk_dir\r
22         cd junk_dir\r
23         a:validchr > a:output.log\r
24         cd ..\r
25         rmdir junk_dir\r
26 \r
27 Siedeffects:\r
28         Files named *.TST may be deleted.\r
29 \r
30 Verification:\r
31         For diagnostic purpose you can run VALIDCHR on a Samba mounted drive.\r
32         Then you can use unix diff to compare the output of the network and\r
33         the hard drive. These two outputs usually differ! However there\r
34         should be few differences. I get following on Win95 (c: visa e:)\r
35         104c104\r
36         < 152: length 0\r
37         ---\r
38         > 152: 95\r
39         (diff line for `valid chars =' deleted because it's uninteresting)\r
40         You can see, `y diaresis' can be mapped on the network drive while\r
41         it cannot be mapped on the hard drive. Everything else is identical.\r
42         However this gives a hint that one can improve the mapping.\r
43 \r
44 Bugs:\r
45         Yes, probably some.\r
46 \r
47 \r
48 VALIDCHR must be run on the system which character mapping should be probed.\r
49 It must be run on the hard drive for this. VALIDCHR ALTERS THE CURRENT\r
50 DIRECTORY AND REMOVES SOME FILES, SO ALWAYS RUN IT IN A junk DIRECTORY !!!\r
51 You should redirect the output of VALIDCHR. At the end of the output is a\r
52 line like\r
53    valid chars = x:y y:x x:x ... a:b c ...\r
54 which is suitable for your smb.conf file. (you should remove the DOS CR\r
55 character, because DOS uses CRLF while Unix uses LF only.)\r
56 \r
57 Note that some mappings at the beginning of the `valid chars =' line like\r
58 A:B B:A B:B\r
59 might look a little bit strange to you, however sometimes character A\r
60 has to be mapped to character B independently of a default mapping\r
61 to uppercase or lowercase while character B must not be touched. I found\r
62 this out the hard way ... Consider it a crude workaround, because Samba\r
63 lacks the possibility to map characters in one direction only!\r
64 \r
65 VALIDCHR usually issues one warning for character 32.\r
66 You may ignore these and any other warnings.\r
67 \r
68 VALIDCHR does not test for character NUL (this is the directory end marker).\r
69 \r
70 validchr.c is the source code to validchr.com\r
71         You may do anything with the source code (copy, change, sell, burn)\r
72 validchr.com is a Borland C compiled binary.\r
73         Beware, it may contain a virus (if my system contains one).\r
74 nwdos70.out is the output of an VALIDCHR-run under Novell DOS 7.0\r
75         while no codepage (no display.sys) was active.\r
76 msdos70.out is the output of an VALIDCHR-run under MS-DOS 7.0 (Win95 DOS)\r
77         while codepage 850 was active.\r
78 \r
79 I have no other MS-DOS systems at home currently.\r
80 (I have access to MS-DOS 3.0, 3.2, 3.3, 5.0 and 6.22, however I have no time\r
81  to run VALIDCHR there)\r
82 \r
83 Some words to the output\r
84 (for people not fammiliar with programming language C):\r
85 \r
86 probed_char:    [text] mapped_char\r
87 \r
88 probed_char     is the character probed to be written to disk\r
89 text            may be empty or contain:\r
90                 open    File could not be opened.\r
91                 close   File could not be closed (should not happen)\r
92                 length  File name was shortened (usually occurs on SPC) \r
93                 unlink  File cannot be unlinked (usually when open fails)\r
94 mapped_char     is the character which is used by MS-DOS in the directory\r
95                 This is usually the uppercase character.\r
96                 The mapped character is 0 if something failed (you may say\r
97                 that the character is not supported)\r
98 \r
99 The last line in the output is documented in the smb.conf manual page ;)\r
100 \r
101 tino@augsburg.net\r