ICU-807 documented gentz. the last tool to be documented (hooray)

X-SVN-Rev: 7450
This commit is contained in:
Yves Arrouye 2002-01-17 07:17:03 +00:00
parent 16dd03269d
commit cfa8477ac4
2 changed files with 98 additions and 3 deletions

View file

@ -14,6 +14,12 @@ include $(top_builddir)/icudefs.mk
## Platform-specific setup
include @platform_make_fragment@
##
SECTION = 8
MAN_FILES = $(TARGET).$(SECTION)
## Build directory information
subdir = tools/gentz
@ -23,7 +29,7 @@ TZFILE=$(srcdir)/tz.txt
TZALIAS=$(srcdir)/tz.alias
## Extra files to remove for 'make clean'
CLEANFILES = *~ $(DEPS) $(RES_FILES) $(TEST_FILES)
CLEANFILES = *~ $(DEPS) $(RES_FILES) $(TEST_FILES) $(MANUAL_FILES)
## Target information
TARGET = gentz
@ -46,7 +52,7 @@ DEPS = $(OBJECTS:.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 build-data
check-local build-data install-man
## Clear suffix list
.SUFFIXES :
@ -59,12 +65,28 @@ distclean : distclean-local
dist: dist-local
check: all check-local
all-local: $(TARGET)
all-local: $(TARGET) $(MANUAL_FILES)
install-local: all-local
$(MKINSTALLDIRS) $(DESTDIR)$(sbindir)
$(INSTALL) $(TARGET) $(DESTDIR)$(sbindir)/$(TARGET)
# man page
install-man: $(MAN_FILES)
$(MKINSTALLDIRS) $(DESTDIR)$(mandir)/man$(SECTION)
$(INSTALL_DATA) $< $(DESTDIR)$(mandir)/man$(SECTION)
$(TARGET).$(SECTION): $(srcdir)/$(TARGET).$(SECTION).in
cd $(top_builddir) \
&& CONFIG_FILES=$(subdir)/$@ CONFIG_HEADERS= $(SHELL) ./config.status
# build postscript and pdf formats
$(TARGET).ps: $(TARGET).$(SECTION)
groff -man < $< > $@
$(TARGET).pdf: $(TARGET).ps
ps2pdf $< $@
dist-local:
clean-local:

View file

@ -0,0 +1,73 @@
.\" Hey, Emacs! This is -*-nroff-*- you know...
.\"
.\" gentz.8: manual page for the gentz utility
.\"
.\" Copyright (C) 2000-2001 IBM, Inc. and others.
.\"
.TH GENTZ 8 "16 January 2001" "ICU MANPAGE" "ICU @VERSION@ Manual"
.SH NAME
.B gentz
\- compile timezone information
.SH SYNOPSIS
.B gentz
[
.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"
]
[
.BI "\-c\fP, \fB\-\-copyright"
]
[
.BI "\-d\fP, \fB\-\-destdir" " destination"
]
.I timezone
.SH DESCRIPTION
.B gentz
reads a
.I timezone
file and compile it into a binary form.
The resulting file,
.BR tz.dat ,
can then be read directly by ICU, or used by
.BR pkgdata (8)
for incorporation into a larger archive or library.
.LP
The file read by
.B gentz
are described in the
.B FILES
section.
.SH OPTIONS
.TP
.BR \-h\fP, \fB\-?\fP, \fB\-\-help
Print help about usage and exit.
.TP
.BI "\-c\fP, \fB\-\-copyright"
Include a copyright notice into the binary 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 .
.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 FILES
The following file is read by
.BR gentz .
.TP 20
.B timezone.txt
Contains UNIX timezone data in a format that can be understood by
.BR gentz .
.SH VERSION
@VERSION@
.SH COPYRIGHT
Copyright (C) 2000-2002 IBM, Inc. and others.
.SH SEE ALSO
.BR pkgdata (8)