diff options
| author | Sam Varshavchik | 2014-01-12 16:43:21 -0500 |
|---|---|---|
| committer | Sam Varshavchik | 2014-01-12 16:43:21 -0500 |
| commit | 5673f36352d1de2b56e4d3367f6dc084e603a6d7 (patch) | |
| tree | 7ad14db0b30cd1c2b83da650b2f213f0b3304bbe /unicode | |
| parent | 458ba84cf3475a9f69dd324165a6f7178d3af0db (diff) | |
| download | courier-libs-5673f36352d1de2b56e4d3367f6dc084e603a6d7.tar.bz2 | |
Update documentation
Diffstat (limited to 'unicode')
| -rw-r--r-- | unicode/Makefile.am | 4 | ||||
| -rw-r--r-- | unicode/book.xml | 16 |
2 files changed, 18 insertions, 2 deletions
diff --git a/unicode/Makefile.am b/unicode/Makefile.am index 1019999..986151e 100644 --- a/unicode/Makefile.am +++ b/unicode/Makefile.am @@ -180,6 +180,8 @@ docs: --stringparam root.filename 'index' \ --stringparam generate.id.attributes 1 \ $(srcdir)/docbook/docbook.xsl $(srcdir)/book.xml + for f in html.tmp/*; do tidy -i -q --tidy-mark no --doctype transitional --input-encoding utf8 --output-encoding utf8 -asxml <$$f >$$f.tmp; xsltproc --nonet $$HOME/www/www.courier-mta.org/xsl/unicode.xsl $$f.tmp | perl -ne 's~\$(id):.*\$$~\$(id):'"$$h"'\$$~; print' >$$f; rm -f $$f.tmp; done + mkdir -p html rm -f html/* mv html.tmp/* html @@ -249,7 +251,7 @@ upload-dist: test -z "$(SFPASSWD)" && exit 1; exit 0 rm -f @PACKAGE@-@VERSION@.tar.bz2.sig; gpg --detach-sign --default-key mrsam@courier-mta.com @PACKAGE@-@VERSION@.tar.bz2; test -f @PACKAGE@-@VERSION@.tar.bz2.sig || exit 1 set -e; v="@PACKAGE@/@VERSION@/`date +%Y%m%d%H%M%S`"; git tag -s $$v -m 'Tag version @VERSION@' - socksify ~/src/sftools/release.pl mrsam $(SFPASSWD) courier courier @VERSION@ @PACKAGE@-@VERSION@.tar.bz2 @PACKAGE@-@VERSION@.tar.bz2.sig + socksify ~/src/sftools/release.pl mrsam $(SFPASSWD) courier $(PACKAGE) @VERSION@ @PACKAGE@-@VERSION@.tar.bz2 @PACKAGE@-@VERSION@.tar.bz2.sig www: rsync -a html/. $$HOME/www/www.courier-mta.org/unicode diff --git a/unicode/book.xml b/unicode/book.xml index f16bac0..a95d0a9 100644 --- a/unicode/book.xml +++ b/unicode/book.xml @@ -70,7 +70,7 @@ See COPYING for distribution information. </section> <section id="INSTALL"> - <title>Installation</title> + <title>Installation and usage</title> <para> Download the current version of the library from @@ -79,6 +79,20 @@ See COPYING for distribution information. the usual options, followed by <command>make</command>, then <command>make install</command>. </para> + + <para> + To use the library, <quote>#include <unicode.h></quote> and link + with <literal>-lunicode</literal>. + The starting point is + <link linkend="courier-unicode"> + <citerefentry> + <refentrytitle>courier-unicode</refentrytitle> + <manvolnum>7</manvolnum></citerefentry></link>. + Refer to the included manual pages, + and + <ulink url="http://www.courier-mta.org/unicode/manpages.html"> the HTML + version of the man pages</ulink> for more information. + </para> </section> <section id="manpages"> |