diff options
45 files changed, 2059 insertions, 2 deletions
@@ -42,6 +42,8 @@ General Changes - Fixed the graphical IceGrid administrative tool to run and build in JVMs without JavaFX support. +- Added man pages for Ice executable tools and commands. + C++ Changes =========== diff --git a/cpp/Makefile b/cpp/Makefile index e5df3fc9a9f..235e41ef348 100644 --- a/cpp/Makefile +++ b/cpp/Makefile @@ -17,7 +17,8 @@ ifeq ($(shell uname | grep MINGW),) SUBDIRS := $(SUBDIRS) demo endif -INSTALL_SUBDIRS = $(install_bindir) $(install_libdir) $(install_includedir) $(install_configdir) +INSTALL_SUBDIRS = $(install_bindir) $(install_libdir) $(install_includedir) \ + $(install_configdir) $(install_mandir) install:: install-common @for subdir in $(INSTALL_SUBDIRS); \ diff --git a/cpp/config/Make.rules b/cpp/config/Make.rules index f5acdc18117..fbf6fe759b5 100644 --- a/cpp/config/Make.rules +++ b/cpp/config/Make.rules @@ -192,6 +192,12 @@ install_bindir := $(prefix)/$(binsubdir)$(cpp11suffix) install_libdir := $(prefix)/$(libsubdir)$(cpp11suffix) install_configdir := $(prefix)/config +ifneq ($(prefix),/usr) +install_mandir := $(prefix)/man/man1 +else +install_mandir := $(prefix)/share/man/man1 +endif + ifneq ($(embedded_runpath_prefix),) runpath_libdir := $(embedded_runpath_prefix)/$(libsubdir) else diff --git a/cpp/src/FreezeScript/Makefile b/cpp/src/FreezeScript/Makefile index f2a90b8b8c0..f78cdb68be1 100644 --- a/cpp/src/FreezeScript/Makefile +++ b/cpp/src/FreezeScript/Makefile @@ -58,6 +58,8 @@ $(DUMPDB): $(DUMP_OBJS) $(COMMON_OBJS) install:: all $(call installprogram,$(TRANSFORMDB),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/transformdb.1,$(install_mandir)) $(call installprogram,$(DUMPDB),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/dumpdb.1,$(install_mandir)) include .depend diff --git a/cpp/src/Glacier2/Makefile b/cpp/src/Glacier2/Makefile index d7fecfb8116..b6ae0beef59 100644 --- a/cpp/src/Glacier2/Makefile +++ b/cpp/src/Glacier2/Makefile @@ -44,5 +44,6 @@ $(ROUTER): $(OBJS) install:: all $(call installprogram,$(ROUTER),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/glacier2router.1,$(install_mandir)) include .depend diff --git a/cpp/src/IceBox/Makefile b/cpp/src/IceBox/Makefile index a2dfc5abc59..16a16909dc1 100644 --- a/cpp/src/IceBox/Makefile +++ b/cpp/src/IceBox/Makefile @@ -71,6 +71,8 @@ $(ADMIN): $(AOBJS) $(LIBTARGETS) install:: all $(call installlib,$(install_libdir),$(libdir),$(LIBFILENAME),$(SONAME),$(LIBNAME)) $(call installprogram,$(SERVER),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/icebox.1,$(install_mandir)) $(call installprogram,$(ADMIN),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/iceboxadmin.1,$(install_mandir)) include .depend diff --git a/cpp/src/IceGrid/Makefile b/cpp/src/IceGrid/Makefile index 21509cc8725..16bf43da4a0 100644 --- a/cpp/src/IceGrid/Makefile +++ b/cpp/src/IceGrid/Makefile @@ -120,8 +120,11 @@ $(NODE_SERVER): $(NODE_SVR_OBJS) $(LIBTARGETS) install:: all $(call installprogram,$(ADMIN),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/icegridadmin.1,$(install_mandir)) $(call installprogram,$(NODE_SERVER),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/icegridnode.1,$(install_mandir)) $(call installprogram,$(REGISTRY_SERVER),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/icegridregistry.1,$(install_mandir)) SUBDIRS = FreezeDB diff --git a/cpp/src/IceStorm/Makefile b/cpp/src/IceStorm/Makefile index bfa29a83eeb..bdea303748d 100644 --- a/cpp/src/IceStorm/Makefile +++ b/cpp/src/IceStorm/Makefile @@ -92,6 +92,7 @@ $(ADMIN): $(AOBJS) $(LIBTARGETS) install:: all $(call installlib,$(install_libdir),$(libdir),$(LIBFILENAME),$(SONAME),$(LIBNAME)) $(call installprogram,$(ADMIN),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/icestormadmin.1,$(install_mandir)) SUBDIRS = FreezeDB diff --git a/cpp/src/ca/Makefile b/cpp/src/ca/Makefile index d526abd4301..c583c6f9197 100644 --- a/cpp/src/ca/Makefile +++ b/cpp/src/ca/Makefile @@ -40,6 +40,7 @@ install:: $(INSTALL_PROGRAM) $$i $(prefix)/bin ;\ chmod a+x $(prefix)/bin/$$i ;\ done + $(call installdata,$(top_srcdir)/../man/man1/iceca.1,$(install_mandir)) @for i in $(CLASS_FILES) ; \ do \ echo "Installing $$i" ; \ diff --git a/cpp/src/slice2cpp/Makefile b/cpp/src/slice2cpp/Makefile index aaa9802b30d..ca84a62293e 100644 --- a/cpp/src/slice2cpp/Makefile +++ b/cpp/src/slice2cpp/Makefile @@ -34,5 +34,6 @@ $(NAME): $(OBJS) install:: all $(call installprogram,$(NAME),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/slice2cpp.1,$(install_mandir)) include .depend diff --git a/cpp/src/slice2cs/Makefile b/cpp/src/slice2cs/Makefile index 0752340c71a..0e651ea4558 100644 --- a/cpp/src/slice2cs/Makefile +++ b/cpp/src/slice2cs/Makefile @@ -34,5 +34,6 @@ $(NAME): $(OBJS) install:: all $(call installprogram,$(NAME),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/slice2cs.1,$(install_mandir)) include .depend diff --git a/cpp/src/slice2freeze/Makefile b/cpp/src/slice2freeze/Makefile index aa77709c0b2..74bb1d863f0 100644 --- a/cpp/src/slice2freeze/Makefile +++ b/cpp/src/slice2freeze/Makefile @@ -33,5 +33,6 @@ $(NAME): $(OBJS) install:: all $(call installprogram,$(NAME),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/slice2freeze.1,$(install_mandir)) include .depend diff --git a/cpp/src/slice2freezej/Makefile b/cpp/src/slice2freezej/Makefile index 70792bb7848..fae4e0d0583 100644 --- a/cpp/src/slice2freezej/Makefile +++ b/cpp/src/slice2freezej/Makefile @@ -33,5 +33,6 @@ $(NAME): $(OBJS) install:: all $(call installprogram,$(NAME),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/slice2freezej.1,$(install_mandir)) include .depend diff --git a/cpp/src/slice2html/Makefile b/cpp/src/slice2html/Makefile index 311c68f2631..ad86a79bc06 100644 --- a/cpp/src/slice2html/Makefile +++ b/cpp/src/slice2html/Makefile @@ -34,5 +34,6 @@ $(NAME): $(OBJS) install:: all $(call installprogram,$(NAME),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/slice2html.1,$(install_mandir)) include .depend diff --git a/cpp/src/slice2java/Makefile b/cpp/src/slice2java/Makefile index 5a4ffe89a6f..4cf6250227f 100644 --- a/cpp/src/slice2java/Makefile +++ b/cpp/src/slice2java/Makefile @@ -34,5 +34,6 @@ $(NAME): $(OBJS) install:: all $(call installprogram,$(NAME),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/slice2java.1,$(install_mandir)) include .depend diff --git a/cpp/src/slice2php/Makefile b/cpp/src/slice2php/Makefile index 27bee378f91..9b6b005837b 100644 --- a/cpp/src/slice2php/Makefile +++ b/cpp/src/slice2php/Makefile @@ -33,5 +33,6 @@ $(NAME): $(OBJS) install:: all $(call installprogram,$(NAME),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/slice2php.1,$(install_mandir)) include .depend diff --git a/cpp/src/slice2py/Makefile b/cpp/src/slice2py/Makefile index 98f6aec4ff7..e7aba2e2161 100644 --- a/cpp/src/slice2py/Makefile +++ b/cpp/src/slice2py/Makefile @@ -33,5 +33,6 @@ $(NAME): $(OBJS) install:: all $(call installprogram,$(NAME),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/slice2py.1,$(install_mandir)) include .depend diff --git a/cpp/src/slice2rb/Makefile b/cpp/src/slice2rb/Makefile index 0cd29414326..b9d51c356a1 100644 --- a/cpp/src/slice2rb/Makefile +++ b/cpp/src/slice2rb/Makefile @@ -33,5 +33,6 @@ $(NAME): $(OBJS) install:: all $(call installprogram,$(NAME),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/slice2rb.1,$(install_mandir)) include .depend diff --git a/cs/Makefile b/cs/Makefile index 538d4af7fa4..d2ad3291b4c 100644 --- a/cs/Makefile +++ b/cs/Makefile @@ -13,7 +13,7 @@ include $(top_srcdir)/config/Make.rules.cs SUBDIRS = src test demo -INSTALL_SUBDIRS = $(install_bindir) $(install_assembliesdir) +INSTALL_SUBDIRS = $(install_bindir) $(install_assembliesdir) $(install_mandir) install:: install-common @for subdir in $(INSTALL_SUBDIRS); \ diff --git a/cs/config/Make.rules.cs b/cs/config/Make.rules.cs index 6ca8ec2fdf4..2a15ba0c43f 100644 --- a/cs/config/Make.rules.cs +++ b/cs/config/Make.rules.cs @@ -81,6 +81,11 @@ install_assembliesdir = $(prefix)/Assemblies install_libdir = $(prefix)/lib +ifneq ($(prefix),/usr) +install_mandir := $(prefix)/man/man1 +else +install_mandir := $(prefix)/share/man/man1 +endif install_pkgconfigdir = $(prefix)/lib/pkgconfig diff --git a/cs/src/IceBox/Makefile b/cs/src/IceBox/Makefile index fe48d668b84..ce6e8066904 100644 --- a/cs/src/IceBox/Makefile +++ b/cs/src/IceBox/Makefile @@ -46,6 +46,7 @@ install:: all install:: all $(call installprogram,$(ICEBOXNET),$(install_bindir)) + $(call installdata,$(top_srcdir)/../man/man1/iceboxnet.1,$(install_mandir)) $(call installmdb,$(ICEBOXNET).mdb) ifeq ($(GACINSTALL),yes) diff --git a/man/man1/dumpdb.1 b/man/man1/dumpdb.1 new file mode 100644 index 00000000000..0173369cda4 --- /dev/null +++ b/man/man1/dumpdb.1 @@ -0,0 +1,144 @@ +.TH dumpdb 1 + +.SH NAME + +dumpdb - The Freeze database inspector. + +.SH SYNOPSIS + +dumpdb [options] dbenv db + +.SH DESCRIPTION + +The FreezeScript tool dumpdb is used to examine a Freeze database. Its +simplest invocation displays every record of the database, but the tool also +supports more selective activities. In fact, dumpdb supports a scripted mode +that shares many of the same XML descriptors as transformdb, enabling +sophisticated filtering and reporting. Full documentation for dumpdb is +available online at: +.br +"http://doc.zeroc.com/display/Ice/Using+dumpdb". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-DNAME\fR +.br +Defines the preprocessor symbol NAME. + +.TP +.BR \-DNAME=DEF\fR +.br +Defines the preprocessor symbol NAME with the value DEF. + +.TP +.BR \-UNAME\fR +.br +Undefines the preprocessor symbol NAME. + +.TP +.BR \-IDIR\fR +.br +Add the directory DIR to the search path for #include directives. + +.TP +.BR \-E\fR +.br +Print the preprocessor output on stdout. + +.TP +.BR \-\-output-dir " " DIR\fR +.br +Place the generated files into directory DIR. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug information showing the operation of the Slice parser. + +.TP +.BR \-\-ice\fR +.br +Permit use of the normally reserved prefix Ice for identifiers. Use this +option only when compiling the source code for the Ice run time. + +.TP +.BR \-\-underscore\fR +.br +Permit use of underscores in Slice identifiers. + +.TP +.BR \-\-load " " SLICE\fR +.br +Loads the Slice definitions contained in the file SLICE. This option may be +specified multiple times if several files must be loaded. However, it is the +user's responsibility to ensure that duplicate definitions do not occur (which +is possible when two files are loaded that share a common include file). One +strategy for avoiding duplicate definitions is to load a single Slice file +that contains only #include statements for each of the Slice files to be +loaded. No duplication is possible in this case if the included files use +include guards correctly. + +.TP +.BR \-\-key " " TYPE\fR +.TP +.BR \-\-value " " TYPE\fR +.br +Specifies the Slice type of the database key and value. If these options are +not specified, and the -e option is not used, dumpdb obtains type information +from the Freeze catalog. + +.TP +.BR \-e\fR +.br +Indicates that a Freeze evictor database is being examined. As a convenience, +this option automatically sets the database key and value types to those +appropriate for the Freeze evictor, and therefore the --key and --value +options are not necessary. Specifically, the key type of a Freeze evictor +database is Ice::Identity, and the value type is Freeze::ObjectRecord. +The latter is defined in the Slice file Freeze/EvictorStorage.ice, however +this file does not need to be explicitly loaded. If this option is not +specified, and the --key and --value options are not used, dumpdb obtains +type information from the Freeze catalog. + +.TP +.BR \-o " " FILE\fR +.br +Create a file named FILE containing sample descriptors for the loaded Slice +definitions. If type information is not specified, dumpdb obtains it from the +Freeze catalog. If the --select option is used, its expression is included in +the sample descriptors. Database traversal does not occur when the -o option +is used. + +.TP +.BR \-f " " FILE\fR +.br +Execute the descriptors in the file named FILE. The file's <database> +descriptor specifies the key and value types; therefore it is not necessary to +supply type information. + +.TP +.BR \-\-select " " EXPR\fR +.br +Only display those records for which the expression EXPR is true. The +expression can refer to the symbols key and value. + +.TP +.BR \-c ", " \-\-catalog\fR +.br +Display information about the databases in an environment, or about a +particular database. This option presents the type information contained in +the Freeze catalog. + +.SH SEE ALSO + +.BR transformdb (1) diff --git a/man/man1/glacier2router.1 b/man/man1/glacier2router.1 new file mode 100644 index 00000000000..744bb90d165 --- /dev/null +++ b/man/man1/glacier2router.1 @@ -0,0 +1,52 @@ +.TH glacie2router 1 + +.SH NAME + +glacier2router - The Glacier2 router daemon. + +.SH SYNOPSIS + +glacier2router [options] + +.SH DESCRIPTION + +Glacier2 is a lightweight firewall traversal solution for Ice applications. +Full documentation for Glacier2 is available online at: +.br +"http://doc.zeroc.com/display/Ice/Glacier2". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-\-nowarn\fR +.br +Suppress warnings. + +.TP +.BR \-\-daemon\fR +.br +Run as a daemon. + +.TP +.BR \-\-pidfile " " FILE +.br +Write process ID into FILE. + +.TP +.BR \-\-noclose\fR +.br +Do not close open file descriptors. + +.TP +.BR \-\-nochdir\fR +.br +Do not change the current working directory. diff --git a/man/man1/icebox.1 b/man/man1/icebox.1 new file mode 100644 index 00000000000..7b3afb5dcde --- /dev/null +++ b/man/man1/icebox.1 @@ -0,0 +1,56 @@ +.TH icebox 1 + +.SH NAME +icebox - The IceBox C++ service daemon. + +.SH SYNOPSIS + +icebox [options] + +.SH DESCRIPTION + +IceBox is an easy-to-use framework for Ice application services. Full +documentation for IceBox is available online at: +.br +"http://doc.zeroc.com/display/Ice/IceBox". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-\-nowarn\fR +.br +Suppress warnings. + +.TP +.BR \-\-daemon\fR +.br +Run as a daemon. + +.TP +.BR \-\-pidfile " " FILE +.br +Write process ID into FILE. + +.TP +.BR \-\-noclose\fR +.br +Do not close open file descriptors. + +.TP +.BR \-\-nochdir\fR +.br +Do not change the current working directory. + +.SH SEE ALSO + +.BR iceboxadmin (1), +.BR iceboxnet (1) diff --git a/man/man1/iceboxadmin.1 b/man/man1/iceboxadmin.1 new file mode 100644 index 00000000000..67737a5429a --- /dev/null +++ b/man/man1/iceboxadmin.1 @@ -0,0 +1,51 @@ +.mso www.tmac + +.TH iceboxadmin 1 + +.SH NAME + +iceboxadmin - The IceBox administrative utility. + +.SH SYNOPSIS + +iceboxadmin [options] [command...] + +.SH DESCRIPTION + +The IceBox administrative utility. Full documentation for iceboxadmin is +available online at: +.br +"http://doc.zeroc.com/display/Ice/IceBox+Administration#IceBoxAdministration-IceBoxAdministrativeUtility". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.SH COMMANDS + +.TP +.BR start " " SERVICE\fR +.br +Start a service. + +.TP +.BR stop " " SERVICE\fR +.br +Stop a service. + +.TP +.BR shutdown\fR +.br +Shutdown the server. + +.SH SEE ALSO + +.BR icebox (1), +.BR iceboxnet (1)
\ No newline at end of file diff --git a/man/man1/iceboxnet.1 b/man/man1/iceboxnet.1 new file mode 100644 index 00000000000..5b30eb009ef --- /dev/null +++ b/man/man1/iceboxnet.1 @@ -0,0 +1,20 @@ +.TH iceboxnet 1 + +.SH NAME + +iceboxnet - The IceBox .NET/Mono Server. + +.SH SYNOPSIS + +iceboxnet [options] --Ice.Config=<file> + +.SH DESCRIPTION + +The IceBox .NET/Mono Server. For detailed usage consult: +.br +"http://doc.zeroc.com/display/Ice/Starting+the+IceBox+Server#StartingtheIceBoxServer-StartingtheC#IceBoxServer". + +.SH SEE ALSO + +.BR icebox (1), +.BR iceboxadmin (1) diff --git a/man/man1/iceca.1 b/man/man1/iceca.1 new file mode 100644 index 00000000000..bba56d3826b --- /dev/null +++ b/man/man1/iceca.1 @@ -0,0 +1,14 @@ +.TH iceca 1 + +.SH NAME +iceca - Ice helper script for SSL certificate creation. + +.SH SYNOPSIS + +iceca [--verbose --keep] import sign request init + +.SH DESCRIPTION + +Full documentation for iceca is available online at: +.br +"http://doc.zeroc.com/display/Ice/Setting+up+a+Certificate+Authority". diff --git a/man/man1/icegridadmin.1 b/man/man1/icegridadmin.1 new file mode 100644 index 00000000000..934a1194863 --- /dev/null +++ b/man/man1/icegridadmin.1 @@ -0,0 +1,70 @@ +.TH icegridadmin 1 + +.SH NAME + +icegridadmin - The IceGrid command-line administrative utility. + +.SH SYNOPSIS + +icegridadmin [options] + +.SH DESCRIPTION + +The icegridadmin utility is a command-line tool for administering an IceGrid +domain. Deploying an application with this utility requires an XML file that +defines the descriptors. Full documentation for icegridadmin is available +online at: +.br +"http://doc.zeroc.com/display/Ice/icegridadmin+Command+Line+Tool". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Show program help. + +.TP +.BR \-v ", " \-\-version\fR +.br +Display the Ice version. + +.TP +.BR \-e " " COMMANDS\fR +.br +Execute COMMANDS. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug messages. + +.TP +.BR \-s ", " \-\-server\fR +.br +Start icegridadmin as a server (to parse XML files). + +.TP +.BR\-u ", " \-\-username\fR +.br +Login with the given username. + +.TP +.BR \-p ", " \-\-password\fR +.br +Login with the given password. + +.TP +.BR \-S ", " \-\-ssl\fR +.br +Authenticate through SSL. + +.TP +.BR \-r ", " \-\-replica " " NAME\fR +.br +Connect to the replica NAME. + +.SH SEE ALSO + +.BR icegridnode (1), +.BR icegridregistry (1), diff --git a/man/man1/icegridnode.1 b/man/man1/icegridnode.1 new file mode 100644 index 00000000000..447d82453cb --- /dev/null +++ b/man/man1/icegridnode.1 @@ -0,0 +1,73 @@ +.TH icegridnode 1 + +.SH NAME + +icegridnode - The IceGrid node server. + +.SH SYNOPSIS + +icegridnode [options] + +.SH DESCRIPTION + +An IceGrid node is a process that activates, monitors, and deactivates +registered server processes. You can run any number of nodes in a domain, but +typically there is one node per host. A node must be running on each host on +which servers are activated automatically, and nodes cannot run without an +IceGrid registry. The IceGrid node server is implemented by the icegridnode +executable. If you wish to run a registry and node in one process, +icegridnode is the executable you must use. Full documentation for icegridnode +is available online at: +.br +"http://doc.zeroc.com/display/Ice/icegridnode". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-\-daemon\fR +.br +Run as a daemon. + +.TP +.BR \-\-pidfile " " FILE +.br +Write process ID into FILE. + +.TP +.BR \-\-noclose\fR +.br +Do not close open file descriptors. + +.TP +.BR \-\-nochdir\fR +.br +Do not change the current working directory. + +.TP +.BR \-\-nowarn\fR +.br +Don't print any security warnings. + +.TP +.BR \-\-readonly\fR +.br +Start the collocated master registry in read-only mode. + +.TP +.BR \-\-deploy " " DESCRIPTOR " " [TARGET1 " " [TARGET2 " " ...]]\fR +.br +Add or update descriptor in file DESCRIPTOR, with optional targets. + +.SH SEE ALSO + +.BR icegridadmin (1), +.BR icegridregistry (1) diff --git a/man/man1/icegridregistry.1 b/man/man1/icegridregistry.1 new file mode 100644 index 00000000000..fa1e50fd079 --- /dev/null +++ b/man/man1/icegridregistry.1 @@ -0,0 +1,66 @@ +.TH icegridregistry 1 + +.SH NAME + +icegridregistry - The IceGrid registry server. + +.SH SYNOPSIS + +icegridregistry [options] [command...] + +.SH DESCRIPTION + +The IceGrid registry is a centralized repository of information, including +deployed applications and well-known objects. A registry can optionally be +collocated with an IceGrid node, which conserves resources and can be +convenient during development and testing. The registry server is implemented +by the icegridregistry executable. Full documentation for icegridregistry is +available online at: +.br +"http://doc.zeroc.com/display/Ice/icegridregistry". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-\-daemon\fR +.br +Run as a daemon. + +.TP +.BR \-\-pidfile " " FILE +.br +Write process ID into FILE. + +.TP +.BR \-\-noclose\fR +.br +Do not close open file descriptors. + +.TP +.BR \-\-nochdir\fR +.br +Do not change the current working directory. + +.TP +.BR \-\-nowarn\fR +.br +Don't print any security warnings. + +.TP +.BR \-\-readonly\fR +.br +Start the master registry in read-only mode. + +.SH SEE ALSO + +.BR icegridadmin (1), +.BR icegridnode (1) diff --git a/man/man1/icepatch2calc.1 b/man/man1/icepatch2calc.1 new file mode 100644 index 00000000000..d135e14a9ff --- /dev/null +++ b/man/man1/icepatch2calc.1 @@ -0,0 +1,65 @@ +.TH icepatch2calc 1 + +.SH NAME + +icepatch2calc - IcePatch2 tool to compress files and calculate checksums. + +.SH SYNOPSIS + +icepatch2calc [options] data_dir [file...] + +.SH DESCRIPTION + +IcePatch2 tool to compress files and calculate checksums. Full documentation +for icepatch2calc is available online at: +.br +"http://doc.zeroc.com/display/Ice/Using+icepatch2calc". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-z ", " \-\-compress\fR +.br +Normally, icepatch2calc scans the data directory and compresses a file only +if no compressed version exists, or if the compressed version of a file has a +modification time that predates that of the uncompressed version. If you +specify -z, the tool re-scans and recompresses the entire data directory, +regardless of the time stamps on files. This option is useful if you suspect +that time stamps in the data directory may be incorrect. + +.TP +.BR \-Z ", " \-\-no-compress\fR +.br +This option allows you to create a client-side checksum file. Do not use this +option when creating the checksum file for the server — the option is for +creating a client-side IcePatch2.sum file for updates of software on +distribution media. + +.TP +.BR \-i ", " \-\-case\-insensitive\fR +.br +This option disallows file names that differ only in case. (An error message +will be printed if icepatch2calc encounters any files that differ in case +only.) This is particularly useful for Unix servers with Windows clients, +since Windows folds the case of file names, and therefore such files would +override each other on the Windows client. + +.TP +.BR \-V ", " \-\-verbose\fR +.br +This option prints a progress message for each file that is compressed and for +each checksum that is computed. + +.SH SEE ALSO + +.BR icepatch2client (1), +.BR icepatch2server (1) diff --git a/man/man1/icepatch2client.1 b/man/man1/icepatch2client.1 new file mode 100644 index 00000000000..73a4e50cc9b --- /dev/null +++ b/man/man1/icepatch2client.1 @@ -0,0 +1,39 @@ +.mso www.tmac + +.TH icepatch2client 1 + +.SH NAME + +icepatch2client - The IcePatch2 client. + +.SH SYNOPSIS + +icepatch2client --IcePatch2Client.Proxy="IcePatch2Server/server:tcp -h somehost.com -p 10000" + +.SH DESCRIPTION + +The IcePatch2 client. Full documentation for icepatch2client is available +online at: +.br +"http://doc.zeroc.com/display/Ice/Running+the+IcePatch2+Client". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-t ", " \-\-thorough\fR +.br +Do a thorough patch, recomputing all checksums. + +.SH SEE ALSO + +.BR icepatch2calc (1), +.BR icepatch2server (1) diff --git a/man/man1/icepatch2server.1 b/man/man1/icepatch2server.1 new file mode 100644 index 00000000000..7653adc22fb --- /dev/null +++ b/man/man1/icepatch2server.1 @@ -0,0 +1,50 @@ +.TH icepatch2server 1 + +.SH NAME + +icepatch2server - The IcePatch2 server. + +.SH SYNOPSIS + +icepatch2server <data directory> + +.SH DESCRIPTION + +The IcePatch2 server. Full documentation for icepatch2server is available +online at: "http://doc.zeroc.com/display/Ice/Running+the+IcePatch2+Server". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-\-daemon\fR +.br +Run as a daemon. + +.TP +.BR \-\-pidfile " " FILE +.br +Write process ID into FILE. + +.TP +.BR \-\-noclose\fR +.br +Do not close open file descriptors. + +.TP +.BR \-\-nochdir\fR +.br +Do not change the current working directory. + +.SH SEE ALSO + +.BR icepatch2calc (1), +.BR icepatch2client (1) diff --git a/man/man1/icestormadmin.1 b/man/man1/icestormadmin.1 new file mode 100644 index 00000000000..7ea70a3e086 --- /dev/null +++ b/man/man1/icestormadmin.1 @@ -0,0 +1,43 @@ +.mso www.tmac + +.TH icestormadmin 1 + +.SH NAME + +icestormadmin - The IceStorm administration tool. + +.SH SYNOPSIS + +icestormadmin [options] [file...] + +.SH DESCRIPTION + +The IceStorm administration tool is a command-line program that provides +administrative control of an IceStorm server. Full documentation for +icestormadmin is available online at: +"http://doc.zeroc.com/display/Ice/IceStorm+Administration". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-e " " COMMANDS\fR +.br +Execute COMMANDS. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug messages. + +.SH SEE ALSO + +.BR icestormmigrate (1) diff --git a/man/man1/icestormmigrate.1 b/man/man1/icestormmigrate.1 new file mode 100644 index 00000000000..dd1f36f89c7 --- /dev/null +++ b/man/man1/icestormmigrate.1 @@ -0,0 +1,21 @@ +.TH icestormmigrate 1 + +.SH NAME + +icestormmigrate - Utility for migration of IceStorm database. + +.SH SYNOPSIS + +icestormmigrate <path-to-recovered.db> db + +.SH DESCRIPTION + +The icestormmigrate utility upgrades a 3.1 or 3.2 IceStorm database +environment to a 3.3 or superior IceStorm database environment for migration +of IceStorm database. For details about icestormmigrate consult: +.br +"http://doc.zeroc.com/display/Ice/Upgrading+your+Application+from+Ice+3.2+or+Earlier+Releases". + +.SH SEE ALSO + +.BR icestormadmin (1) diff --git a/man/man1/slice2cpp.1 b/man/man1/slice2cpp.1 new file mode 100644 index 00000000000..083e6bd4141 --- /dev/null +++ b/man/man1/slice2cpp.1 @@ -0,0 +1,137 @@ +.TH slice2cpp 1 + +.SH NAME + +slice2cpp - The Slice to C++ compiler. + +.SH SYNOPSIS + +slice2cpp [options] [files] + +.SH DESCRIPTION + +slice2cpp compiles Slice files to C++. + +Full documentation for slice2cpp is available online at: +.br +"http://doc.zeroc.com/display/Ice/slice2cpp+Command-Line+Options". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-DNAME\fR +.br +Defines the preprocessor symbol NAME. + +.TP +.BR \-DNAME=DEF\fR +.br +Defines the preprocessor symbol NAME with the value DEF. + +.TP +.BR \-UNAME\fR +.br +Undefines the preprocessor symbol NAME. + +.TP +.BR \-IDIR\fR +.br +Add the directory DIR to the search path for #include directives. + +.TP +.BR \-E\fR +.br +Print the preprocessor output on stdout. + +.TP +.BR \-\-output-dir " " DIR\fR +.br +Place the generated files into directory DIR. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug information showing the operation of the Slice parser. + +.TP +.BR \-\-ice\fR +.br +Permit use of the normally reserved prefix Ice for identifiers. Use this +option only when compiling the source code for the Ice run time. + +.TP +.BR \-\-underscore\fR +.br +Permit use of underscores in Slice identifiers. + +.TP +.BR \-\-header-ext " " EXT\fR +.br +Changes the file extension for the generated header files from the default h +to EXT. + +.TP +.BR \-\-source-ext " " EXT\fR +.br +Changes the file extension for the generated source files from the default +cpp to EXT. + +.TP +.BR \-\-add-header " " HDR[,GUARD] +.br +This option adds an include directive for the specified header at the +beginning of the generated source file (preceding any other include +directives). If GUARD is specified, the include directive is protected by the +specified guard. + +.TP +.BR \-\-include-dir " " DIR\fR +.br +Modifies #include directives in source files to prepend the path name of each +header file with the directory DIR. + +.TP +.BR \-\-impl\fR +.br +Generate sample implementation files. This option will not overwrite an +existing file. + +.TP +.BR \-\-depend\fR +Prints makefile dependency information to standard output. + +.TP +.BR \-\-dll-export " " SYMBOL\fR +.br +Use SYMBOL to control DLL exports or imports. This option allows you to +selectively export or import global symbols in the generated code. + +.TP +.BR \-\-checksum\fR +.br +Generate checksums for Slice definitions. + +.TP +.BR \-\-stream\fR +.br +Generate streaming helper functions for Slice types. + +.SH SEE ALSO + +.BR slice2cs (1), +.BR slice2freeze (1), +.BR slice2freezej (1), +.BR slice2html (1), +.BR slice2java (1), +.BR slice2php (1), +.BR slice2py (1), +.BR slice2rb (1) diff --git a/man/man1/slice2cs.1 b/man/man1/slice2cs.1 new file mode 100644 index 00000000000..481bc4d7163 --- /dev/null +++ b/man/man1/slice2cs.1 @@ -0,0 +1,111 @@ +.TH slice2cs 1 + +.SH NAME + +slice2cs - The Slice to .NET/Mono C# compiler. + +.SH SYNOPSIS + +slice2cs [options] [files] + +.SH DESCRIPTION + +slice2cs compiles Slice files to .NET/Mono C#. Full documentation for slice2cs +is available online at: +.br +"http://doc.zeroc.com/display/Ice/slice2cs+Command-Line+Options". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-DNAME\fR +.br +Defines the preprocessor symbol NAME. + +.TP +.BR \-DNAME=DEF\fR +.br +Defines the preprocessor symbol NAME with the value DEF. + +.TP +.BR \-UNAME\fR +.br +Undefines the preprocessor symbol NAME. + +.TP +.BR \-IDIR\fR +.br +Add the directory DIR to the search path for #include directives. + +.TP +.BR \-E\fR +.br +Print the preprocessor output on stdout. + +.TP +.BR \-\-output-dir " " DIR\fR +.br +Place the generated files into directory DIR. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug information showing the operation of the Slice parser. + +.TP +.BR \-\-ice\fR +.br +Permit use of the normally reserved prefix Ice for identifiers. Use this +option only when compiling the source code for the Ice run time. + +.TP +.BR \-\-underscore\fR +.br +Permit use of underscores in Slice identifiers. + +.TP +.BR \-\-tie\fR +.br +Generate tie classes. + +.TP +.BR \-\-impl\fR +.br +Generate sample implementation files. This option will not overwrite an +existing file. + +.TP +.BR \-\-impl\-tie +.br +Generate sample implementation files using tie classes. This option will not +overwrite an existing file. + +.TP +.BR \-\-checksum " " CLASS\fR +.br +Generate checksums for Slice definitions. + +.TP +.BR \-\-stream\fR +.br +Generate streaming helper functions for Slice types. + +.SH SEE ALSO + +.BR slice2cpp (1), +.BR slice2freeze (1), +.BR slice2freezej (1), +.BR slice2html (1), +.BR slice2java (1), +.BR slice2php (1), +.BR slice2py (1), +.BR slice2rb (1) diff --git a/man/man1/slice2freeze.1 b/man/man1/slice2freeze.1 new file mode 100644 index 00000000000..60dc978e99c --- /dev/null +++ b/man/man1/slice2freeze.1 @@ -0,0 +1,145 @@ +.TH slice2freeze 1 + +.SH NAME + +slice2freeze - The Slice to C++ compiler. + +.SH SYNOPSIS + +slice2freeze [options] [files] + +.SH DESCRIPTION + +slice2freeze compiles Slice files to C++. + +Full documentation for slice2freeze is available online at: +.br +"http://doc.zeroc.com/pages/viewpage.action?pageId=5048540". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-DNAME\fR +.br +Defines the preprocessor symbol NAME. + +.TP +.BR \-DNAME=DEF\fR +.br +Defines the preprocessor symbol NAME with the value DEF. + +.TP +.BR \-UNAME\fR +.br +Undefines the preprocessor symbol NAME. + +.TP +.BR \-IDIR\fR +.br +Add the directory DIR to the search path for #include directives. + +.TP +.BR \-E\fR +.br +Print the preprocessor output on stdout. + +.TP +.BR \-\-output-dir " " DIR\fR +.br +Place the generated files into directory DIR. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug information showing the operation of the Slice parser. + +.TP +.BR \-\-ice\fR +.br +Permit use of the normally reserved prefix Ice for identifiers. Use this +option only when compiling the source code for the Ice run time. + +.TP +.BR \-\-underscore\fR +.br +Permit use of underscores in Slice identifiers. + +.TP +.BR \-\-header-ext " " EXT\fR +.br +Changes the file extension for the generated header files from the default h +to EXT. + +.TP +.BR \-\-source-ext " " EXT\fR +.br +Changes the file extension for the generated source files from the default +cpp to EXT. + +.TP +.BR \-\-add-header " " HDR[,GUARD] +.br +This option adds an include directive for the specified header at the +beginning of the generated source file (preceding any other include +directives). If GUARD is specified, the include directive is protected by the +specified guard. + +.TP +.BR \-\-include-dir " " DIR\fR +.br +Modifies #include directives in source files to prepend the path name of each +header file with the directory DIR. + +.TP +.BR \-\-dll-export " " SYMBOL\fR +.br +Use SYMBOL to control DLL exports or imports. This option allows you to +selectively export or import global symbols in the generated code. + +.TP +.BR \-\-dict " " NAME,KEY,VALUE[,sort[,COMPARE]]\fR +.br +Generate a Freeze map class named NAME using KEY as key and VALUE as value. +This option may be specified multiple times to generate several Freeze maps. +NAME may be a scoped C++ name, such as Demo::Struct1ObjectMap. KEY and VALUE +represent Slice types and therefore must use Slice syntax, such as bool or +Ice::Identity. By default, keys are sorted using their binary Ice-encoded +representation. Include sort to sort with the COMPARE functor class. If +COMPARE is not specified, the default value is std::less<KEY>. + +.TP +.BR \-\-dict\-index " " MAP[,MEMBER] " " [,case\-sensitive|case\-insensitive][,sort[,COMPARE]]\fR +.br +Add an index to the Freeze map named MAP. If MEMBER is specified, the map +value type must be a structure or a class, and MEMBER must be a member of this +structure or class. + +.TP +.BR \-\-index " " CLASS,TYPE,MEMBER " " [,case-sensitive|case-insensitive]\fR +.br +Generate an index class for a Freeze evictor. CLASS is the name of the class +to be generated. TYPE denotes the type of class to be indexed (objects of +different classes are not included in this index). MEMBER is the name of the +data member in TYPE to index. When MEMBER has type string, it is possible to +specify whether the index is case-sensitive or not. The default is +case-sensitive. + +.SH SEE ALSO + +.BR slice2cpp (1), +.BR slice2cs (1), +.BR slice2freezej (1), +.BR slice2html (1), +.BR slice2java (1), +.BR slice2php (1), +.BR slice2py (1), +.BR slice2rb (1) diff --git a/man/man1/slice2freezej.1 b/man/man1/slice2freezej.1 new file mode 100644 index 00000000000..e569def2db1 --- /dev/null +++ b/man/man1/slice2freezej.1 @@ -0,0 +1,122 @@ +.TH slice2java 1 + +.SH NAME + +slice2java - The Slice to Java compiler. + +.SH SYNOPSIS + +slice2java [options] [files] + +.SH DESCRIPTION + +slice2java compiles Slice files to Java. + +Full documentation for slice2java is available online at: +.br +"http://doc.zeroc.com/display/Ice/Using+a+Freeze+Map+in+Java". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-DNAME\fR +.br +Defines the preprocessor symbol NAME. + +.TP +.BR \-DNAME=DEF\fR +.br +Defines the preprocessor symbol NAME with the value DEF. + +.TP +.BR \-UNAME\fR +.br +Undefines the preprocessor symbol NAME. + +.TP +.BR \-IDIR\fR +.br +Add the directory DIR to the search path for #include directives. + +.TP +.BR \-E\fR +.br +Print the preprocessor output on stdout. + +.TP +.BR \-\-output-dir " " DIR\fR +.br +Place the generated files into directory DIR. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug information showing the operation of the Slice parser. + +.TP +.BR \-\-ice\fR +.br +Permit use of the normally reserved prefix Ice for identifiers. Use this +option only when compiling the source code for the Ice run time. + +.TP +.BR \-\-underscore\fR +.br +Permit use of underscores in Slice identifiers. + +.TP +.BR \-\-dict " " NAME,KEY,VALUE\fR +.br +Generate a Freeze map class named NAME using KEY as key and VALUE as value. +This option may be specified multiple times to generate several Freeze maps. +NAME may be a scoped Java name, such as Demo.Struct1ObjectMap. KEY and VALUE +represent Slice types and therefore must use Slice syntax, such as bool or +Ice::Identity. + +.TP +.BR \-\-dict\-index " " MAP[,MEMBER][,case\-sensitive|case\-insensitive]\fR +.br +Add an index to the Freeze map named MAP. If MEMBER is specified, the map +value type must be a structure or a class, and MEMBER must be the name of a +member of that type. If MEMBER is not specified, the entire value is indexed. +When the indexed member (or entire value) is a string, the index can be +case-sensitive (default) or case-insensitive. + +.TP +.BR \-\-index " " CLASS,TYPE,MEMBER[,case\-sensitive|case\-insensitive]\fR +.br +Generate an index class for a Freeze evictor. CLASS is the name of the index +class to be generated. TYPE denotes the type of class to be indexed (objects +of different classes are not included in this index). MEMBER is the name of +the data member in TYPE to index. When MEMBER has type string, it is possible +to specify whether the index is case-sensitive or not. The default is +case-sensitive. + +.TP +.BR \-\-meta " " META\fR +.br +Define the global metadata directive META. Using this option is equivalent to +defining the global metadata META in each named Slice file, as well as in any +file included by a named Slice file. Global metadata specified with --meta +overrides any corresponding global metadata directive in the files being +compiled. + +.SH SEE ALSO + +.BR slice2cpp (1), +.BR slice2cs (1), +.BR slice2freeze (1), +.BR slice2html (1), +.BR slice2java (1), +.BR slice2php (1), +.BR slice2py (1), +.BR slice2rb (1) diff --git a/man/man1/slice2html.1 b/man/man1/slice2html.1 new file mode 100644 index 00000000000..4dbbe91fb99 --- /dev/null +++ b/man/man1/slice2html.1 @@ -0,0 +1,154 @@ +.TH slice2html 1 + +.SH NAME + +slice2html - The Slice to HTML documentation tool. + +.SH SYNOPSIS + +slice2html [options] [files] + +.SH DESCRIPTION + +slice2html generates HTML documentation from Slice files. + +Full documentation for slice2html is available online at: +.br +"http://doc.zeroc.com/display/Ice/Generating+Slice+Documentation". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-DNAME\fR +.br +Defines the preprocessor symbol NAME. + +.TP +.BR \-DNAME=DEF\fR +.br +Defines the preprocessor symbol NAME with the value DEF. + +.TP +.BR \-UNAME\fR +.br +Undefines the preprocessor symbol NAME. + +.TP +.BR \-IDIR\fR +.br +Add the directory DIR to the search path for #include directives. + +.TP +.BR \-E\fR +.br +Print the preprocessor output on stdout. + +.TP +.BR \-\-output-dir " " DIR\fR +.br +Place the generated files into directory DIR. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug information showing the operation of the Slice parser. + +.TP +.BR \-\-ice\fR +.br +Permit use of the normally reserved prefix Ice for identifiers. Use this +option only when compiling the source code for the Ice run time. + +.TP +.BR \-\-hdr " " FILE\fR +.br +Prepend FILE to each generated HTML file (except for _sindex.html). This +allows you to replace the HTML header and other preamble information with a +custom version, so you can connect style sheets to the generated pages. The +specified file must include the <body> tag (but need not end with a <body> +tag). FILE is expected to contain the string TITLE on a line by itself, +starting in column one. slice2html replaces the TITLE string with the +fully-scoped name of the Slice symbol that is documented on the corresponding +page. + +.TP +.BR \-\-ftr " " FILE\fR +.br +Append FILE to each generated HTML file (except for _sindex.html). This allows +you to add, for example, a custom footer to each generated page. FILE must +end with a </body> tag. + +.TP +.BR \-\-indexhdr " " FILE\fR +.br +slice2html generates a file _sindex.html that contains a table of contents of +all Slice symbols that hyperlink to the corresponding page. This option allows +you to replace the standard header with a custom header, for example, to attach +a JavaScript. The specified file must include the <body> tag (but need not end +with a <body> tag). The default value is the setting of --hdr (if any). + +.TP +.BR \-\-indexftr " " FILE\fR +.br +Append FILE to the generated sindex.html page. This allows you to add, for +example, a custom footer to the table of contents, or to invoke a JavaScript. +FILE is must end with a </body> tag. The default value is the setting of +--ftr (if any). + +.TP +.BR \-\-image\-dir " " DIR\fR +.br +With this option, slice2html looks in the specified directory for images to +use for the generated navigation hyperlinks. (Without this option, text links +are used instead.) Please see the generated HTML for the names of the various +image files. (They can easily be found by looking for img elements.) + +.TP +.BR \-\-logo\-url " " URL\fR +.br +Use the specified URL as a hyperlink for the company logo that is added to +each page (if --image-dir is specified). The company logo is expected to be in +<image_dir>/logo.gif. + +.TP +.BR \-\-search " " ACTION\fR +.br +If this option is specified, the generated pages contain a search box that +allows you to connect the generated pages to a search engine. On pressing +the "Search" button, the specified ACTION is carried out. + +.TP +.BR \-\-index " " NUM\fR +.br +slice2html generates sub-indexes for various Slice symbols. This option +controls how many entries must be present before a sub-index is generated. +For example, if NUM is set to 3, a sub-index will be generated only if there +are three or more symbols that appear in that index. The default settings is +1, meaning that a sub-index is always generated. To disable sub-indexes +entirely, set NUM to 0. + +.TP +.BR \-\-summary " " NUM\fR +.br +If this option is set, summary sentences that exceed NUM characters generate +a warning. + +.SH SEE ALSO + +.BR slice2cs (1), +.BR slice2freeze (1), +.BR slice2freezej (1), +.BR slice2html (1), +.BR slice2java (1), +.BR slice2php (1), +.BR slice2py (1), +.BR slice2rb (1) diff --git a/man/man1/slice2java.1 b/man/man1/slice2java.1 new file mode 100644 index 00000000000..d5e15ef86ad --- /dev/null +++ b/man/man1/slice2java.1 @@ -0,0 +1,123 @@ +.TH slice2java 1 + +.SH NAME + +slice2java - The Slice to Java compiler. + +.SH SYNOPSIS + +slice2java [options] [files] + +.SH DESCRIPTION + +slice2java compiles Slice files to Java. Full documentation for slice2java is +available online at: +.br +"http://doc.zeroc.com/display/Ice/Using+the+Slice+Compiler+for+Java". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-DNAME\fR +.br +Defines the preprocessor symbol NAME. + +.TP +.BR \-DNAME=DEF\fR +.br +Defines the preprocessor symbol NAME with the value DEF. + +.TP +.BR \-UNAME\fR +.br +Undefines the preprocessor symbol NAME. + +.TP +.BR \-IDIR\fR +.br +Add the directory DIR to the search path for #include directives. + +.TP +.BR \-E\fR +.br +Print the preprocessor output on stdout. + +.TP +.BR \-\-output-dir " " DIR\fR +.br +Place the generated files into directory DIR. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug information showing the operation of the Slice parser. + +.TP +.BR \-\-ice\fR +.br +Permit use of the normally reserved prefix Ice for identifiers. Use this +option only when compiling the source code for the Ice run time. + +.TP +.BR \-\-underscore\fR +.br +Permit use of underscores in Slice identifiers. + +.TP +.BR \-\-tie\fR +.br +Generate tie classes. + +.TP +.BR \-\-impl\fR +.br +Generate sample implementation files. This option will not overwrite an +existing file. + +.TP +.BR \-\-impl\-tie +.br +Generate sample implementation files using tie classes. This option will not +overwrite an existing file. + +.TP +.BR \-\-checksum " " CLASS\fR +.br +Generate checksums for Slice definitions into the class CLASS. The given class +name may optionally contain a package specifier. The generated class contains +checksums for all of the Slice files being translated by this invocation of +the compiler. + +.TP +.BR \-\-stream\fR +.br +Generate streaming helper functions for Slice types. + +.TP +.BR \-\-meta " " META\fR +.br +Define the global metadata directive META. Using this option is equivalent to +defining the global metadata META in each named Slice file, as well as in any +file included by a named Slice file. Global metadata specified with --meta +overrides any corresponding global metadata directive in the files being +compiled. + +.SH SEE ALSO + +.BR slice2cpp (1), +.BR slice2cs (1), +.BR slice2freeze (1), +.BR slice2freezej (1), +.BR slice2html (1), +.BR slice2php (1), +.BR slice2py (1), +.BR slice2rb (1) diff --git a/man/man1/slice2php.1 b/man/man1/slice2php.1 new file mode 100644 index 00000000000..da1c84211e8 --- /dev/null +++ b/man/man1/slice2php.1 @@ -0,0 +1,99 @@ +.TH slice2php 1 + +.SH NAME +slice2php - The Slice to PHP compiler. + +.SH SYNOPSIS +slice2php [options] [files] + +.SH DESCRIPTION +slice2php compiles Slice files to PHP. + +Full documentation for slice2php is available online at: +.br +"http://doc.zeroc.com/display/Ice/slice2php+Command-Line+Options". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-DNAME\fR +.br +Defines the preprocessor symbol NAME. + +.TP +.BR \-DNAME=DEF\fR +.br +Defines the preprocessor symbol NAME with the value DEF. + +.TP +.BR \-UNAME\fR +.br +Undefines the preprocessor symbol NAME. + +.TP +.BR \-IDIR\fR +.br +Add the directory DIR to the search path for #include directives. + +.TP +.BR \-E\fR +.br +Print the preprocessor output on stdout. + +.TP +.BR \-\-output-dir " " DIR\fR +.br +Place the generated files into directory DIR. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug information showing the operation of the Slice parser. + +.TP +.BR \-\-ice\fR +.br +Permit use of the normally reserved prefix Ice for identifiers. Use this +option only when compiling the source code for the Ice run time. + +.TP +.BR \-\-underscore\fR +.br +Permit use of underscores in Slice identifiers. + +.TP +.BR \-\-all\fR +.br +Generate code for all Slice definitions, including those from included files. + +.TP +.BR \-n ", " \-\-namespace\fR +.br +Generate code using PHP namespaces. Note that namespaces are only supported +in PHP 5.3 or later. Also note that the Ice extension for PHP must be built +with namespace support enabled. + +.TP +.BR \-\-checksum " " CLASS\fR +.br +Generate checksums for Slice definitions. + +.SH SEE ALSO + +.BR slice2cpp (1), +.BR slice2cs (1), +.BR slice2freeze (1), +.BR slice2freezej (1), +.BR slice2html (1), +.BR slice2java (1), +.BR slice2py (1), +.BR slice2rb (1) diff --git a/man/man1/slice2py.1 b/man/man1/slice2py.1 new file mode 100644 index 00000000000..fd3aec730ba --- /dev/null +++ b/man/man1/slice2py.1 @@ -0,0 +1,99 @@ +.TH slice2py 1 + +.SH NAME + +slice2py - The Slice to Python compiler. + +.SH SYNOPSIS + +slice2py [options] [files] + +.SH DESCRIPTION + +slice2py compiles Slice files to Python. + +Full documentation for slice2py is available online at: +"http://doc.zeroc.com/display/Ice/Code+Generation+in+Python#CodeGenerationinPython-slice2py". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-DNAME\fR +.br +Defines the preprocessor symbol NAME. + +.TP +.BR \-DNAME=DEF\fR +.br +Defines the preprocessor symbol NAME with the value DEF. + +.TP +.BR \-UNAME\fR +.br +Undefines the preprocessor symbol NAME. + +.TP +.BR \-IDIR\fR +.br +Add the directory DIR to the search path for #include directives. + +.TP +.BR \-E\fR +.br +Print the preprocessor output on stdout. + +.TP +.BR \-\-output-dir " " DIR\fR +.br +Place the generated files into directory DIR. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug information showing the operation of the Slice parser. + +.TP +.BR \-\-ice\fR +.br +Permit use of the normally reserved prefix Ice for identifiers. Use this +option only when compiling the source code for the Ice run time. + +.TP +.BR \-\-underscore\fR +.br +Permit use of underscores in Slice identifiers. + +.TP +.BR \-\-all\fR +.br +Generate code for all Slice definitions, including those from included files. + +.TP +.BR \-\-checksum " " CLASS\fR +.br +Generate checksums for Slice definitions. + +.TP +.BR \-\-prefix " " PREFIX\fR +.br +Use PREFIX as the prefix for generated file names. + +.SH SEE ALSO + +.BR slice2cpp (1), +.BR slice2cs (1), +.BR slice2freeze (1), +.BR slice2freezej (1), +.BR slice2html (1), +.BR slice2java (1), +.BR slice2php (1), +.BR slice2rb (1) diff --git a/man/man1/slice2rb.1 b/man/man1/slice2rb.1 new file mode 100644 index 00000000000..9ca64af7a16 --- /dev/null +++ b/man/man1/slice2rb.1 @@ -0,0 +1,94 @@ +.TH slice2rb 1 + +.SH NAME + +slice2rb - The Slice to Ruby compiler. + +.SH SYNOPSIS + +slice2rb [options] [files] + +.SH DESCRIPTION + +slice2rb compiles Slice files to Ruby. + +Full documentation for slice2rb is available online at: +"http://doc.zeroc.com/display/Ice/Code+Generation+in+Ruby#CodeGenerationinRuby-slice2rb". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-DNAME\fR +.br +Defines the preprocessor symbol NAME. + +.TP +.BR \-DNAME=DEF\fR +.br +Defines the preprocessor symbol NAME with the value DEF. + +.TP +.BR \-UNAME\fR +.br +Undefines the preprocessor symbol NAME. + +.TP +.BR \-IDIR\fR +.br +Add the directory DIR to the search path for #include directives. + +.TP +.BR \-E\fR +.br +Print the preprocessor output on stdout. + +.TP +.BR \-\-output-dir " " DIR\fR +.br +Place the generated files into directory DIR. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug information showing the operation of the Slice parser. + +.TP +.BR \-\-ice\fR +.br +Permit use of the normally reserved prefix Ice for identifiers. Use this +option only when compiling the source code for the Ice run time. + +.TP +.BR \-\-underscore\fR +.br +Permit use of underscores in Slice identifiers. + +.TP +.BR \-\-all\fR +.br +Generate code for all Slice definitions, including those from included files. + +.TP +.BR \-\-checksum " " CLASS\fR +.br +Generate checksums for Slice definitions. + +.SH SEE ALSO + +.BR slice2cpp (1), +.BR slice2cs (1), +.BR slice2freeze (1), +.BR slice2freezej (1), +.BR slice2html (1), +.BR slice2java (1), +.BR slice2php (1), +.BR slice2py (1) diff --git a/man/man1/transformdb.1 b/man/man1/transformdb.1 new file mode 100644 index 00000000000..422ce761696 --- /dev/null +++ b/man/man1/transformdb.1 @@ -0,0 +1,175 @@ +.TH transformdb 1 + +.SH NAME + +transformdb - The Freeze database migration tool. + +.SH SYNOPSIS + +.p +transformdb -o FILE [-i] [slice-options] [type-options] +.IP +Generates descriptors in FILE for a database. + +.P +transformdb -o FILE [-i] [slice-options] DBENV +.IP +Generates descriptors in FILE for all databases in the environment DBENV. + +.P +transformdb [options] [slice-options] [type-options] DBENV DB NEWDBENV +.IP +Transform the database DB in the environment DBENV. A database of the +same name is created in the environment NEWDBENV. + +.P +transformdb [options] [slice-options] DBENV NEWDBENV +.IP +Transform all databases from the environment DBENV into the +environment NEWDBENV. + +.SH DESCRIPTION + +The FreezeScript tool transformdb migrates a database created by a Freeze map +or evictor. It accomplishes this by comparing the "old" Slice definitions +(i.e., the ones that describe the current contents of the database) with the +"new" Slice definitions, and making whatever modifications are necessary to +ensure that the transformed database is compatible with the new definitions. +Full documentation for transformdb is available online at: +"http://doc.zeroc.com/display/Ice/Using+transformdb". + +.SH OPTIONS + +.TP +.BR \-h ", " \-\-help\fR +.br +Displays a help message. + +.TP +.BR \-v ", " \-\-version\fR +Displays the compiler version. + +.TP +.BR \-DNAME\fR +.br +Defines the preprocessor symbol NAME. + +.TP +.BR \-DNAME=DEF\fR +.br +Defines the preprocessor symbol NAME with the value DEF. + +.TP +.BR \-UNAME\fR +.br +Undefines the preprocessor symbol NAME. + +.TP +.BR \-IDIR\fR +.br +Add the directory DIR to the search path for #include directives. + +.TP +.BR \-E\fR +.br +Print the preprocessor output on stdout. + +.TP +.BR \-\-output-dir " " DIR\fR +.br +Place the generated files into directory DIR. + +.TP +.BR \-d ", " \-\-debug\fR +.br +Print debug information showing the operation of the Slice parser. + +.TP +.BR \-\-ice\fR +.br +Permit use of the normally reserved prefix Ice for identifiers. Use this +option only when compiling the source code for the Ice run time. + +.TP +.BR \-\-underscore\fR +.br +Permit use of underscores in Slice identifiers. + +.TP +.BR \-\-old " " SLICE\fR +.TP +.BR \-\-new " " SLICE\fR +.br +Loads the old or new Slice definitions contained in the file SLICE. These +options may be specified multiple times if several files must be loaded. +However, it is the user's responsibility to ensure that duplicate definitions +do not occur (which is possible when two files are loaded that share a common +include file). One strategy for avoiding duplicate definitions is to load a +single Slice file that contains only #include statements for each of the Slice +files to be loaded. No duplication is possible in this case if the included +files use include guards correctly. + +.TP +.BR \-\-include-old " " DIR\fR +.TP +.BR \-\-include-new " " DIR\fR +.br +Adds the directory DIR to the set of include paths for the old or new Slice +definitions. + +.TP +.BR \-\-key " " TYPE[,TYPE]\fR +.TP +.BR \-\-value " " TYPE[,TYPE]\fR +.br +Specifies the Slice type(s) of the database key and value. If the type does +not change, then the type only needs to be specified once. Otherwise, the old +type is specified first, followed by a comma and the new type. For example, +the option --key int,string indicates that the database key is migrating from +int to string. On the other hand, the option --key int,int indicates that the +key type does not change, and could be given simply as --key int. Type changes +are restricted to those allowed by the compatibility rules, but custom +migration provides additional flexibility. + +.TP +.BR \-e\fR +.br +Indicates that a Freeze evictor database is being migrated. As a convenience, +this option automatically sets the database key and value types to those +appropriate for the Freeze evictor, and therefore the --key and --value +options are not necessary. Specifically, the key type of a Freeze evictor +database is Ice::Identity, and the value type is Freeze::ObjectRecord. The +latter is defined in the Slice file Freeze/EvictorStorage.ice; however, this +file does not need to be loaded into your old and new Slice definitions. + +.TP +.BR \-i\fR +.br +Requests that transformdb ignore type changes that violate the compatibility +rules. If this option is not specified, transformdb fails immediately if such +a violation occurs. With this option, a warning is displayed but transformdb +continues the requested action. The -i option can be specified in analysis or +automatic migration modes. + +.TP +.BR \-p\fR +During migration, this option requests that transformdb purge object instances +whose type is no longer found in the new Slice definitions. + +.TP +.BR \-c\fR +.br +Use catastrophic recovery on the old Berkeley DB database environment prior to +migration. + +.TP +.BR \-w\fR +.br +Suppress duplicate warnings during migration. This option is especially useful +to minimize diagnostic messages when transformdb would otherwise emit the same +warning many times, such as when it detects the same issue in every record of +a database. + +.SH SEE ALSO + +.BR dumpdb (1), |