ICU-601 added manual pages for gencmn and decmn.

X-SVN-Rev: 6620
This commit is contained in:
Yves Arrouye 2001-11-05 22:21:23 +00:00
parent 2f7380dfe4
commit 664803c536
8 changed files with 198 additions and 7 deletions

2
.gitignore vendored
View file

@ -201,7 +201,9 @@ icu4c/source/tools/gencmn/Debug
icu4c/source/tools/gencmn/Makefile
icu4c/source/tools/gencmn/Release
icu4c/source/tools/gencmn/decmn
icu4c/source/tools/gencmn/decmn.[0-9]
icu4c/source/tools/gencmn/gencmn
icu4c/source/tools/gencmn/gencmn.[0-9]
icu4c/source/tools/gencmn/tmp
icu4c/source/tools/gencnval/*.d
icu4c/source/tools/gencnval/*.pdb

View file

@ -1,3 +1,9 @@
icu (2.0-1) unstable; urgency=low
* Update to ICU version 2.0.
-- Yves Arrouye <yves@debian.org> Wed, 24 Oct 2001 12:41:16 -0700
icu (1.8.1-1) unstable; urgency=low
* Update to ICU version 1.8.1.

View file

@ -14,7 +14,7 @@ Description: International Components for Unicode (development files)
ICU is a C++ and C library that provides robust and full-featured Unicode
support. This package contains the development files for ICU.
Package: libicu18
Package: libicu20
Section: libs
Architecture: any
Depends: ${shlibs:Depends}

View file

@ -96,7 +96,7 @@ clean:
install: build
dh_testdir
dh_testroot
dh_clean -k
# dh_clean -k
dh_installdirs
# Add here commands to install the package into debian/tmp
@ -186,7 +186,7 @@ binary-arch: build install
dh_installcron
dh_installmanpages -picu
dh_installinfo
dh_undocumented -picu genccode.8 gencmn.8 gennames.8 \
dh_undocumented -picu genccode.8 gennames.8 \
genprops.8 gentz.8 genfchk.8 genqchk.8 pkgdata.8
dh_installchangelogs
dh_link

View file

@ -5,5 +5,7 @@ Makefile
*.d
*.pdb
gencmn
gencmn.[0-9]
*.plg
decmn
decmn
decmn.[0-9]

View file

@ -17,6 +17,14 @@ include @platform_make_fragment@
## Build directory information
subdir = tools/gencmn
##
SECTION = 8
MANX_FILES = $(TARGET).$(SECTION) $(DECMN).$(SECTION)
ALL_MAN_FILES = $(MANX_FILES)
## Extra files to remove for 'make clean'
CLEANFILES = *~ mkmap.tmp $(DEPS) $(RES_FILES) $(TEST_FILES) $(DECMN_DEP)
@ -52,7 +60,7 @@ DECMN_DEP = $(DECMN_OBJ:.o=.d)
## List of phony targets
.PHONY : all all-local install install-local clean clean-local \
distclean distclean-local dist dist-local check \
check-local
check-local install-man install-manx
## Clear suffix list
.SUFFIXES :
@ -65,9 +73,9 @@ distclean : distclean-local
dist: dist-local
check: all check-local
all-local: $(TARGET) $(RES_FILES) $(TRANSLIT_RES) $(TEST_FILES) $(DECMN)
all-local: $(TARGET) $(RES_FILES) $(TRANSLIT_RES) $(TEST_FILES) $(DECMN) $(ALL_MAN_FILES)
install-local: all-local
install-local: all-local install-man
$(MKINSTALLDIRS) $(DESTDIR)$(sbindir)
$(INSTALL) $(TARGET) $(DESTDIR)$(sbindir)/$(TARGET)
$(INSTALL) $(DECMN) $(DESTDIR)$(sbindir)/$(DECMN)
@ -93,6 +101,16 @@ $(TARGET) : $(OBJECTS)
$(DECMN) : $(DECMN_OBJ)
$(LINK) -o $@ $^ $(LIBS)
# man page
install-man: install-manx
install-manx: $(MANX_FILES)
$(MKINSTALLDIRS) $(DESTDIR)$(mandir)/man$(SECTION)
$(INSTALL_DATA) $? $(DESTDIR)$(mandir)/man$(SECTION)
%.$(SECTION): $(srcdir)/%.$(SECTION).in
cd $(top_builddir) \
&& CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status
ifeq (,$(MAKECMDGOALS))
-include $(DEPS)
-include $(DECMN_DEP)

View file

@ -0,0 +1,34 @@
.\" Hey, Emacs! This is -*-nroff-*- you know...
.\"
.\" decmn.8: manual page for the decmn utility
.\"
.\" Copyright (C) 2001 IBM, Inc. and others.
.\"
.\" Manual page by Yves Arrouye <yves@realnames.com>.
.\"
.TH DECMN 8 "5 November 2001" "ICU MANPAGE" "ICU @VERSION@ Manual"
.SH NAME
.B decmn
\- explodes an ICU memory-mappable data file
.SH SYNOPSIS
.B decmn
.I commonfile
.SH DESCRIPTION
.B decmn
reads the ICU memory-mappable data file
.I commonfile
and writes each of the
packaged files that it contains as a separate file in the current
directory.
.PP
.B decmn
also writes a list of these files on its standard output. This list of
files can later be used, along with the individual files that have
been generated, to produce a new common data file using
.BR gencmn (8).
.SH VERSION
@VERSION@
.SH COPYRIGHT
Copyright (C) 2001 IBM, Inc. and others.
.SH SEE ALSO
.BR gencmn (8)

View file

@ -0,0 +1,129 @@
.\" Hey, Emacs! This is -*-nroff-*- you know...
.\"
.\" gencmn.8: manual page for the gencmn utility
.\"
.\" Copyright (C) 2000-2001 IBM, Inc. and others.
.\"
.\" Manual page by Yves Arrouye <yves@realnames.com>.
.\"
.TH GENCMN 8 "5 November 2001" "ICU MANPAGE" "ICU @VERSION@ Manual"
.SH NAME
.B gencmn
\- generate an ICU memory-mappable data file
.SH SYNOPSIS
.B gencmn
[
.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
]
[
.BR "\-v\fP, \fB\-\-verbose"
]
[
.BR "\-c\fP, \fB\-\-copyright"
]
[
.BI "\-C\fP, \fB\-\-comment" " comment"
]
[
.BI "\-d\fP, \fB\-\-destdir" " destination"
]
[
.BI "\-n\fP, \fB\-\-name" " name"
]
[
.BI "\-t\fP, \fB\-\-type" " fileext"
]
[
.BI "\-S\fP, \fB\-\-source"
]
[
.BI "\-e\fP, \fB\-\-entrypoint" " name"
]
.I maxsize
[
.I listfilename
]
.SH DESCRIPTION
.B gencmn
takes a set of files and packages them as an ICU memory-mappable data
file. The resulting data file can then be used directly by ICU.
.PP
.B gencmn
reads a list of files to be packaged from either the
supplied
.I listfilename
file, or from its standard output. It packages all the files from
the list that are not bigger than
.I maxsize
bytes. Files that exceed this limit are quietly ignored, even in
verbose mode.
.SH OPTIONS
.TP
.BR \-h\fP, \fB\-?\fP, \fB\-\-help
Print help about usage and exit.
.TP
.BR "\-v\fP, \fB\-\-verbose"
Display extra informative messages during execution.
.TP
.BR \-c\fP, \fB\-\-copyright
Include a copyright notice in the resulting data.
.TP
.BI "\-C\fP, \fB\-\-comment" " comment"
Include the specified
.I comment
in the resulting data.
.TP
.BI "\-d\fP, \fB\-\-destdir" " destination"
Set the destination directory to
.IR destination .
The default destination directory is specified by the environment variable
.BR ICU_DATA .
.TP
.BI "\-n\fP, \fB\-\-name" " name"
Sets the data name to
.I name
instead of the default. This name is also used as the base name of the
output. The default name is made of the
.I icudt
prefix, followed by a two-digit version number corresponding to
the current version of the ICU release, and a single letter indicating
the endianness of the data (the letter
.I b
indicated big endian data, and the letter
.I l
indicates little endian ones).
.TP
.BI "\-t\fP, \fB\-\-type" " type"
Use
.I type
as the type of the data. This type is also used as the extension of
the generated data file. The default type ie
.IR dat .
.TP
.BI "\-S\fP, \fB\-\-source"
Write a C source file with the table of contents of the data.
.TP
.BI "\-e\fP, \fB\-\-entrypoint" " name"
Sets the data entry point (used for linking against the data in a
shared library form) to
.IR name .
The default entry point name is made of the data (set by the
.BI "\-n\fP, \fB\-\-name"
option) followed by an underscore and the type of the data (set by the
.BI "\-t\fP, \fB\-\-type"
option).
.SH ENVIRONMENT
.TP 10
.B ICU_DATA
Specifies the directory containing ICU data. Defaults to
.BR @thedatadir@/icu/@VERSION@/ .
Some tools in ICU depend on the presence of the trailing slash. It is thus
important to make sure that it is present if
.B ICU_DATA
is set.
.SH VERSION
@VERSION@
.SH COPYRIGHT
Copyright (C) 2000-2001 IBM, Inc. and others.
.SH SEE ALSO
.BR decmn (8)