* [PATCH] iconv.1: New page for iconv(1) @ 2014-06-10 8:38 Marko Myllynen [not found] ` <5396C41B.2040707-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 0 siblings, 1 reply; 12+ messages in thread From: Marko Myllynen @ 2014-06-10 8:38 UTC (permalink / raw) To: linux-man Hi, while updating the locale pages I noticed there was no iconv(1) page in upstream so I wrote one, please see below. From 006b3e251ae3883b3652bfb3f32a8d72ba803960 Mon Sep 17 00:00:00 2001 From: Marko Myllynen <myllynen-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> Date: Mon, 9 Jun 2014 08:09:57 +0300 Subject: [PATCH] iconv.1: New page for iconv(1) --- man1/iconv.1 | 156 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 156 insertions(+), 0 deletions(-) create mode 100644 man1/iconv.1 diff --git a/man1/iconv.1 b/man1/iconv.1 new file mode 100644 index 0000000..ece7e6a --- /dev/null +++ b/man1/iconv.1 @@ -0,0 +1,156 @@ +'\" t -*- coding: UTF-8 -*- +.\" +.\" Copyright (C) 2014 Marko Myllynen <myllynen-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> +.\" +.\" %%%LICENSE_START(GPLv2+_DOC_FULL) +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public +.\" License along with this manual; if not, see +.\" <http://www.gnu.org/licenses/>. +.\" %%%LICENSE_END +.\" +.TH ICONV 1 2014-06-06 "GNU" "Linux User Manual" +.SH NAME +iconv \- convert text from one character encoding to another +.SH SYNOPSIS +.B iconv +.RI [ options ] +.RI "[-f " from-encoding "]" +.RI "[-t " to-encoding "]" +.RI [ inputfile ]... +.SH DESCRIPTION +The +.B iconv +program reads in text in one encoding and outputs the text in another +encoding. If no input files are given, or if it is given as a dash (\-), +.B iconv +reads from the standard input. If no output file is given, +.B iconv +writes to the standard output. +.PP +If no +.I from-encoding +is given, the default is derived from the current locale. +If no +.I to-encoding +is given, the default is derived from the current locale. +.SH OPTIONS +.TP +.BI \-f " from-encoding" ", \-\-from-code=" from-encoding +Use +.I from-encoding +for input characters. +.TP +.BI \-t " to-encoding" ", \-\-to-code=" to-encoding +Use +.I to-encoding +for output characters. + +If +.I to-encoding +is appended with +.BR //IGNORE , +characters that cannot be converted are discarded and an error is +printed after conversion. + +If +.I to-encoding +is appended with +.BR //TRANSLIT , +characters being converted are transliterated when needed and possible. +Characters that are outside of the target character set and cannot be +transliterated are replaced with the question mark (?) in the output. +.TP +.B "\-l, \-\-list" +List all known character set encodings. +.TP +.B "\-c" +Silently discard characters that cannot be converted instead of +aborting on them. +.TP +.BI \-o " outputfile" ", \-\-output=" outputfile +Use +.I outputfile +for output. +.TP +.B "\-s, \-\-silent" +This option is ignored, it is provided only for compatibility. +.TP +.B "\-\-verbose" +Print progress information on the standard error when processing +multiple files. +.TP +.B "\-\-help" +Print a usage summary and exit. +.TP +.B "\-\-usage" +Print a short usage summary and exit. +.TP +.B "\-V, \-\-version" +Print the version number, license, and disclaimer of warranty for +.BR iconv . +.SH EXIT STATUS +Zero on success, non-zero on errors. +.SH ENVIRONMENT +The +.B iconv +program supports any character set for which a +corresponding gconv configuration and module are provided for. +By default the system provided gconv configuration and modules +are used but +.B GCONV_PATH +can be defined as a list of pathnames, separated by colons (\(aq:\(aq), +for gconv configuration and module search path, +to be searched prior to the system provided configuration and modules. +If +.B GCONV_PATH +is set, the system gconv module configuration cache (created by +.BR iconvconfig (8)) +will not be used. Only directories containing the +.I gconv-modules +configuration files will be looked for the specified gconv modules. +.SH FILES +.TP +.I /usr/lib/gconv +Usual default gconv module path. +.TP +.I /usr/lib/gconv/gconv-modules +Usual default gconv module configuration. +.TP +.I /usr/lib/gconv/gconv-modules.cache +Usual default gconv module configuration cache. +.SH CONFORMING TO +POSIX.1-2001. +.SH EXAMPLE +Convert text from the ISO 8859-15 character encoding to UTF-8 +encoding: +.PP +.RS +iconv \-f ISO\-8859\-15 -t UTF\-8 < input.txt > output.txt +.RE +.PP +The next example converts from UTF-8 to ASCII, transliterating when +possible, resulting "abc ss ? EUR abc" printed (without quotes) to the +standard output: +.PP +.RS +echo abc ß α € àḃç | iconv \-f UTF\-8 \-t ASCII//TRANSLIT +.RE +.SH "SEE ALSO" +.BR locale (1), +.BR charsets (7), +.BR iconvconfig (8) -- 1.7.1 Thanks, -- Marko Myllynen -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply related [flat|nested] 12+ messages in thread
[parent not found: <5396C41B.2040707-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>]
* Re: [PATCH] iconv.1: New page for iconv(1) [not found] ` <5396C41B.2040707-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> @ 2014-06-10 19:28 ` Michael Kerrisk (man-pages) [not found] ` <53975C76.7060302-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> 0 siblings, 1 reply; 12+ messages in thread From: Michael Kerrisk (man-pages) @ 2014-06-10 19:28 UTC (permalink / raw) To: myllynen-H+wXaHxf7aLQT0dZR+AlfA, linux-man Cc: mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w Hi Marko, On 06/10/2014 10:38 AM, Marko Myllynen wrote: > Hi, > > while updating the locale pages I noticed there was no iconv(1) page > in upstream so I wrote one, please see below. Thanks for doing this. Could I ask you to look at the comments below, and send a revised version, please. >>From 006b3e251ae3883b3652bfb3f32a8d72ba803960 Mon Sep 17 00:00:00 2001 > From: Marko Myllynen <myllynen-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> > Date: Mon, 9 Jun 2014 08:09:57 +0300 > Subject: [PATCH] iconv.1: New page for iconv(1) > > --- > man1/iconv.1 | 156 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ > 1 files changed, 156 insertions(+), 0 deletions(-) > create mode 100644 man1/iconv.1 > > diff --git a/man1/iconv.1 b/man1/iconv.1 > new file mode 100644 > index 0000000..ece7e6a > --- /dev/null > +++ b/man1/iconv.1 > @@ -0,0 +1,156 @@ > +'\" t -*- coding: UTF-8 -*- > +.\" > +.\" Copyright (C) 2014 Marko Myllynen <myllynen-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> > +.\" > +.\" %%%LICENSE_START(GPLv2+_DOC_FULL) > +.\" This is free documentation; you can redistribute it and/or > +.\" modify it under the terms of the GNU General Public License as > +.\" published by the Free Software Foundation; either version 2 of > +.\" the License, or (at your option) any later version. > +.\" > +.\" The GNU General Public License's references to "object code" > +.\" and "executables" are to be interpreted as the output of any > +.\" document formatting or typesetting system, including > +.\" intermediate and printed output. > +.\" > +.\" This manual is distributed in the hope that it will be useful, > +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of > +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the > +.\" GNU General Public License for more details. > +.\" > +.\" You should have received a copy of the GNU General Public > +.\" License along with this manual; if not, see > +.\" <http://www.gnu.org/licenses/>. > +.\" %%%LICENSE_END > +.\" > +.TH ICONV 1 2014-06-06 "GNU" "Linux User Manual" > +.SH NAME > +iconv \- convert text from one character encoding to another > +.SH SYNOPSIS > +.B iconv > +.RI [ options ] > +.RI "[-f " from-encoding "]" > +.RI "[-t " to-encoding "]" > +.RI [ inputfile ]... > +.SH DESCRIPTION > +The > +.B iconv > +program reads in text in one encoding and outputs the text in another > +encoding. If no input files are given, or if it is given as a dash (\-), ^ Please always start new sentences on new source lines. > +.B iconv > +reads from the standard input. If no output file is given, ^ > +.B iconv > +writes to the standard output. > +.PP > +If no > +.I from-encoding > +is given, the default is derived from the current locale. > +If no > +.I to-encoding > +is given, the default is derived from the current locale. Maybe some more precision here is warranted? How is the default derived? > +.SH OPTIONS > +.TP > +.BI \-f " from-encoding" ", \-\-from-code=" from-encoding > +Use > +.I from-encoding > +for input characters. > +.TP > +.BI \-t " to-encoding" ", \-\-to-code=" to-encoding > +Use > +.I to-encoding > +for output characters. > + > +If > +.I to-encoding > +is appended with > +.BR //IGNORE , > +characters that cannot be converted are discarded and an error is > +printed after conversion. > + > +If > +.I to-encoding > +is appended with > +.BR //TRANSLIT , > +characters being converted are transliterated when needed and possible. > +Characters that are outside of the target character set and cannot be > +transliterated are replaced with the question mark (?) in the output. s/the/a/ > +.TP > +.B "\-l, \-\-list" > +List all known character set encodings. > +.TP > +.B "\-c" > +Silently discard characters that cannot be converted instead of > +aborting on them. What does "aborting on them" mean? Does the program terminate? > +.TP > +.BI \-o " outputfile" ", \-\-output=" outputfile > +Use > +.I outputfile > +for output. > +.TP > +.B "\-s, \-\-silent" > +This option is ignored, it is provided only for compatibility. > +.TP > +.B "\-\-verbose" > +Print progress information on the standard error when processing s/the// > +multiple files. > +.TP > +.B "\-\-help" > +Print a usage summary and exit. > +.TP > +.B "\-\-usage" > +Print a short usage summary and exit. > +.TP > +.B "\-V, \-\-version" > +Print the version number, license, and disclaimer of warranty for > +.BR iconv . > +.SH EXIT STATUS > +Zero on success, non-zero on errors. > +.SH ENVIRONMENT > +The > +.B iconv > +program supports any character set for which a > +corresponding gconv configuration and module are provided for. I think a sentence to explain "gconv configuration" is in order. The reader otherwise is a bit lost at this point. > +By default the system provided gconv configuration and modules s/default/default,/ > +are used but s/used/used,/ > +.B GCONV_PATH > +can be defined as a list of pathnames, separated by colons (\(aq:\(aq), > +for gconv configuration and module search path, > +to be searched prior to the system provided configuration and modules. > +If > +.B GCONV_PATH > +is set, the system gconv module configuration cache (created by > +.BR iconvconfig (8)) > +will not be used. Only directories containing the ^ > +.I gconv-modules > +configuration files will be looked for the specified gconv modules. s/looked/searched/ > +.SH FILES > +.TP > +.I /usr/lib/gconv > +Usual default gconv module path. > +.TP > +.I /usr/lib/gconv/gconv-modules > +Usual default gconv module configuration. > +.TP > +.I /usr/lib/gconv/gconv-modules.cache > +Usual default gconv module configuration cache. > +.SH CONFORMING TO > +POSIX.1-2001. > +.SH EXAMPLE > +Convert text from the ISO 8859-15 character encoding to UTF-8 > +encoding: > +.PP > +.RS > +iconv \-f ISO\-8859\-15 -t UTF\-8 < input.txt > output.txt > +.RE > +.PP > +The next example converts from UTF-8 to ASCII, transliterating when > +possible, resulting "abc ss ? EUR abc" printed (without quotes) to the > +standard output: Here, rather than explaining what the output would be, simply show a shell session with command and the output. Cheers, Michael > +.PP > +.RS > +echo abc ß α € àḃç | iconv \-f UTF\-8 \-t ASCII//TRANSLIT > +.RE > +.SH "SEE ALSO" > +.BR locale (1), > +.BR charsets (7), > +.BR iconvconfig (8) > -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/ -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 12+ messages in thread
[parent not found: <53975C76.7060302-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>]
* Re: [PATCH] iconv.1: New page for iconv(1) [not found] ` <53975C76.7060302-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> @ 2014-06-11 8:09 ` Marko Myllynen [not found] ` <53980EC4.2030508-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 0 siblings, 1 reply; 12+ messages in thread From: Marko Myllynen @ 2014-06-11 8:09 UTC (permalink / raw) To: Michael Kerrisk (man-pages), linux-man Hi, On 2014-06-10 22:28, Michael Kerrisk (man-pages) wrote: > On 06/10/2014 10:38 AM, Marko Myllynen wrote: >> >> while updating the locale pages I noticed there was no iconv(1) page >> in upstream so I wrote one, please see below. > > Thanks for doing this. Could I ask you to look at the comments below, and send > a revised version, please. ok, please see below, hopefully the explanation are now clearer without going into too low level details. From 89f1618b102c6f591977bf9f925523f97b97d755 Mon Sep 17 00:00:00 2001 From: Marko Myllynen <myllynen-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> Date: Wed, 11 Jun 2014 08:39:56 +0300 Subject: [PATCH] iconv.1: New page for iconv(1) --- man1/iconv.1 | 174 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 174 insertions(+), 0 deletions(-) create mode 100644 man1/iconv.1 diff --git a/man1/iconv.1 b/man1/iconv.1 new file mode 100644 index 0000000..31991c0 --- /dev/null +++ b/man1/iconv.1 @@ -0,0 +1,174 @@ +'\" t -*- coding: UTF-8 -*- +.\" +.\" Copyright (C) 2014 Marko Myllynen <myllynen-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> +.\" +.\" %%%LICENSE_START(GPLv2+_DOC_FULL) +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public +.\" License along with this manual; if not, see +.\" <http://www.gnu.org/licenses/>. +.\" %%%LICENSE_END +.\" +.TH ICONV 1 2014-06-06 "GNU" "Linux User Manual" +.SH NAME +iconv \- convert text from one character encoding to another +.SH SYNOPSIS +.B iconv +.RI [ options ] +.RI "[-f " from-encoding "]" +.RI "[-t " to-encoding "]" +.RI [ inputfile ]... +.SH DESCRIPTION +The +.B iconv +program reads in text in one encoding and outputs the text in another +encoding. +If no input files are given, or if it is given as a dash (\-), +.B iconv +reads from the standard input. +If no output file is given, +.B iconv +writes to the standard output. +.PP +If no +.I from-encoding +is given, the default is derived +from the current locale's character encoding. +If no +.I to-encoding +is given, the default is derived +from the current locale's character +encoding. +.SH OPTIONS +.TP +.BI \-f " from-encoding" ", \-\-from-code=" from-encoding +Use +.I from-encoding +for input characters. +.TP +.BI \-t " to-encoding" ", \-\-to-code=" to-encoding +Use +.I to-encoding +for output characters. + +If +.I to-encoding +is appended with +.BR //IGNORE , +characters that cannot be converted are discarded and an error is +printed after conversion. + +If +.I to-encoding +is appended with +.BR //TRANSLIT , +characters being converted are transliterated when needed and possible. +This means that when a character cannot be represented in the target +character set, it can be approximated through one or several similarly +looking characters. +Characters that are outside of the target character set and cannot be +transliterated are replaced with a question mark (?) in the output. +.TP +.B "\-l, \-\-list" +List all known character set encodings. +.TP +.B "\-c" +Silently discard characters that cannot be converted instead of +terminating when encountering such a character. +.TP +.BI \-o " outputfile" ", \-\-output=" outputfile +Use +.I outputfile +for output. +.TP +.B "\-s, \-\-silent" +This option is ignored, it is provided only for compatibility. +.TP +.B "\-\-verbose" +Print progress information on standard error when processing +multiple files. +.TP +.B "\-\-help" +Print a usage summary and exit. +.TP +.B "\-\-usage" +Print a short usage summary and exit. +.TP +.B "\-V, \-\-version" +Print the version number, license, and disclaimer of warranty for +.BR iconv . +.SH EXIT STATUS +Zero on success, non-zero on errors. +.SH ENVIRONMENT +Internally, the +.B iconv +program uses the +.BR iconv (3) +function which in turn uses +.I gconv +modules to convert to and from a character set. +.B iconv +supports any character set for which a +corresponding gconv configuration and module are provided for. +By default, the system provided gconv configuration and modules +are used, but +.B GCONV_PATH +can be defined as a list of pathnames, separated by colons (\(aq:\(aq), +for gconv configuration and module search path, +to be searched prior to the system provided configuration and modules. +If +.B GCONV_PATH +is set, the system gconv module configuration cache (created by +.BR iconvconfig (8)) +will not be used. +Only directories containing the +.I gconv-modules +configuration files will be searched for the specified gconv modules. +.SH FILES +.TP +.I /usr/lib/gconv +Usual default gconv module path. +.TP +.I /usr/lib/gconv/gconv-modules +Usual default gconv module configuration. +.TP +.I /usr/lib/gconv/gconv-modules.cache +Usual default gconv module configuration cache. +.SH CONFORMING TO +POSIX.1-2001. +.SH EXAMPLE +Convert text from the ISO 8859-15 character encoding to UTF-8 +encoding: +.PP +.RS +iconv \-f ISO\-8859\-15 -t UTF\-8 < input.txt > output.txt +.RE +.PP +The next example converts from UTF-8 to ASCII, transliterating when +possible: + +.nf +$ \fBecho abc ß α € àḃç | iconv -f UTF-8 -t ASCII//TRANSLIT\fP +abc ss ? EUR abc +$ +.fi +.SH "SEE ALSO" +.BR locale (1), +.BR iconv (3), +.BR nl_langinfo (3), +.BR charsets (7), +.BR iconvconfig (8) -- 1.7.1 Thanks, -- Marko Myllynen -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply related [flat|nested] 12+ messages in thread
[parent not found: <53980EC4.2030508-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>]
* Re: [PATCH] iconv.1: New page for iconv(1) [not found] ` <53980EC4.2030508-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> @ 2014-06-11 10:07 ` Michael Kerrisk (man-pages) [not found] ` <53982A56.2000509-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> 0 siblings, 1 reply; 12+ messages in thread From: Michael Kerrisk (man-pages) @ 2014-06-11 10:07 UTC (permalink / raw) To: myllynen-H+wXaHxf7aLQT0dZR+AlfA, linux-man Cc: mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w Hi Marko, On 06/11/2014 10:09 AM, Marko Myllynen wrote: > Hi, > > On 2014-06-10 22:28, Michael Kerrisk (man-pages) wrote: >> On 06/10/2014 10:38 AM, Marko Myllynen wrote: >>> >>> while updating the locale pages I noticed there was no iconv(1) page >>> in upstream so I wrote one, please see below. >> >> Thanks for doing this. Could I ask you to look at the comments below, and send >> a revised version, please. > > ok, please see below, hopefully the explanation are now clearer > without going into too low level details. Yes, thanks, a lot better. I have applied this, but have a question, below. [...] > +.SH ENVIRONMENT > +Internally, the > +.B iconv > +program uses the > +.BR iconv (3) > +function which in turn uses > +.I gconv > +modules to convert to and from a character set. > +.B iconv > +supports any character set for which a > +corresponding gconv configuration and module are provided for. > +By default, the system provided gconv configuration and modules > +are used, but > +.B GCONV_PATH > +can be defined as a list of pathnames, separated by colons (\(aq:\(aq), > +for gconv configuration and module search path, > +to be searched prior to the system provided configuration and modules. That last sentence is long and hard to parse. What exactly is GCONV_PATH? Is it a list of configuration paths? module search paths? I am left uncertain after reading that sentence. Cheers, Michael -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/ -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 12+ messages in thread
[parent not found: <53982A56.2000509-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>]
* Re: [PATCH] iconv.1: New page for iconv(1) [not found] ` <53982A56.2000509-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> @ 2014-06-11 13:30 ` Marko Myllynen [not found] ` <539859E9.8040306-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 0 siblings, 1 reply; 12+ messages in thread From: Marko Myllynen @ 2014-06-11 13:30 UTC (permalink / raw) To: Michael Kerrisk (man-pages), linux-man Hi, On 2014-06-11 13:07, Michael Kerrisk (man-pages) wrote: > On 06/11/2014 10:09 AM, Marko Myllynen wrote: >> On 2014-06-10 22:28, Michael Kerrisk (man-pages) wrote: >>> On 06/10/2014 10:38 AM, Marko Myllynen wrote: >>>> >>>> while updating the locale pages I noticed there was no iconv(1) page >>>> in upstream so I wrote one, please see below. >>> >>> Thanks for doing this. Could I ask you to look at the comments below, and send >>> a revised version, please. >> >> ok, please see below, hopefully the explanation are now clearer >> without going into too low level details. > > Yes, thanks, a lot better. I have applied this, but have a question, below. > >> +.SH ENVIRONMENT >> +Internally, the >> +.B iconv >> +program uses the >> +.BR iconv (3) >> +function which in turn uses >> +.I gconv >> +modules to convert to and from a character set. >> +.B iconv >> +supports any character set for which a >> +corresponding gconv configuration and module are provided for. >> +By default, the system provided gconv configuration and modules >> +are used, but >> +.B GCONV_PATH >> +can be defined as a list of pathnames, separated by colons (\(aq:\(aq), >> +for gconv configuration and module search path, >> +to be searched prior to the system provided configuration and modules. > > That last sentence is long and hard to parse. What exactly is GCONV_PATH? > Is it a list of configuration paths? module search paths? I am > left uncertain after reading that sentence. yeah, I think I was trying to make a long story too short. When a program, such as iconv(1), uses iconv(3) (the function), it first needs to allocate a conversion descriptor with iconv_open(3) and during the iconv_open() call glibc, if GCONV_PATH is not set, loads the system gconv cache file created by iconvconfig(8) and based on the configuration then loads the needed gconv modules for conversion (an example of a gconv module is CP1252.so). If GCONV_PATH is set, glibc first tries to load the configuration files from the paths in GCONV_PATH followed by the system configuration file. If a directory does not contain a gconv module configuration file, possible gconv modules in it are ignored. If a directory contains a gconv module configuration file and it is determined that a needed module for this conversion is available in the directory, then the needed module is loaded from there, the order being so that the first suitable module found in GCONV_PATH is used. This allows users to use custom modules and even replace system provided modules by providing such modules in GCONV_PATH directories. Thanks, -- Marko Myllynen -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 12+ messages in thread
[parent not found: <539859E9.8040306-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>]
* Re: [PATCH] iconv.1: New page for iconv(1) [not found] ` <539859E9.8040306-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> @ 2014-06-11 14:03 ` Michael Kerrisk (man-pages) [not found] ` <CAKgNAkj=Y6P+C4SYegOejWJwGJQE96Jr6=Hej9PQFRiDXLzTDQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org> 0 siblings, 1 reply; 12+ messages in thread From: Michael Kerrisk (man-pages) @ 2014-06-11 14:03 UTC (permalink / raw) To: Marko Myllynen; +Cc: linux-man HI Marko, On Wed, Jun 11, 2014 at 3:30 PM, Marko Myllynen <myllynen-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> wrote: > Hi, > > On 2014-06-11 13:07, Michael Kerrisk (man-pages) wrote: >> On 06/11/2014 10:09 AM, Marko Myllynen wrote: >>> On 2014-06-10 22:28, Michael Kerrisk (man-pages) wrote: >>>> On 06/10/2014 10:38 AM, Marko Myllynen wrote: >>>>> >>>>> while updating the locale pages I noticed there was no iconv(1) page >>>>> in upstream so I wrote one, please see below. >>>> >>>> Thanks for doing this. Could I ask you to look at the comments below, and send >>>> a revised version, please. >>> >>> ok, please see below, hopefully the explanation are now clearer >>> without going into too low level details. >> >> Yes, thanks, a lot better. I have applied this, but have a question, below. >> >>> +.SH ENVIRONMENT >>> +Internally, the >>> +.B iconv >>> +program uses the >>> +.BR iconv (3) >>> +function which in turn uses >>> +.I gconv >>> +modules to convert to and from a character set. >>> +.B iconv >>> +supports any character set for which a >>> +corresponding gconv configuration and module are provided for. >>> +By default, the system provided gconv configuration and modules >>> +are used, but >>> +.B GCONV_PATH >>> +can be defined as a list of pathnames, separated by colons (\(aq:\(aq), >>> +for gconv configuration and module search path, >>> +to be searched prior to the system provided configuration and modules. >> >> That last sentence is long and hard to parse. What exactly is GCONV_PATH? >> Is it a list of configuration paths? module search paths? I am >> left uncertain after reading that sentence. > > yeah, I think I was trying to make a long story too short. > > When a program, such as iconv(1), uses iconv(3) (the function), it first > needs to allocate a conversion descriptor with iconv_open(3) and during > the iconv_open() call glibc, if GCONV_PATH is not set, loads the system > gconv cache file created by iconvconfig(8) and based on the > configuration then loads the needed gconv modules for conversion (an > example of a gconv module is CP1252.so). If GCONV_PATH is set, glibc > first tries to load the configuration files from the paths in GCONV_PATH > followed by the system configuration file. If a directory does not > contain a gconv module configuration file, possible gconv modules in it > are ignored. If a directory contains a gconv module configuration file > and it is determined that a needed module for this conversion is > available in the directory, then the needed module is loaded from there, > the order being so that the first suitable module found in GCONV_PATH is > used. This allows users to use custom modules and even replace system > provided modules by providing such modules in GCONV_PATH directories. It sounds like you mean the above paragraph should be added to the page. Is that correct? Cheers, Michael -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/ -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 12+ messages in thread
[parent not found: <CAKgNAkj=Y6P+C4SYegOejWJwGJQE96Jr6=Hej9PQFRiDXLzTDQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>]
* Re: [PATCH] iconv.1: New page for iconv(1) [not found] ` <CAKgNAkj=Y6P+C4SYegOejWJwGJQE96Jr6=Hej9PQFRiDXLzTDQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org> @ 2014-06-11 14:14 ` Marko Myllynen [not found] ` <53986452.2030308-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 0 siblings, 1 reply; 12+ messages in thread From: Marko Myllynen @ 2014-06-11 14:14 UTC (permalink / raw) To: mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w; +Cc: linux-man Hi, On 2014-06-11 17:03, Michael Kerrisk (man-pages) wrote: > On Wed, Jun 11, 2014 at 3:30 PM, Marko Myllynen <myllynen-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> wrote: >> On 2014-06-11 13:07, Michael Kerrisk (man-pages) wrote: >>> On 06/11/2014 10:09 AM, Marko Myllynen wrote: >>>> On 2014-06-10 22:28, Michael Kerrisk (man-pages) wrote: >>>>> On 06/10/2014 10:38 AM, Marko Myllynen wrote: >>>>>> >>>>>> while updating the locale pages I noticed there was no iconv(1) page >>>>>> in upstream so I wrote one, please see below. >>>>> >>>>> Thanks for doing this. Could I ask you to look at the comments below, and send >>>>> a revised version, please. >>>> >>>> ok, please see below, hopefully the explanation are now clearer >>>> without going into too low level details. >>> >>> Yes, thanks, a lot better. I have applied this, but have a question, below. >>> >>>> +.SH ENVIRONMENT >>>> +Internally, the >>>> +.B iconv >>>> +program uses the >>>> +.BR iconv (3) >>>> +function which in turn uses >>>> +.I gconv >>>> +modules to convert to and from a character set. >>>> +.B iconv >>>> +supports any character set for which a >>>> +corresponding gconv configuration and module are provided for. >>>> +By default, the system provided gconv configuration and modules >>>> +are used, but >>>> +.B GCONV_PATH >>>> +can be defined as a list of pathnames, separated by colons (\(aq:\(aq), >>>> +for gconv configuration and module search path, >>>> +to be searched prior to the system provided configuration and modules. >>> >>> That last sentence is long and hard to parse. What exactly is GCONV_PATH? >>> Is it a list of configuration paths? module search paths? I am >>> left uncertain after reading that sentence. >> >> yeah, I think I was trying to make a long story too short. >> >> When a program, such as iconv(1), uses iconv(3) (the function), it first >> needs to allocate a conversion descriptor with iconv_open(3) and during >> the iconv_open() call glibc, if GCONV_PATH is not set, loads the system >> gconv cache file created by iconvconfig(8) and based on the >> configuration then loads the needed gconv modules for conversion (an >> example of a gconv module is CP1252.so). If GCONV_PATH is set, glibc >> first tries to load the configuration files from the paths in GCONV_PATH >> followed by the system configuration file. If a directory does not >> contain a gconv module configuration file, possible gconv modules in it >> are ignored. If a directory contains a gconv module configuration file >> and it is determined that a needed module for this conversion is >> available in the directory, then the needed module is loaded from there, >> the order being so that the first suitable module found in GCONV_PATH is >> used. This allows users to use custom modules and even replace system >> provided modules by providing such modules in GCONV_PATH directories. > > It sounds like you mean the above paragraph should be added to the > page. Is that correct? I was more like providing all the details and wasn't thinking to include the paragraph at least as-is. But if you think it seems suitable to be added, please go ahead. I'd personally prefer a more compact version but compacting the message without losing precision in this case seems a bit hard. Thanks, -- Marko Myllynen -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 12+ messages in thread
[parent not found: <53986452.2030308-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>]
* Re: [PATCH] iconv.1: New page for iconv(1) [not found] ` <53986452.2030308-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> @ 2014-06-11 19:15 ` Michael Kerrisk (man-pages) [not found] ` <5398AAE7.3090307-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> 0 siblings, 1 reply; 12+ messages in thread From: Michael Kerrisk (man-pages) @ 2014-06-11 19:15 UTC (permalink / raw) To: myllynen-H+wXaHxf7aLQT0dZR+AlfA Cc: mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w, linux-man On 06/11/2014 04:14 PM, Marko Myllynen wrote: > Hi, > > On 2014-06-11 17:03, Michael Kerrisk (man-pages) wrote: >> On Wed, Jun 11, 2014 at 3:30 PM, Marko Myllynen <myllynen-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> wrote: >>> On 2014-06-11 13:07, Michael Kerrisk (man-pages) wrote: >>>> On 06/11/2014 10:09 AM, Marko Myllynen wrote: >>>>> On 2014-06-10 22:28, Michael Kerrisk (man-pages) wrote: >>>>>> On 06/10/2014 10:38 AM, Marko Myllynen wrote: >>>>>>> >>>>>>> while updating the locale pages I noticed there was no iconv(1) page >>>>>>> in upstream so I wrote one, please see below. >>>>>> >>>>>> Thanks for doing this. Could I ask you to look at the comments below, and send >>>>>> a revised version, please. >>>>> >>>>> ok, please see below, hopefully the explanation are now clearer >>>>> without going into too low level details. >>>> >>>> Yes, thanks, a lot better. I have applied this, but have a question, below. >>>> >>>>> +.SH ENVIRONMENT >>>>> +Internally, the >>>>> +.B iconv >>>>> +program uses the >>>>> +.BR iconv (3) >>>>> +function which in turn uses >>>>> +.I gconv >>>>> +modules to convert to and from a character set. >>>>> +.B iconv >>>>> +supports any character set for which a >>>>> +corresponding gconv configuration and module are provided for. >>>>> +By default, the system provided gconv configuration and modules >>>>> +are used, but >>>>> +.B GCONV_PATH >>>>> +can be defined as a list of pathnames, separated by colons (\(aq:\(aq), >>>>> +for gconv configuration and module search path, >>>>> +to be searched prior to the system provided configuration and modules. >>>> >>>> That last sentence is long and hard to parse. What exactly is GCONV_PATH? >>>> Is it a list of configuration paths? module search paths? I am >>>> left uncertain after reading that sentence. >>> >>> yeah, I think I was trying to make a long story too short. >>> >>> When a program, such as iconv(1), uses iconv(3) (the function), it first >>> needs to allocate a conversion descriptor with iconv_open(3) and during >>> the iconv_open() call glibc, if GCONV_PATH is not set, loads the system >>> gconv cache file created by iconvconfig(8) and based on the >>> configuration then loads the needed gconv modules for conversion (an >>> example of a gconv module is CP1252.so). If GCONV_PATH is set, glibc >>> first tries to load the configuration files from the paths in GCONV_PATH >>> followed by the system configuration file. If a directory does not >>> contain a gconv module configuration file, possible gconv modules in it >>> are ignored. If a directory contains a gconv module configuration file >>> and it is determined that a needed module for this conversion is >>> available in the directory, then the needed module is loaded from there, >>> the order being so that the first suitable module found in GCONV_PATH is >>> used. This allows users to use custom modules and even replace system >>> provided modules by providing such modules in GCONV_PATH directories. >> >> It sounds like you mean the above paragraph should be added to the >> page. Is that correct? > > I was more like providing all the details and wasn't thinking to include > the paragraph at least as-is. But if you think it seems suitable to be > added, please go ahead. I'd personally prefer a more compact version but > compacting the message without losing precision in this case seems a bit > hard. So, how does the following look to you: ENVIRONMENT Internally, the iconv program uses the iconv(3) function which in turn uses gconv modules (dynamically loaded shared libraries) to convert to and from a character set. Before calling iconv(3), the iconv program must first allocate a con‐ version descriptor using iconv_open(3). The operation of the latter function is influenced by the setting of the GCONV_PATH environment variable: * If GCONV_PATH is not set, iconv_open(3) loads the system gconv cache file created by iconvconfig(8) and then, based on the configuration, loads the gconv modules needed to per‐ form the conversion. * If GCONV_PATH is defined (as a colon-separated list of path‐ names), the system gconv module configuration cache is not used. Instead, iconv_open(3) first tries to load the con‐ figuration files from one of the directories in GCONV_PATH, followed by the system configuration file. If a directory does not contain a gconv module configuration file, any gconv modules that it may contain are ignored. If a direc‐ tory contains a gconv module configuration file and it is determined that a module needed for this conversion is available in the directory, then the needed module is loaded from that directory, the order being such that the first suitable module found in GCONV_PATH is used. This allows users to use custom modules and even replace system-provided modules by providing such modules in GCONV_PATH directories. iconv supports any character set for which a corresponding gconv configuration and module are provided. I have two doubts about the above text: * What is "the system configuration file"? * The last sentence (left over from your earlier text) seems out of place. Is it needed? If it is, I think we need a better place for it. Thanks, Michael -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/ -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 12+ messages in thread
[parent not found: <5398AAE7.3090307-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>]
* Re: [PATCH] iconv.1: New page for iconv(1) [not found] ` <5398AAE7.3090307-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> @ 2014-06-12 17:40 ` Marko Myllynen [not found] ` <5399E60D.8010607-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 0 siblings, 1 reply; 12+ messages in thread From: Marko Myllynen @ 2014-06-12 17:40 UTC (permalink / raw) To: Michael Kerrisk (man-pages); +Cc: linux-man Hi, On 2014-06-11 22:15, Michael Kerrisk (man-pages) wrote: > On 06/11/2014 04:14 PM, Marko Myllynen wrote: >> On 2014-06-11 17:03, Michael Kerrisk (man-pages) wrote: >>> On Wed, Jun 11, 2014 at 3:30 PM, Marko Myllynen <myllynen-H+wXaHxf7aJhl2p70BpVqQ@public.gmane.orgm> wrote: >>>> On 2014-06-11 13:07, Michael Kerrisk (man-pages) wrote: >>>>> On 06/11/2014 10:09 AM, Marko Myllynen wrote: >>>>>> On 2014-06-10 22:28, Michael Kerrisk (man-pages) wrote: >>>>>>> On 06/10/2014 10:38 AM, Marko Myllynen wrote: > > So, how does the following look to you: it looks very good, thanks for this! > ENVIRONMENT > Internally, the iconv program uses the iconv(3) function which > in turn uses gconv modules (dynamically loaded shared > libraries) to convert to and from a character set. Before > calling iconv(3), the iconv program must first allocate a con‐ > version descriptor using iconv_open(3). The operation of the > latter function is influenced by the setting of the GCONV_PATH > environment variable: > > * If GCONV_PATH is not set, iconv_open(3) loads the system > gconv cache file created by iconvconfig(8) and then, based > on the configuration, loads the gconv modules needed to per‐ > form the conversion. > > * If GCONV_PATH is defined (as a colon-separated list of path‐ > names), the system gconv module configuration cache is not > used. Instead, iconv_open(3) first tries to load the con‐ > figuration files from one of the directories in GCONV_PATH, > followed by the system configuration file. If a directory > does not contain a gconv module configuration file, any > gconv modules that it may contain are ignored. If a direc‐ > tory contains a gconv module configuration file and it is > determined that a module needed for this conversion is > available in the directory, then the needed module is loaded > from that directory, the order being such that the first > suitable module found in GCONV_PATH is used. This allows > users to use custom modules and even replace system-provided > modules by providing such modules in GCONV_PATH directories. > > iconv supports any character set for which a corresponding > gconv configuration and module are provided. > > I have two doubts about the above text: > > * What is "the system configuration file"? It is listed in the FILES section, does that clarify enough? > * The last sentence (left over from your earlier text) seems out > of place. Is it needed? If it is, I think we need a better place > for it. I think the same thing is already said (albeit slightly less explicitly) above it so I don't think it's needed anymore. Thanks, -- Marko Myllynen -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 12+ messages in thread
[parent not found: <5399E60D.8010607-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>]
* Re: [PATCH] iconv.1: New page for iconv(1) [not found] ` <5399E60D.8010607-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> @ 2014-06-12 18:44 ` Michael Kerrisk (man-pages) [not found] ` <CAKgNAkgc4ASriZyv7bhjBJ-H17KYX0b4Pwb8175y++pCD1ZXbg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org> 0 siblings, 1 reply; 12+ messages in thread From: Michael Kerrisk (man-pages) @ 2014-06-12 18:44 UTC (permalink / raw) To: Marko Myllynen; +Cc: linux-man Hi Marko, On Thu, Jun 12, 2014 at 7:40 PM, Marko Myllynen <myllynen-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> wrote: > Hi, > > On 2014-06-11 22:15, Michael Kerrisk (man-pages) wrote: >> On 06/11/2014 04:14 PM, Marko Myllynen wrote: >>> On 2014-06-11 17:03, Michael Kerrisk (man-pages) wrote: >>>> On Wed, Jun 11, 2014 at 3:30 PM, Marko Myllynen <myllynen@redhat.com> wrote: >>>>> On 2014-06-11 13:07, Michael Kerrisk (man-pages) wrote: >>>>>> On 06/11/2014 10:09 AM, Marko Myllynen wrote: >>>>>>> On 2014-06-10 22:28, Michael Kerrisk (man-pages) wrote: >>>>>>>> On 06/10/2014 10:38 AM, Marko Myllynen wrote: >> >> So, how does the following look to you: > > it looks very good, thanks for this! > >> ENVIRONMENT >> Internally, the iconv program uses the iconv(3) function which >> in turn uses gconv modules (dynamically loaded shared >> libraries) to convert to and from a character set. Before >> calling iconv(3), the iconv program must first allocate a con‐ >> version descriptor using iconv_open(3). The operation of the >> latter function is influenced by the setting of the GCONV_PATH >> environment variable: >> >> * If GCONV_PATH is not set, iconv_open(3) loads the system >> gconv cache file created by iconvconfig(8) and then, based >> on the configuration, loads the gconv modules needed to per‐ >> form the conversion. >> >> * If GCONV_PATH is defined (as a colon-separated list of path‐ >> names), the system gconv module configuration cache is not >> used. Instead, iconv_open(3) first tries to load the con‐ >> figuration files from one of the directories in GCONV_PATH, >> followed by the system configuration file. If a directory >> does not contain a gconv module configuration file, any >> gconv modules that it may contain are ignored. If a direc‐ >> tory contains a gconv module configuration file and it is >> determined that a module needed for this conversion is >> available in the directory, then the needed module is loaded >> from that directory, the order being such that the first >> suitable module found in GCONV_PATH is used. This allows >> users to use custom modules and even replace system-provided >> modules by providing such modules in GCONV_PATH directories. >> >> iconv supports any character set for which a corresponding >> gconv configuration and module are provided. >> >> I have two doubts about the above text: >> >> * What is "the system configuration file"? > > It is listed in the FILES section, does that clarify enough? I wondered about that. But the term "system configuration file" does not appear in FILES. Is it "Usual default gconv module configuration"? If so, that's not so obvious because the terms differ. >> * The last sentence (left over from your earlier text) seems out >> of place. Is it needed? If it is, I think we need a better place >> for it. > > I think the same thing is already said (albeit slightly less explicitly) > above it so I don't think it's needed anymore. Okay -- I removed the sentence. Cheers, Michael -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/ -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 12+ messages in thread
[parent not found: <CAKgNAkgc4ASriZyv7bhjBJ-H17KYX0b4Pwb8175y++pCD1ZXbg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>]
* Re: [PATCH] iconv.1: New page for iconv(1) [not found] ` <CAKgNAkgc4ASriZyv7bhjBJ-H17KYX0b4Pwb8175y++pCD1ZXbg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org> @ 2014-06-13 9:15 ` Marko Myllynen [not found] ` <539AC116.4050803-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 0 siblings, 1 reply; 12+ messages in thread From: Marko Myllynen @ 2014-06-13 9:15 UTC (permalink / raw) To: mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w; +Cc: linux-man Hi, On 2014-06-12 21:44, Michael Kerrisk (man-pages) wrote: >> >>> ENVIRONMENT >>> Internally, the iconv program uses the iconv(3) function which >>> in turn uses gconv modules (dynamically loaded shared >>> libraries) to convert to and from a character set. Before >>> calling iconv(3), the iconv program must first allocate a con‐ >>> version descriptor using iconv_open(3). The operation of the >>> latter function is influenced by the setting of the GCONV_PATH >>> environment variable: >>> >>> * If GCONV_PATH is not set, iconv_open(3) loads the system >>> gconv cache file created by iconvconfig(8) and then, based >>> on the configuration, loads the gconv modules needed to per‐ >>> form the conversion. >>> >>> * If GCONV_PATH is defined (as a colon-separated list of path‐ >>> names), the system gconv module configuration cache is not >>> used. Instead, iconv_open(3) first tries to load the con‐ >>> figuration files from one of the directories in GCONV_PATH, >>> followed by the system configuration file. If a directory >>> does not contain a gconv module configuration file, any >>> gconv modules that it may contain are ignored. If a direc‐ >>> tory contains a gconv module configuration file and it is >>> determined that a module needed for this conversion is >>> available in the directory, then the needed module is loaded >>> from that directory, the order being such that the first >>> suitable module found in GCONV_PATH is used. This allows >>> users to use custom modules and even replace system-provided >>> modules by providing such modules in GCONV_PATH directories. >>> >>> iconv supports any character set for which a corresponding >>> gconv configuration and module are provided. >>> >>> I have two doubts about the above text: >>> >>> * What is "the system configuration file"? >> >> It is listed in the FILES section, does that clarify enough? > > I wondered about that. But the term "system configuration file" does > not appear in FILES. Is it "Usual default gconv module configuration"? > If so, that's not so obvious because the terms differ. you're right, using "system default gconv module configuration" in both places should make it obvious. Thanks, -- Marko Myllynen -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 12+ messages in thread
[parent not found: <539AC116.4050803-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>]
* Re: [PATCH] iconv.1: New page for iconv(1) [not found] ` <539AC116.4050803-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> @ 2014-06-13 11:45 ` Michael Kerrisk (man-pages) 0 siblings, 0 replies; 12+ messages in thread From: Michael Kerrisk (man-pages) @ 2014-06-13 11:45 UTC (permalink / raw) To: Marko Myllynen; +Cc: linux-man On Fri, Jun 13, 2014 at 11:15 AM, Marko Myllynen <myllynen-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> wrote: > Hi, > > On 2014-06-12 21:44, Michael Kerrisk (man-pages) wrote: >>> >>>> ENVIRONMENT >>>> Internally, the iconv program uses the iconv(3) function which >>>> in turn uses gconv modules (dynamically loaded shared >>>> libraries) to convert to and from a character set. Before >>>> calling iconv(3), the iconv program must first allocate a con‐ >>>> version descriptor using iconv_open(3). The operation of the >>>> latter function is influenced by the setting of the GCONV_PATH >>>> environment variable: >>>> >>>> * If GCONV_PATH is not set, iconv_open(3) loads the system >>>> gconv cache file created by iconvconfig(8) and then, based >>>> on the configuration, loads the gconv modules needed to per‐ >>>> form the conversion. >>>> >>>> * If GCONV_PATH is defined (as a colon-separated list of path‐ >>>> names), the system gconv module configuration cache is not >>>> used. Instead, iconv_open(3) first tries to load the con‐ >>>> figuration files from one of the directories in GCONV_PATH, >>>> followed by the system configuration file. If a directory >>>> does not contain a gconv module configuration file, any >>>> gconv modules that it may contain are ignored. If a direc‐ >>>> tory contains a gconv module configuration file and it is >>>> determined that a module needed for this conversion is >>>> available in the directory, then the needed module is loaded >>>> from that directory, the order being such that the first >>>> suitable module found in GCONV_PATH is used. This allows >>>> users to use custom modules and even replace system-provided >>>> modules by providing such modules in GCONV_PATH directories. >>>> >>>> iconv supports any character set for which a corresponding >>>> gconv configuration and module are provided. >>>> >>>> I have two doubts about the above text: >>>> >>>> * What is "the system configuration file"? >>> >>> It is listed in the FILES section, does that clarify enough? >> >> I wondered about that. But the term "system configuration file" does >> not appear in FILES. Is it "Usual default gconv module configuration"? >> If so, that's not so obvious because the terms differ. > > you're right, using "system default gconv module configuration" in both > places should make it obvious. Done. And I made a similar change in the FILES section of iconvconfig.8. Cheers, Michael -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/ -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 12+ messages in thread
end of thread, other threads:[~2014-06-13 11:45 UTC | newest] Thread overview: 12+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2014-06-10 8:38 [PATCH] iconv.1: New page for iconv(1) Marko Myllynen [not found] ` <5396C41B.2040707-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 2014-06-10 19:28 ` Michael Kerrisk (man-pages) [not found] ` <53975C76.7060302-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> 2014-06-11 8:09 ` Marko Myllynen [not found] ` <53980EC4.2030508-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 2014-06-11 10:07 ` Michael Kerrisk (man-pages) [not found] ` <53982A56.2000509-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> 2014-06-11 13:30 ` Marko Myllynen [not found] ` <539859E9.8040306-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 2014-06-11 14:03 ` Michael Kerrisk (man-pages) [not found] ` <CAKgNAkj=Y6P+C4SYegOejWJwGJQE96Jr6=Hej9PQFRiDXLzTDQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org> 2014-06-11 14:14 ` Marko Myllynen [not found] ` <53986452.2030308-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 2014-06-11 19:15 ` Michael Kerrisk (man-pages) [not found] ` <5398AAE7.3090307-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> 2014-06-12 17:40 ` Marko Myllynen [not found] ` <5399E60D.8010607-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 2014-06-12 18:44 ` Michael Kerrisk (man-pages) [not found] ` <CAKgNAkgc4ASriZyv7bhjBJ-H17KYX0b4Pwb8175y++pCD1ZXbg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org> 2014-06-13 9:15 ` Marko Myllynen [not found] ` <539AC116.4050803-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> 2014-06-13 11:45 ` Michael Kerrisk (man-pages)
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).