Bug 4240 - The documentation for "display charset" should be updated
Summary: The documentation for "display charset" should be updated
Status: REOPENED
Alias: None
Product: Samba 3.0
Classification: Unclassified
Component: Docs (show other bugs)
Version: 3.0.23d
Hardware: All All
: P3 normal
Target Milestone: none
Assignee: Samba Bugzilla Account
QA Contact: Samba Documentation QA Contact~
URL:
Keywords:
: 3471 (view as bug list)
Depends on:
Blocks:
 
Reported: 2006-11-20 10:23 UTC by TAKAHASHI Motonobu
Modified: 2010-03-06 09:30 UTC (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description TAKAHASHI Motonobu 2006-11-20 10:23:13 UTC
Currently the default value for "display charset" is LOCALE, not ASCII.
Also SWAT no longer uses this value.
So displaycharset.xml should be updated for example:

Specifies the charset that samba will use
to print messages to stdout and stderr.
The default value is "LOCALE", which means automatically set, depending on the current locale.

default: LOCALE
example: UTF8
Comment 1 TAKAHASHI Motonobu 2006-11-20 10:31:36 UTC
some additional informations...

Specifies the charset that samba will use to print messages to stdout and stderr.
SWAT no longer uses this value in Samba 3.0.8 and above .

The default value is "LOCALE", which means automatically set, depending on the
current locale. You should never need to change this parameter.

default: LOCALE
example: UTF8
Comment 2 Volker Lendecke 2006-11-21 07:31:25 UTC
Fixed with samba-docs r996. Thanks :-)

Volker
Comment 3 Björn Jacke 2006-11-21 09:23:09 UTC
*** Bug 3471 has been marked as a duplicate of this bug. ***
Comment 4 TAKAHASHI Motonobu 2006-11-21 10:35:29 UTC
I checked the current svn code.
http://viewcvs.samba.org/cgi-bin/viewcvs.cgi?root=samba-docs&rev=996&view=rev

This modification is not enough.

1) As I said, SWAT no longer uses this value.
  see http://us1.samba.org/samba/history/samba-3.0.8.html
  * Do not use display charset for swat output.

  Prior to Samba 3.0.7, SWAT uses d_printf(), but at Samba 3.0.8, 
  d_printf() is replaced by normal printf().

2) The meaning of "LOCALE" should be described, because this is Samba-original 
locale and have a special meaning.

3) The value should not be same as "unix charset", should be left to display
  the charset depending on UNIX-side locale setting.
  If you set the value same as "unix charset", the output for commands are 
  always displayed in the charset of "unix charset", regardless of current 
  locale.
Comment 5 Björn Jacke 2006-11-21 11:32:39 UTC
right, Volker can you please fix the docs in svn:
SWAT has nothing to do with display charset anymore (remove mentioning of swat) and LOCALE means charset of current locale. Usage is for output of samba command line tools only. (changes as proposed by Motonobu initially here...)
Comment 6 John H Terpstra (mail address dead( 2006-11-24 13:32:08 UTC
Thank-you Monyo. Your changes have been adopted and added to the samba-docs repository.

- John T.
Comment 7 TAKAHASHI Motonobu 2008-11-15 09:54:09 UTC
The description of display charset in smb.conf(5) for Samba 3.2.4 says

-----
The value
           should generally be the same as the value of the parameter unix
           charset.
-----

but this is not correct as mentioned at 3) in #4 .

For example, "unix charset" is usually set to UTF-8 (default), but for "display charset" parameter, "UTF-8" is invalid. When we want to set locale to UTF-8,  setting to "en_US.UTF-8 " or such value is correct.

And "Example: display charset = UTF8" is also invalid. UTF-8 is correct.
Comment 8 TAKAHASHI Motonobu 2010-03-06 09:30:44 UTC
(In reply to comment #7)
These problems still exist at Samba 3.5.0.

(1) The value should generally be left as default, not same as 
    the value of "unix charset".

(2) UTF8 at example is invalid, UTF-8 is valid.