From 06aa63b6f19131071800985746b445dee42d91eb Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Fri, 10 Jun 2005 20:29:09 +0000 Subject: Large number of small fixes to the layout and the build system. (This used to be commit 73fac0653c774a8ed8654b064fd63d4e486f6b0f) --- docs/Samba3-HOWTO/TOSHARG-Unicode.xml | 511 ++++++++++++++++++++++++++++++++++ 1 file changed, 511 insertions(+) create mode 100644 docs/Samba3-HOWTO/TOSHARG-Unicode.xml (limited to 'docs/Samba3-HOWTO/TOSHARG-Unicode.xml') diff --git a/docs/Samba3-HOWTO/TOSHARG-Unicode.xml b/docs/Samba3-HOWTO/TOSHARG-Unicode.xml new file mode 100644 index 0000000000..a858a38508 --- /dev/null +++ b/docs/Samba3-HOWTO/TOSHARG-Unicode.xml @@ -0,0 +1,511 @@ + + + + + &author.jelmer; + &author.jht; + + TAKAHASHIMotonobu + +
monyo@home.monyo.com
+ + Japanese character support + + 25 March 2003 + + +Unicode/Charsets + + +Features and Benefits + + +Every industry eventually matures. One of the great areas of maturation is in +the focus that has been given over the past decade to make it possible for anyone +anywhere to use a computer. It has not always been that way, in fact, not so long +ago it was common for software to be written for exclusive use in the country of +origin. + + + +Of all the effort that has been brought to bear on providing native +language support for all computer users, the efforts of the +Openi18n organization +is deserving of special mention. + + + +Samba-2.x supported a single locale through a mechanism called +codepages. Samba-3 is destined to become a truly trans-global +file and printer-sharing platform. + + + + + +What Are Charsets and Unicode? + + +Computers communicate in numbers. In texts, each number will be +translated to a corresponding letter. The meaning that will be assigned +to a certain number depends on the character set (charset) + that is used. + + + +A charset can be seen as a table that is used to translate numbers to +letters. Not all computers use the same charset (there are charsets +with German umlauts, Japanese characters, and so on). The American Standard Code +for Information Interchange (ASCII) encoding system has been the normative character +encoding scheme used by computers to date. This employs a charset that contains +256 characters. Using this mode of encoding each character takes exactly one byte. + + + +There are also charsets that support extended characters, but those need at least +twice as much storage space as does ASCII encoding. Such charsets can contain +256 * 256 = 65536 characters, which is more than all possible +characters one could think of. They are called multi-byte charsets because they use +more then one byte to store one character. + + + +One standardized multi-byte charset encoding scheme is known as +unicode. A big advantage of using a +multi-byte charset is that you only need one. There is no need to make sure two +computers use the same charset when they are communicating. + + +Old Windows clients use single-byte charsets, named +codepages, by Microsoft. However, there is no support for +negotiating the charset to be used in the SMB/CIFS protocol. Thus, you +have to make sure you are using the same charset when talking to an older client. +Newer clients (Windows NT, 200x, XP) talk unicode over the wire. + + + + +Samba and Charsets + + +As of Samba-3, Samba can (and will) talk unicode over the wire. Internally, +Samba knows of three kinds of character sets: + + + + + + + This is the charset used internally by your operating system. + The default is UTF-8, which is fine for most + systems, which covers all characters in all languages. The default + in previous Samba releases was to save filenames in the encoding of the + clients, for example cp850 for western european countries. + + + + + + This is the charset Samba will use to print messages + on your screen. It should generally be the same as the unix charset. + + + + + + This is the charset Samba uses when communicating with + DOS and Windows 9x/Me clients. It will talk unicode to all newer clients. + The default depends on the charsets you have installed on your system. + Run testparm -v | grep "dos charset" to see + what the default is on your system. + + + + + + + +Conversion from Old Names + +Because previous Samba versions did not do any charset conversion, +characters in filenames are usually not correct in the UNIX charset but only +for the local charset used by the DOS/Windows clients. + +Bjoern Jacke has written a utility named convmv +that can convert whole directory structures to different charsets with one single command. + + + + + +Japanese Charsets + + +Setting up Japanese charsets is quite difficult. This is mainly because: + + + + The Windows character set is extended from the original legacy Japanese + standard (JIS X 0208) and is not standardized. This means that the strictly + standardized implementation cannot support the full Windows character set. + + + Mainly for historical reasons, there are several encoding methods in + Japanese, which are not fully compatible with each other. There are + two major encoding methods. One is the Shift_JIS series, it is used in Windows + and some UNIX's. The other is the EUC-JP series, used in most UNIX's + and Linux. Moreover, Samba previously also offered several unique encoding + methods, named CAP and HEX, to keep interoperability with CAP/NetAtalk and + UNIX's which can't use Japanese filenames. Some implementations of the + EUC-JP series can't support the full Windows character set. + + + There are some code conversion tables between Unicode and legacy + Japanese character sets. One is compatible with Windows, another one + is based on the reference of the Unicode consortium and others are + a mixed implementation. The Unicode consortium does not officially + define any conversion tables between Unicode and legacy character + sets so there cannot be standard one. + + + The character set and conversion tables available in iconv() depends + on the iconv library that is available. Next to that, the Japanese locale + names may be different on different systems. This means that the value of + the charset parameters depends on the implementation of iconv() you are using. + + + Though 2 byte fixed UCS-2 encoding is used in Windows internally, + Shift_JIS series encoding is usually used in Japanese environments + as ASCII encoding is in English environments. + + + +Basic Parameter Setting + + + and + + should be set to the locale compatible with the character set + and encoding method used on Windows. This is usually CP932 + but sometimes has a different name. + + + + can be either Shift_JIS series, + EUC-JP series and UTF-8. UTF-8 is always available but the availability of other locales + and its name itself depends on the system. + + + + Additionally, you can consider to use the Shift_JIS series as the + value of the + parameter by using the vfs_cap module, which does the same thing as + setting coding system = CAP in the Samba 2.2 series. + + + + Where to set + to is a difficult question. Here is a list of details, advantages and + disadvantages of using a certain value. + + + + Shift_JIS series + + Shift_JIS series means a locale which is equivalent to Shift_JIS, + used as a standard on Japanese Windows. In the case of Shift_JIS, + for example if a Japanese file name consist of 0x8ba4 and 0x974c + (a 4 bytes Japanese character string meaning share) and .txt + is written from Windows on Samba, the file name on UNIX becomes + 0x8ba4, 0x974c, .txt (a 8 bytes BINARY string), same as Windows. + + + Since Shift_JIS series is usually used on some commercial based + UNIX's; hp-ux and AIX as Japanese locale (however, it is also possible + to use the EUC-JP series), To use Shift_JIS series on these platforms, + Japanese file names created from Windows can be referred to also on + UNIX. + + + If your UNIX is already working with Shift_JIS and there is a user + who needs to use Japanese file names written from Windows, the + Shift_JIS series is the best choice. However, broken file names + may be displayed and some commands which cannot handle non-ASCII + filenames may be aborted during parsing filenames. especially there + may be \ (0x5c) in file names, which need to be handled carefully. + So you had better not touch file names written from Windows on UNIX. + + + + Note that most Japanized free software actually works with EUC-JP + only. You had better verify if the Japanized free software can work + with Shift_JIS. + + + + + EUC-JP series + + EUC-JP series means a locale which is equivalent to the industry + standard called EUC-JP, widely used in Japanese UNIX (although EUC + contains specifications for languages other than Japanese, such as + EUC-KR). In the case of EUC-JP series, for example if a Japanese + file name consist of 0x8ba4 and 0x974c and .txt is written from + Windows on Samba, the file name on UNIX becomes 0xb6a6, 0xcdad, + .txt (a 8 bytes BINARY string). + + + + Since EUC-JP is usually used on Open source UNIX, Linux and FreeBSD, + and on commercial based UNIX, Solaris, IRIX and Tru64 UNIX as + Japanese locale (however, it is also possible on Solaris to use + Shift_JIS and UTF-8, on Tru64 UNIX to use Shift_JIS). To use EUC-JP + series, most Japanese file names created from Windows can be + referred to also on UNIX. Also, most Japanized free software work + mainly with EUC-JP only. + + + + It is recommended to choose EUC-JP series when using Japanese file + names on these UNIX. + + + + Although there is no character which needs to be carefully treated + like \ (0x5c), broken file names may be displayed and some + commands which cannot handle non-ASCII filenames may be aborted + during parsing filenames. + + + + Moreover, if you built Samba using differently installed libiconv, + eucJP-ms locale included in libiconv and EUC-JP series locale + included in OS may not be compatible. In this case, you may need to + avoid using incompatible characters for file names. + + + + + UTF-8 + + UTF-8 means a locale which is equivalent to UTF-8, the international + standard defined by Unicode consortium. In UTF-8, a character is + expressed using 1-3 bytes. In case of Japanese, most characters + are expressed using 3 bytes. Since on Windows Shift_JIS, where a + character is expressed with 1 or 2 bytes, is used to express + Japanese, basically a byte length of a UTF-8 string grows 1.5 times + the length of a original Shift_JIS string. In the case of UTF-8, + for example if a Japanese file name consist of 0x8ba4 and 0x974c and + .txt is written from Windows on Samba, the file name on UNIX + becomes 0xe585, 0xb1e6, 0x9c89, .txt (a 10 bytes BINARY string). + + + + For systems where iconv() is not available or where iconv()'s locales + are not compatible with Windows, UTF-8 is the only locale available. + + + + There are no systems that use UTF-8 as default locale for Japanese. + + + + Some broken file names may be displayed and some commands which + cannot handle non-ASCII filenames may be aborted during parsing + filenames. especially there may be \ (0x5c) in file names, which + need to be handled carefully. So you had better not touch file names + written from Windows on UNIX. + + + + In addition, although it is not directly concerned with Samba, since + there is a delicate difference between iconv() function, which is + generally used on UNIX and the functions used on other platforms, + such as Windows and Java about the conversion table between + Shift_JIS and Unicode, you should be carefully to handle UTF-8. + + + + Although Mac OS X uses UTF-8 as its encoding method for filenames, + it uses an extended UTF-8 specification that Samba cannot handle so + UTF-8 locale is not available for Mac OS X. + + + + + Shift_JIS series + vfs_cap (CAP encoding) + + CAP encoding means a specification using in CAP and NetAtalk, file + server software for Macintosh. In the case of CAP encoding, for + example if a Japanese file name consist of 0x8ba4 and 0x974c and + .txt is written from Windows on Samba, the file name on UNIX + becomes :8b:a4:97L.txt (a 14 bytes ASCII string). + + + + For CAP encoding a byte which cannot be expressed as an ASCII + character (0x80 or above) is encoded as :xx form. You need to take + care of containing a \(0x5c) in a filename but filenames are not + broken in a system which cannot handle non-ASCII filenames. + + + + The greatest merit of CAP encoding is the compatibility of encoding + filenames with CAP or NetAtalk, file server software of Macintosh. + Since they usually write a file name on UNIX with CAP encoding, if a + directory is shared with both Samba and NetAtalk, you need to use + CAP encoding to avoid non-ASCII filenames are broken. + + + + However, recently there are some systems where NetAtalk has been + patched to write filenames with EUC-JP (i.e. Japanese original Vine Linux). + Here you need to choose EUC-JP series instead of CAP encoding. + + + + vfs_cap itself is available for non Shift_JIS series locales for + systems which cannot handle non-ASCII characters or systems which + shares files with NetAtalk. + + + + To use CAP encoding on Samba-3, you should use the unix charset parameter and VFS + as follows: + + +VFS CAP + +the locale name "CP932" may be different +CP932 +CP932 + + +cap + + + + You should set CP932 if using GNU libiconv for unix charset. Setting this, + filenames in the cap-share share are written with CAP encoding. + + + + + + + +Individual Implementations + + +Here is some additional information regarding individual implementations: + + + + GNU libiconv + + To handle Japanese correctly, you should apply the patch + libiconv-1.8-cp932-patch.diff.gz + to libiconv-1.8. + + + + Using the patched libiconv-1.8, these settings are available: + + + + + +dos charset = CP932 +unix charset = CP932 / eucJP-ms / UTF-8 + | | + | +-- EUC-JP series + +-- Shift_JIS series +display charset = CP932 + + + + Other Japanese locales (for example Shift_JIS and EUC-JP) should not + be used for the lack of the compatibility with Windows. + + + + + GNU glibc + + To handle Japanese correctly, you should apply a patch + to glibc-2.2.5/2.3.1/2.3.2 or should use the patch-merged versions, glibc-2.3.3 or later. + + + + Using the above glibc, these setting are available: + + + +CP932 +CP932 / eucJP-ms / UTF-8 +CP932 + + + + Other Japanese locales (for example Shift_JIS and EUC-JP) should not + be used for the lack of the compatibility with Windows. + + + + + + + + + Migration from Samba-2.2 Series + + +Prior to Samba-2.2 series coding system parameter is used as + parameter of the Samba-3 series. +Next table shows the mapping table when migrating from the Samba-2.2 series to Samba-3. + + + + Japanese Character Sets in Samba-2.2 and Samba-3 + + + + + + Samba-2.2 Coding SystemSamba-3 unix charset + + + SJISShift_JIS series + EUCEUC-JP series + EUC3Only exists in Japanese Samba versionEUC-JP series + CAPShift_JIS series + VFS + HEXcurrently none + UTF8UTF-8 + UTF8-MacOnly exists in Japanese Samba versioncurrently none + othersnone + + +
+ + + + + + + Common Errors + + + CP850.so Can't Be Found + + Samba is complaining about a missing CP850.so file. + + Answer: CP850 is the default . + The is used to convert data to the codepage used by your dos clients. + If you do not have any dos clients, you can safely ignore this message. + + CP850 should be supported by your local iconv implementation. Make sure you have all the required packages installed. + If you compiled Samba from source, make sure to configure found iconv. + + + + -- cgit