aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2007-05-29 00:14:53 +0000
committerJuanma Barranquero2007-05-29 00:14:53 +0000
commitcaff3c0a8dfa60978612b727e6529fe86e52cd5e (patch)
tree0ac57437940c77a9451b9bf494cd67c71748f07b
parent29f035645ed9a7d856ac57f286e28b4dc7c08455 (diff)
downloademacs-caff3c0a8dfa60978612b727e6529fe86e52cd5e.tar.gz
emacs-caff3c0a8dfa60978612b727e6529fe86e52cd5e.zip
(toggle-enable-multibyte-characters, sort-coding-systems,
search-unencodable-char): Doc fixes. (default-input-method, input-method-verbose-flag, input-method-highlight-flag): Remove * in defcustom's docstrings. (exit-language-environment-hook, set-default-coding-systems, coding-system-change-eol-conversion, prefer-coding-system, find-multibyte-characters, leim-list-entry-regexp, set-input-method, input-method-exit-on-first-char, princ-list, locale-language-names, locale-charset-language-names, define-char-code-property): Fix typos in docstrings.
-rw-r--r--lisp/international/mule-cmds.el56
1 files changed, 28 insertions, 28 deletions
diff --git a/lisp/international/mule-cmds.el b/lisp/international/mule-cmds.el
index 3cdb7c200ca..702fab36d2b 100644
--- a/lisp/international/mule-cmds.el
+++ b/lisp/international/mule-cmds.el
@@ -1,4 +1,4 @@
1;;; mule-cmds.el --- commands for mulitilingual environment -*-coding: iso-2022-7bit -*- 1;;; mule-cmds.el --- commands for multilingual environment -*-coding: iso-2022-7bit -*-
2 2
3;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 3;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4;; 2006, 2007 Free Software Foundation, Inc. 4;; 2006, 2007 Free Software Foundation, Inc.
@@ -206,7 +206,7 @@
206 "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'"))) 206 "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'")))
207 207
208(defun coding-system-change-eol-conversion (coding-system eol-type) 208(defun coding-system-change-eol-conversion (coding-system eol-type)
209 "Return a coding system which differs from CODING-SYSTEM in eol conversion. 209 "Return a coding system which differs from CODING-SYSTEM in EOL conversion.
210The returned coding system converts end-of-line by EOL-TYPE 210The returned coding system converts end-of-line by EOL-TYPE
211but text as the same way as CODING-SYSTEM. 211but text as the same way as CODING-SYSTEM.
212EOL-TYPE should be `unix', `dos', `mac', or nil. 212EOL-TYPE should be `unix', `dos', `mac', or nil.
@@ -256,8 +256,8 @@ the buffer; it only changes the way those bytes are interpreted.
256In general, therefore, this command *changes* the sequence of 256In general, therefore, this command *changes* the sequence of
257characters that the current buffer contains. 257characters that the current buffer contains.
258 258
259We suggest you avoid using use this command unless you know what you 259We suggest you avoid using this command unless you know what you are
260are doing. If you use it by mistake, and the buffer is now displayed 260doing. If you use it by mistake, and the buffer is now displayed
261wrong, use this command again to toggle back to the right mode." 261wrong, use this command again to toggle back to the right mode."
262 (interactive "P") 262 (interactive "P")
263 (let ((new-flag 263 (let ((new-flag
@@ -330,10 +330,10 @@ This sets the following coding systems:
330 o default coding system for subprocess I/O 330 o default coding system for subprocess I/O
331This also sets the following values: 331This also sets the following values:
332 o default value used as `file-name-coding-system' for converting file names 332 o default value used as `file-name-coding-system' for converting file names
333 if CODING-SYSTEM is ASCII-compatible. 333 if CODING-SYSTEM is ASCII-compatible
334 o default value for the command `set-terminal-coding-system' (not on MSDOS) 334 o default value for the command `set-terminal-coding-system' (not on MSDOS)
335 o default value for the command `set-keyboard-coding-system' 335 o default value for the command `set-keyboard-coding-system'
336 if CODING-SYSTEM is ASCII-compatible.." 336 if CODING-SYSTEM is ASCII-compatible"
337 (check-coding-system coding-system) 337 (check-coding-system coding-system)
338 (setq-default buffer-file-coding-system coding-system) 338 (setq-default buffer-file-coding-system coding-system)
339 (if (fboundp 'ucs-set-table-for-input) 339 (if (fboundp 'ucs-set-table-for-input)
@@ -373,7 +373,7 @@ This also sets the following coding systems:
373 o coding system of a newly created buffer 373 o coding system of a newly created buffer
374 o default coding system for subprocess I/O 374 o default coding system for subprocess I/O
375This also sets the following values: 375This also sets the following values:
376 o default value used as `file-name-coding-system' for converting file names. 376 o default value used as `file-name-coding-system' for converting file names
377 o default value for the command `set-terminal-coding-system' (not on MSDOS) 377 o default value for the command `set-terminal-coding-system' (not on MSDOS)
378 o default value for the command `set-keyboard-coding-system' 378 o default value for the command `set-keyboard-coding-system'
379 379
@@ -415,16 +415,16 @@ The function `sort-coding-systems' use it.")
415 415
416(defun sort-coding-systems (codings) 416(defun sort-coding-systems (codings)
417 "Sort coding system list CODINGS by a priority of each coding system. 417 "Sort coding system list CODINGS by a priority of each coding system.
418Returns the sorted list. CODINGS is modified by side effects. 418Return the sorted list. CODINGS is modified by side effects.
419 419
420If a coding system is most preferred, it has the highest priority. 420If a coding system is most preferred, it has the highest priority.
421Otherwise, a coding system corresponds to some MIME charset has higher 421Otherwise, coding systems that correspond to MIME charsets have
422priorities. Among them, a coding system included in `coding-system' 422higher priorities. Among them, a coding system included in the
423key of the current language environment has higher priorities. See 423`coding-system' key of the current language environment has higher
424also the documentation of `language-info-alist'. 424priority. See also the documentation of `language-info-alist'.
425 425
426If the variable `sort-coding-systems-predicate' (which see) is 426If the variable `sort-coding-systems-predicate' (which see) is
427non-nil, it is used to sort CODINGS in the different way than above." 427non-nil, it is used to sort CODINGS instead."
428 (if sort-coding-systems-predicate 428 (if sort-coding-systems-predicate
429 (sort codings sort-coding-systems-predicate) 429 (sort codings sort-coding-systems-predicate)
430 (let* ((from-priority (coding-system-priority-list)) 430 (let* ((from-priority (coding-system-priority-list))
@@ -556,7 +556,7 @@ where
556 COUNT is a number of characters, 556 COUNT is a number of characters,
557 CHARs are the characters found from the character set. 557 CHARs are the characters found from the character set.
558Optional 3rd arg MAXCOUNT limits how many CHARs are put in the above list. 558Optional 3rd arg MAXCOUNT limits how many CHARs are put in the above list.
559Optional 4th arg EXCLUDE is a list of character sets to be ignored." 559Optional 4th arg EXCLUDES is a list of character sets to be ignored."
560 (let ((chars nil) 560 (let ((chars nil)
561 charset char) 561 charset char)
562 (if (stringp from) 562 (if (stringp from)
@@ -598,8 +598,8 @@ It asks which coding system to check.
598If such a character is found, set point after that character. 598If such a character is found, set point after that character.
599Otherwise, don't move point. 599Otherwise, don't move point.
600 600
601When called from a program, the value is a position of the found character, 601When called from a program, the value is the position of the unencodable
602or nil if all characters are encodable." 602character found, or nil if all characters are encodable."
603 (interactive 603 (interactive
604 (list (let ((default (or buffer-file-coding-system 'us-ascii))) 604 (list (let ((default (or buffer-file-coding-system 'us-ascii)))
605 (read-coding-system 605 (read-coding-system
@@ -1261,7 +1261,7 @@ Emacs loads this file at startup time.")
1261 1261
1262(defvar leim-list-entry-regexp "^(register-input-method" 1262(defvar leim-list-entry-regexp "^(register-input-method"
1263 "Regexp matching head of each entry in LEIM list file. 1263 "Regexp matching head of each entry in LEIM list file.
1264See also the variable `leim-list-header'") 1264See also the variable `leim-list-header'.")
1265 1265
1266(defvar update-leim-list-functions 1266(defvar update-leim-list-functions
1267 '(quail-update-leim-list-file) 1267 '(quail-update-leim-list-file)
@@ -1287,7 +1287,7 @@ If nil, that means no input method is activated now.")
1287(put 'current-input-method-title 'permanent-local t) 1287(put 'current-input-method-title 'permanent-local t)
1288 1288
1289(defcustom default-input-method nil 1289(defcustom default-input-method nil
1290 "*Default input method for multilingual text (a string). 1290 "Default input method for multilingual text (a string).
1291This is the input method activated automatically by the command 1291This is the input method activated automatically by the command
1292`toggle-input-method' (\\[toggle-input-method])." 1292`toggle-input-method' (\\[toggle-input-method])."
1293 :link '(custom-manual "(emacs)Input Methods") 1293 :link '(custom-manual "(emacs)Input Methods")
@@ -1445,7 +1445,7 @@ When called interactively, the optional arg INTERACTIVE is non-nil,
1445which marks the variable `default-input-method' as set for Custom buffers. 1445which marks the variable `default-input-method' as set for Custom buffers.
1446 1446
1447To deactivate the input method interactively, use \\[toggle-input-method]. 1447To deactivate the input method interactively, use \\[toggle-input-method].
1448To deactivate it programmatically, use \\[inactivate-input-method]." 1448To deactivate it programmatically, use `inactivate-input-method'."
1449 (interactive 1449 (interactive
1450 (let* ((default (or (car input-method-history) default-input-method))) 1450 (let* ((default (or (car input-method-history) default-input-method)))
1451 (list (read-input-method-name 1451 (list (read-input-method-name
@@ -1566,7 +1566,7 @@ or a string."
1566;; should react to these variables. 1566;; should react to these variables.
1567 1567
1568(defcustom input-method-verbose-flag 'default 1568(defcustom input-method-verbose-flag 'default
1569 "*A flag to control extra guidance given by input methods. 1569 "A flag to control extra guidance given by input methods.
1570The value should be nil, t, `complex-only', or `default'. 1570The value should be nil, t, `complex-only', or `default'.
1571 1571
1572The extra guidance is done by showing list of available keys in echo 1572The extra guidance is done by showing list of available keys in echo
@@ -1589,7 +1589,7 @@ See also the variable `input-method-highlight-flag'."
1589 :group 'mule) 1589 :group 'mule)
1590 1590
1591(defcustom input-method-highlight-flag t 1591(defcustom input-method-highlight-flag t
1592 "*If this flag is non-nil, input methods highlight partially-entered text. 1592 "If this flag is non-nil, input methods highlight partially-entered text.
1593For instance, while you are in the middle of a Quail input method sequence, 1593For instance, while you are in the middle of a Quail input method sequence,
1594the text inserted so far is temporarily underlined. 1594the text inserted so far is temporarily underlined.
1595The underlining goes away when you finish or abort the input method sequence. 1595The underlining goes away when you finish or abort the input method sequence.
@@ -1622,7 +1622,7 @@ just inactivated."
1622 "This flag controls when an input method returns. 1622 "This flag controls when an input method returns.
1623Usually, the input method does not return while there's a possibility 1623Usually, the input method does not return while there's a possibility
1624that it may find a different translation if a user types another key. 1624that it may find a different translation if a user types another key.
1625But, it this flag is non-nil, the input method returns as soon as 1625But, if this flag is non-nil, the input method returns as soon as
1626the current key sequence gets long enough to have some valid translation.") 1626the current key sequence gets long enough to have some valid translation.")
1627 1627
1628(defcustom input-method-use-echo-area nil 1628(defcustom input-method-use-echo-area nil
@@ -1658,7 +1658,7 @@ When this hook is run, the variable `current-language-environment'
1658is still bound to the language environment being exited. 1658is still bound to the language environment being exited.
1659 1659
1660This hook is mainly used for canceling the effect of 1660This hook is mainly used for canceling the effect of
1661`set-language-environment-hook' (which-see)." 1661`set-language-environment-hook' (which see)."
1662 :type 'hook 1662 :type 'hook
1663 :group 'mule) 1663 :group 'mule)
1664 1664
@@ -1968,7 +1968,7 @@ Setting this variable directly does not take effect. See
1968 (set-display-table-and-terminal-coding-system language-name)) 1968 (set-display-table-and-terminal-coding-system language-name))
1969 1969
1970(defsubst princ-list (&rest args) 1970(defsubst princ-list (&rest args)
1971 "Print all arguments with `princ', then print \"\n\"." 1971 "Print all arguments with `princ', then print \"\\n\"."
1972 (while args (princ (car args)) (setq args (cdr args))) 1972 (while args (princ (car args)) (setq args (cdr args)))
1973 (princ "\n")) 1973 (princ "\n"))
1974 1974
@@ -2299,10 +2299,10 @@ Setting this variable directly does not take effect. See
2299 ("wen" . "Latin-2") ; MS Windows Upper Sorbian 2299 ("wen" . "Latin-2") ; MS Windows Upper Sorbian
2300 )) 2300 ))
2301 "Alist of locale regexps vs the corresponding languages and coding systems. 2301 "Alist of locale regexps vs the corresponding languages and coding systems.
2302Each element has these form: 2302Each element has this form:
2303 \(LOCALE-REGEXP LANG-ENV CODING-SYSTEM) 2303 \(LOCALE-REGEXP LANG-ENV CODING-SYSTEM)
2304The first element whose LOCALE-REGEXP matches the start of a 2304The first element whose LOCALE-REGEXP matches the start of a
2305downcased locale specifies the LANG-ENV \(language environtment) 2305downcased locale specifies the LANG-ENV \(language environment)
2306and CODING-SYSTEM corresponding to that locale. If there is no 2306and CODING-SYSTEM corresponding to that locale. If there is no
2307appropriate language environment, the element may have this form: 2307appropriate language environment, the element may have this form:
2308 \(LOCALE-REGEXP . LANG-ENV) 2308 \(LOCALE-REGEXP . LANG-ENV)
@@ -2326,7 +2326,7 @@ specific encoding such as \"Latin-1\" and \"UTF-8\".")
2326The first element whose locale regexp matches the start of a downcased locale 2326The first element whose locale regexp matches the start of a downcased locale
2327specifies the language name whose charset corresponds to that locale. 2327specifies the language name whose charset corresponds to that locale.
2328This language name is used if the locale is not listed in 2328This language name is used if the locale is not listed in
2329`locale-language-names'") 2329`locale-language-names'.")
2330 2330
2331(defconst locale-preferred-coding-systems 2331(defconst locale-preferred-coding-systems
2332 (purecopy 2332 (purecopy
@@ -2647,7 +2647,7 @@ TABLE is a char-table of purpose `char-code-property-table' with
2647these extra slots: 2647these extra slots:
2648 1st: NAME. 2648 1st: NAME.
2649 2nd: Function to call to get a property value of a character. 2649 2nd: Function to call to get a property value of a character.
2650 It is called with three arugments CHAR, VAL, and TABLE, where 2650 It is called with three arguments CHAR, VAL, and TABLE, where
2651 CHAR is a character, VAL is the value of (aref TABLE CHAR). 2651 CHAR is a character, VAL is the value of (aref TABLE CHAR).
2652 3rd: Function to call to put a property value of a character. 2652 3rd: Function to call to put a property value of a character.
2653 It is called with the same arguments as above. 2653 It is called with the same arguments as above.