docs/yodldocs/make_smbcodepage.1.yo

   1 mailto(samba-bugs@samba.org)
   2
   3 manpage(make_smbcodepage htmlcommand((1)))(1)(23 Oct 1998)(Samba)(SAMBA)
   4
   5 label(NAME)
   6 manpagename(make_codepage)(Construct a codepage file for Samba)
   7
   8 label(SYNOPSIS)
   9 manpagesynopsis()
  10
  11 bf(make_smbcodepage) [link(c|d)(cord)] link(codepage)(codepage) link(inputfile)(inputfile) link(outputfile)(outputfile)
  12
  13 label(DESCRIPTION)
  14 manpagedescription()
  15
  16 This program is part of the bf(Samba) suite.
  17
  18 bf(make_smbcodepage) compiles or de-compiles codepage files for use
  19 with the internationalization features of Samba 2.0
  20
  21 label(OPTIONS)
  22 manpageoptions()
  23
  24 startdit()
  25
  26 label(cord)
  27 dit(c|d) This tells bf(make_smbcodepage) if it is compiling (bf(c)) a text
  28 format code page file to binary, or (bf(d)) de-compiling a binary codepage
  29 file to text.
  30
  31 label(codepage)
  32 dit(codepage) This is the codepage we are processing (a number, e.g. 850).
  33
  34 label(inputfile)
  35 dit(inputfile) This is the input file to process. In the 'bf(c)' case this
  36 will be a text codepage definition file such as the ones found in the
  37 Samba em(source/codepages) directory. In the 'bf(d)' case this will be the
  38 binary format codepage definition file normally found in the
  39 em(lib/codepages) directory in the Samba install directory path.
  40
  41 label(outputfile)
  42 dit(outputfile) This is the output file to produce.
  43
  44 endit()
  45
  46 label(SambaCodepageFiles)
  47 manpagesection(Samba Codepage Files)
  48
  49 A text Samba codepage definition file is a description that tells
  50 Samba how to map from upper to lower case for characters greater than
  51 ascii 127 in the specified DOS code page.  Note that for certain DOS
  52 codepages (437 for example) mapping from lower to upper case may be
  53 non-symmetrical. For example, in code page 437 lower case a acute maps to
  54 a plain upper case A when going from lower to upper case, but
  55 plain upper case A maps to plain lower case a when lower casing a
  56 character.
  57
  58 A binary Samba codepage definition file is a binary representation of
  59 the same information, including a value that specifies what codepage
  60 this file is describing.
  61
  62 As Samba does not yet use UNICODE (current for Samba version 2.0) you
  63 must specify the client code page that your DOS and Windows clients
  64 are using if you wish to have case insensitivity done correctly for
  65 your particular language. The default codepage Samba uses is 850
  66 (Western European). Text codepage definition sample files are
  67 provided in the Samba distribution for codepages 437 (USA), 737
  68 (Greek), 850 (Western European) 852 (MS-DOS Latin 2), 861 (Icelandic),
  69 866 (Cyrillic), 932 (Kanji SJIS), 936 (Simplified Chinese), 949
  70 (Hangul) and 950 (Traditional Chinese). Users are encouraged to write
  71 text codepage definition files for their own code pages and donate
  72 them to email(samba-bugs@samba.org). All codepage files in the
  73 Samba em(source/codepages) directory are compiled and installed when a
  74 em('make install') command is issued there.
  75
  76 The client codepage used by the url(bf(smbd))(smbd.8.html) server is
  77 configured using the url(bf(client code
  78 page))(smb.conf.5.html#clientcodepage) parameter in the
  79 url(bf(smb.conf))(smb.conf.5.html) file.
  80
  81 label(FILES)
  82 manpagefiles()
  83
  84 bf(codepage_def.<codepage>)
  85
  86 These are the input (text) codepage files provided in the Samba
  87 em(source/codepages) directory.
  88
  89 A text codepage definition file consists of multiple lines
  90 containing four fields. These fields are :
  91
  92 startit()
  93
  94 it() bf(lower): which is the (hex) lower case character mapped on this
  95 line.
  96
  97 it() bf(upper): which is the (hex) upper case character that the lower
  98 case character will map to.
  99
 100 it() bf(map upper to lower) which is a boolean value (put either True
 101 or False here) which tells Samba if it is to map the given upper case
 102 character to the given lower case character when lower casing a
 103 filename.
 104
 105 it() bf(map lower to upper) which is a boolean value (put either True
 106 or False here) which tells Samba if it is to map the given lower case
 107 character to the given upper case character when upper casing a
 108 filename.
 109
 110 endit()
 111
 112 bf(codepage.<codepage>) These are the output (binary) codepage files
 113 produced and placed in the Samba destination em(lib/codepage)
 114 directory.
 115
 116 label(INSTALLATION)
 117 manpagesection(INSTALLATION)
 118
 119 The location of the server and its support files is a matter for
 120 individual system administrators. The following are thus suggestions
 121 only.
 122
 123 It is recommended that the bf(make_smbcodepage) program be installed
 124 under the em(/usr/local/samba) hierarchy, in a directory readable by
 125 all, writeable only by root. The program itself should be executable
 126 by all.  The program should NOT be setuid or setgid!
 127
 128 label(VERSION)
 129 manpagesection(VERSION)
 130
 131 This man page is correct for version 2.0 of the Samba suite.
 132
 133 label(SEEALSO)
 134 manpageseealso()
 135
 136 url(bf(smb.conf(5)))(smb.conf.5.html), url(bf(smbd (8)))(smbd.8.html)
 137
 138 label(AUTHOR)
 139 manpageauthor()
 140
 141 The original Samba software and related utilities were created by
 142 Andrew Tridgell email(samba-bugs@samba.org). Samba is now developed
 143 by the Samba Team as an Open Source project similar to the way the
 144 Linux kernel is developed.
 145
 146 The original Samba man pages were written by Karl Auer. The man page
 147 sources were converted to YODL format (another excellent piece of Open
 148 Source software, available at
 149 url(bf(ftp://ftp.icce.rug.nl/pub/unix/))(ftp://ftp.icce.rug.nl/pub/unix/))
 150 and updated for the Samba2.0 release by Jeremy Allison.
 151 email(samba-bugs@samba.org).
 152
 153 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
 154 list of contributors and details on how to submit bug reports,
 155 comments etc.