glib-gettextize.1 \
gtester.1 \
gtester-report.1
+
if ENABLE_MAN
-%.1 : %.xml
- @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+.xml.1:
+ XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+dist-local-check-mans-enabled:
+ if grep "Man generation disabled" $(man_MANS) >/dev/null; then $(RM) $(man_MANS); fi
+
+else
+
+$(man_MANS):
+ echo Man generation disabled. Creating dummy $@. Configure with --enable-man to enable it.
+ echo Man generation disabled. Remove this file, configure with --enable-man, and rebuild > $@
+
+dist-local-check-mans-enabled:
+ echo "*** --enable-man must be used in order to make dist"
+ false
endif
-BUILT_EXTRA_DIST = $(man_MANS)
+MAINTAINERCLEANFILES = $(man_MANS) $(BUILT_SOURCES)
+
+EXTRA_DIST += $(man_MANS)
-dist-hook-local: $(BUILT_EXTRA_DIST)
- files='$(BUILT_EXTRA_DIST)'; \
- for f in $$files; do \
- if test -f $$f; then d=.; else d=$(srcdir); fi; \
- cp $$d/$$f $(distdir) || exit 1; done
+dist-hook-local: dist-local-check-mans-enabled glib-docs-clean all-local
+glib-docs-clean: clean
+ cd $(srcdir) && rm -rf xml html
+++ /dev/null
-'\" t
-.\" Title: glib-gettextize
-.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 04/19/2010
-.\" Manual: User Commands
-.\" Source: User Commands
-.\" Language: English
-.\"
-.TH "GLIB\-GETTEXTIZE" "1" "04/19/2010" "User Commands" "User Commands"
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-glib-gettextize \- gettext internationalization utility
-.SH "SYNOPSIS"
-.HP \w'\fBglib\-gettextize\fR\ 'u
-\fBglib\-gettextize\fR [option...] [directory]
-.SH "DESCRIPTION"
-.PP
-\fBglib\-gettextize\fR
-helps to prepare a source package for being internationalized through
-gettext\&. It is a variant of the
-\fBgettextize\fR
-that ships with
-gettext\&.
-.PP
-\fBglib\-gettextize\fR
-differs from
-\fBgettextize\fR
-in that it doesn\'t create an
-intl/
-subdirectory and doesn\'t modify
-po/ChangeLog
-(note that newer versions of
-\fBgettextize\fR
-behave like this when called with the
-\fB\-\-no\-changelog\fR
-option)\&.
-.SS "Options"
-.PP
-\fB\-\-help\fR
-.RS 4
-print help and exit
-.RE
-.PP
-\fB\-\-version\fR
-.RS 4
-print version information and exit
-.RE
-.PP
-\fB\-c\fR, \fB\-\-copy\fR
-.RS 4
-copy files instead of making symlinks
-.RE
-.PP
-\fB\-f\fR, \fB\-\-force\fR
-.RS 4
-force writing of new files even if old ones exist
-.RE
-.SH "SEE ALSO"
-.PP
-
-\fBgettextize\fR(1)
+++ /dev/null
-'\" t
-.\" Title: gtester-report
-.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 04/19/2010
-.\" Manual: User Commands
-.\" Source: User Commands
-.\" Language: English
-.\"
-.TH "GTESTER\-REPORT" "1" "04/19/2010" "User Commands" "User Commands"
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-gtester-report \- test report formatting utility
-.SH "SYNOPSIS"
-.HP \w'\fBgtester\-report\fR\ 'u
-\fBgtester\-report\fR [option...] [gtester\-log]
-.SH "DESCRIPTION"
-.PP
-\fBgtester\-report\fR
-is a script which converts the XML output generated by gtester into HTML\&.
-.SS "Options"
-.PP
-\fB\-h\fR, \fB\-\-help\fR
-.RS 4
-print help and exit
-.RE
-.PP
-\fB\-v\fR, \fB\-\-version\fR
-.RS 4
-print version information and exit
-.RE
-.SH "SEE ALSO"
-.PP
-
-\fBgtester\fR(1)
+++ /dev/null
-'\" t
-.\" Title: gtester
-.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 04/19/2010
-.\" Manual: User Commands
-.\" Source: User Commands
-.\" Language: English
-.\"
-.TH "GTESTER" "1" "04/19/2010" "User Commands" "User Commands"
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-gtester \- test running utility
-.SH "SYNOPSIS"
-.HP \w'\fBgtester\fR\ 'u
-\fBgtester\fR [option...] [testprogram]
-.SH "DESCRIPTION"
-.PP
-\fBgtester\fR
-is a utility to run unit tests that have been written using the GLib test framework\&.
-.PP
-When called with the
-\fB\-o\fR
-option,
-\fBgtester\fR
-writes an XML report of the test results, which can be converted into HTML using the
-\fBgtester\-report\fR
-utility\&.
-.SS "Options"
-.PP
-\fB\-h\fR, \fB\-\-help\fR
-.RS 4
-print help and exit
-.RE
-.PP
-\fB\-v\fR, \fB\-\-version\fR
-.RS 4
-print version information and exit
-.RE
-.PP
-\fB\-\-g\-fatal\-warnings\fR
-.RS 4
-make warnings fatal
-.RE
-.PP
-\fB\-k\fR, \fB\-\-keep\-going\fR
-.RS 4
-continue running after tests failed
-.RE
-.PP
-\fB\-l\fR
-.RS 4
-list paths of available test cases
-.RE
-.PP
-\fB\-m=\fR\fB\fIMODE\fR\fR
-.RS 4
-run test cases in
-\fIMODE\fR, which can be perf, slow, thorough or quick\&. The default mode is quick\&.
-.RE
-.PP
-\fB\-p=\fR\fB\fITESTPATH\fR\fR
-.RS 4
-only run test cases matching
-\fITESTPATH\fR
-.RE
-.PP
-\fB\-\-seed=\fR\fB\fISEEDSTRING\fR\fR
-.RS 4
-run all test cases with random number seed
-\fISEEDSTRING\fR
-.RE
-.PP
-\fB\-o=\fR\fB\fILOGFILE\fR\fR
-.RS 4
-write the test log to
-\fILOGFILE\fR
-.RE
-.PP
-\fB\-q\fR, \fB\-\-quiet\fR
-.RS 4
-suppress per test binary output
-.RE
-.PP
-\fB\-\-verbose\fR
-.RS 4
-report success per testcase
-.RE
-.SH "SEE ALSO"
-.PP
-
-\fBgtester-report\fR(1)
########################################################################
-man_MANS = glib-mkenums.1 glib-genmarshal.1 gobject-query.1
+man_MANS = \
+ glib-mkenums.1 \
+ glib-genmarshal.1 \
+ gobject-query.1
if ENABLE_MAN
-%.1 : %.xml
- @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+.xml.1:
+ XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+dist-local-check-mans-enabled:
+ if grep "Man generation disabled" $(man_MANS) >/dev/null; then $(RM) $(man_MANS); fi
+
+else
+
+$(man_MANS):
+ echo Man generation disabled. Creating dummy $@. Configure with --enable-man to enable it.
+ echo Man generation disabled. Remove this file, configure with --enable-man, and rebuild > $@
+
+dist-local-check-mans-enabled:
+ echo "*** --enable-man must be used in order to make dist"
+ false
endif
-BUILT_EXTRA_DIST = $(man_MANS)
+MAINTAINERCLEANFILES = $(man_MANS) $(BUILT_SOURCES)
+
+EXTRA_DIST += $(man_MANS)
+
+dist-hook-local: dist-local-check-mans-enabled gobject-docs-clean all-local
-dist-hook-local: $(BUILT_EXTRA_DIST)
- files='$(BUILT_EXTRA_DIST)'; \
- for f in $$files; do \
- if test -f $$f; then d=.; else d=$(srcdir); fi; \
- cp $$d/$$f $(distdir) || exit 1; done
+gobject-docs-clean: clean
+ cd $(srcdir) && rm -rf xml html
+++ /dev/null
-'\" t
-.\" Title: glib-genmarshal
-.\" Author: [see the "Author" section]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 04/19/2010
-.\" Manual: User Commands
-.\" Source: User Commands
-.\" Language: English
-.\"
-.TH "GLIB\-GENMARSHAL" "1" "04/19/2010" "User Commands" "User Commands"
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-glib-genmarshal \- C code marshaller generation utility for GLib closures
-.SH "SYNOPSIS"
-.HP \w'\fBglib\-genmarshal\fR\ 'u
-\fBglib\-genmarshal\fR [options...] [files...]
-.SH "DESCRIPTION"
-.PP
-\fBglib\-genmarshal\fR
-is a small utility that generates C code marshallers for callback functions of the GClosure mechanism in the GObject sublibrary of GLib\&. The marshaller functions have a standard signature, they get passed in the invoking closure, an array of value structures holding the callback function parameters and a value structure for the return value of the callback\&. The marshaller is then responsible to call the respective C code function of the closure with all the parameters on the stack and to collect its return value\&.
-.SH "INVOCATION"
-.PP
-\fBglib\-genmarshal\fR
-takes a list of marshallers to generate as input\&. The marshaller list is either read from standard input or from files passed as additional arguments on the command line\&.
-.SS "Options"
-.PP
-\fB\-\-header\fR
-.RS 4
-Generate header file contents of the marshallers\&.
-.RE
-.PP
-\fB\-\-body\fR
-.RS 4
-Generate C code file contents of the marshallers\&.
-.RE
-.PP
-\fB\-\-prefix=string\fR, \fB\-\-prefix string\fR
-.RS 4
-Specify marshaller prefix\&. The default prefix is
-`g_cclosure_marshal\'\&.
-.RE
-.PP
-\fB\-\-skip\-source\fR
-.RS 4
-Skip source location remarks in generated comments\&.
-.RE
-.PP
-\fB\-\-nostdinc\fR
-.RS 4
-Do not use the standard marshallers of the GObject library, and skip
-gmarshal\&.h
-include directive in generated header files\&.
-.RE
-.PP
-\fB\-\-g\-fatal\-warnings\fR
-.RS 4
-Make warnings fatal, that is, exit immediately once a warning occurs\&.
-.RE
-.PP
-\fB\-h\fR, \fB\-\-help\fR
-.RS 4
-Print brief help and exit\&.
-.RE
-.PP
-\fB\-v\fR, \fB\-\-version\fR
-.RS 4
-Print version and exit\&.
-.RE
-.SS "Marshaller list format"
-.PP
-The marshaller lists are processed line by line, a line can contain a comment in the form of
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-# this is a comment
-.fi
-.if n \{\
-.RE
-.\}
-.sp
-or a marshaller specification of the form
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-\fIRTYPE\fR:\fIPTYPE\fR
-\fIRTYPE\fR:\fIPTYPE\fR,\fIPTYPE\fR
-\fIRTYPE\fR:\fIPTYPE\fR,\fIPTYPE\fR,\fIPTYPE\fR
-.fi
-.if n \{\
-.RE
-.\}
-.sp
-(up to 16
-\fIPTYPE\fRs may be present)\&.
-.PP
-The
-\fIRTYPE\fR
-part specifies the callback\'s return type and the
-\fIPTYPE\fRs right to the colon specify the callback\'s parameter list, except for the first and the last arguments which are always pointers\&.
-.SS "Parameter types"
-.PP
-Currently, the following types are supported:
-.PP
-\fIVOID\fR
-.RS 4
-indicates no return type, or no extra parameters\&. If
-\fIVOID\fR
-is used as the parameter list, no additional parameters may be present\&.
-.RE
-.PP
-\fIBOOLEAN\fR
-.RS 4
-for boolean types (gboolean)
-.RE
-.PP
-\fICHAR\fR
-.RS 4
-for signed char types (gchar)
-.RE
-.PP
-\fIUCHAR\fR
-.RS 4
-for unsigned char types (guchar)
-.RE
-.PP
-\fIINT\fR
-.RS 4
-for signed integer types (gint)
-.RE
-.PP
-\fIUINT\fR
-.RS 4
-for unsigned integer types (guint)
-.RE
-.PP
-\fILONG\fR
-.RS 4
-for signed long integer types (glong)
-.RE
-.PP
-\fIULONG\fR
-.RS 4
-for unsigned long integer types (gulong)
-.RE
-.PP
-\fIINT64\fR
-.RS 4
-for signed 64bit integer types (gint64)
-.RE
-.PP
-\fIUINT64\fR
-.RS 4
-for unsigned 64bit integer types (guint64)
-.RE
-.PP
-\fIENUM\fR
-.RS 4
-for enumeration types (gint)
-.RE
-.PP
-\fIFLAGS\fR
-.RS 4
-for flag enumeration types (guint)
-.RE
-.PP
-\fIFLOAT\fR
-.RS 4
-for single\-precision float types (gfloat)
-.RE
-.PP
-\fIDOUBLE\fR
-.RS 4
-for double\-precision float types (gdouble)
-.RE
-.PP
-\fISTRING\fR
-.RS 4
-for string types (gchar*)
-.RE
-.PP
-\fIBOXED\fR
-.RS 4
-for boxed (anonymous but reference counted) types (GBoxed*)
-.RE
-.PP
-\fIPARAM\fR
-.RS 4
-for GParamSpec or derived types (GParamSpec*)
-.RE
-.PP
-\fIPOINTER\fR
-.RS 4
-for anonymous pointer types (gpointer)
-.RE
-.PP
-\fIOBJECT\fR
-.RS 4
-for GObject or derived types (GObject*)
-.RE
-.PP
-\fINONE\fR
-.RS 4
-deprecated alias for
-\fIVOID\fR
-.RE
-.PP
-\fIBOOL\fR
-.RS 4
-deprecated alias for
-\fIBOOLEAN\fR
-.RE
-.SH "EXAMPLE"
-.PP
-To generate marshallers for the following callback functions:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-void foo (gpointer data1,
- gpointer data2);
-void bar (gpointer data1,
- gint param1,
- gpointer data2);
-gfloat baz (gpointer data1,
- gboolean param1,
- guchar param2,
- gpointer data2);
-.fi
-.if n \{\
-.RE
-.\}
-.PP
-The marshaller list has to look like this:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-VOID:VOID
-VOID:INT
-FLOAT:BOOLEAN,UCHAR
-.fi
-.if n \{\
-.RE
-.\}
-.PP
-The generated marshallers have the arguments encoded in their function name\&. For this particular list, they are
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-g_cclosure_marshal_VOID__VOID(),
-g_cclosure_marshal_VOID__INT(),
-g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR()\&.
-.fi
-.if n \{\
-.RE
-.\}
-.PP
-They can be used directly for GClosures or be passed in as the GSignalCMarshaller c_marshaller; argument upon creation of signals:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-GClosure *cc_foo, *cc_bar, *cc_baz;
-
-cc_foo = g_cclosure_new (NULL, foo, NULL);
-g_closure_set_marshal (cc_foo, g_cclosure_marshal_VOID__VOID);
-cc_bar = g_cclosure_new (NULL, bar, NULL);
-g_closure_set_marshal (cc_bar, g_cclosure_marshal_VOID__INT);
-cc_baz = g_cclosure_new (NULL, baz, NULL);
-g_closure_set_marshal (cc_baz, g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR);
-.fi
-.if n \{\
-.RE
-.\}
-.SH "SEE ALSO"
-.PP
-
-\fBglib\-mkenums\fR(1)
-.SH "BUGS"
-.PP
-None known yet\&.
-.SH "AUTHOR"
-.PP
-\fBglib\-genmarshal\fR
-has been written by Tim Janik
-timj@gtk\&.org\&.
-.PP
-This manual page was provided by Tim Janik
-timj@gtk\&.org\&.
+++ /dev/null
-'\" t
-.\" Title: glib-mkenums
-.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 05/13/2010
-.\" Manual: User Commands
-.\" Source: User Commands
-.\" Language: English
-.\"
-.TH "GLIB\-MKENUMS" "1" "05/13/2010" "User Commands" "User Commands"
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-glib-mkenums \- C language enum description generation utility
-.SH "SYNOPSIS"
-.HP \w'\fBglib\-mkenums\fR\ 'u
-\fBglib\-mkenums\fR [options...] [files...]
-.SH "DESCRIPTION"
-.PP
-\fBglib\-mkenums\fR
-is a small perl\-script utility that parses C code to extract enum definitions and produces enum descriptions based on text templates specified by the user\&. Most frequently this script is used to produce C code that contains enum values as strings so programs can provide value name strings for introspection\&.
-.SH "INVOCATION"
-.PP
-\fBglib\-mkenums\fR
-takes a list of valid C code files as input\&. The options specified control the text that is output, certain substitutions are performed on the text templates for keywords enclosed in @ characters\&.
-.SS "Options"
-.PP
-\fB\-\-fhead\fR \fItext\fR
-.RS 4
-Put out
-\fItext\fR
-prior to processing input files\&.
-.RE
-.PP
-\fB\-\-fprod\fR \fItext\fR
-.RS 4
-Put out
-\fItext\fR
-everytime a new input file is being processed\&.
-.RE
-.PP
-\fB\-\-ftail\fR \fItext\fR
-.RS 4
-Put out
-\fItext\fR
-after all input files have been processed\&.
-.RE
-.PP
-\fB\-\-eprod\fR \fItext\fR
-.RS 4
-Put out
-\fItext\fR
-everytime an enum is encountered in the input files\&.
-.RE
-.PP
-\fB\-\-vhead\fR \fItext\fR
-.RS 4
-Put out
-\fItext\fR
-before iterating over the set of values of an enum\&.
-.RE
-.PP
-\fB\-\-vprod\fR \fItext\fR
-.RS 4
-Put out
-\fItext\fR
-for every value of an enum\&.
-.RE
-.PP
-\fB\-\-vtail\fR \fItext\fR
-.RS 4
-Put out
-\fItext\fR
-after iterating over all values of an enum\&.
-.RE
-.PP
-\fB\-\-comments\fR \fItext\fR
-.RS 4
-Template for auto\-generated comments, the default (for C code generations) is
-"/* @comment@ */"\&.
-.RE
-.PP
-\fB\-\-template\fR \fIfile\fR
-.RS 4
-Read templates from the given file\&. The templates are enclosed in specially\-formatted C comments
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-/*** BEGIN section ***/
-/*** END section ***/
-.fi
-.if n \{\
-.RE
-.\}
-.sp
-where section may be
-file\-header,
-file\-production,
-file\-tail,
-enumeration\-production,
-value\-header,
-value\-production,
-value\-tail
-or
-comment\&.
-.RE
-.PP
-\fB\-\-help\fR
-.RS 4
-Print brief help and exit\&.
-.RE
-.PP
-\fB\-\-version\fR
-.RS 4
-Print version and exit\&.
-.RE
-.SS "Production text substitutions"
-.PP
-Certain keywords enclosed in @ characters will be substituted in the emitted text\&. For the substitution examples of the keywords below, the following example enum definition is assumed:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-typedef enum
-{
- PREFIX_THE_XVALUE = 1 << 3,
- PREFIX_ANOTHER_VALUE = 1 << 4
-} PrefixTheXEnum;
-.fi
-.if n \{\
-.RE
-.\}
-.PP
-@EnumName@
-.RS 4
-The name of the enum currently being processed, enum names are assumed to be properly namespaced and to use mixed capitalization to separate words (e\&.g\&. PrefixTheXEnum)\&.
-.RE
-.PP
-@enum_name@
-.RS 4
-The enum name with words lowercase and word\-separated by underscores (e\&.g\&. prefix_the_xenum)\&.
-.RE
-.PP
-@ENUMNAME@
-.RS 4
-The enum name with words uppercase and word\-separated by underscores (e\&.g\&. PREFIX_THE_XENUM)\&.
-.RE
-.PP
-@ENUMSHORT@
-.RS 4
-The enum name with words uppercase and word\-separated by underscores, prefix stripped (e\&.g\&. THE_XENUM)\&.
-.RE
-.PP
-@VALUENAME@
-.RS 4
-The enum value name currently being processed with words uppercase and word\-separated by underscores, this is the assumed literal notation of enum values in the C sources (e\&.g\&. PREFIX_THE_XVALUE)\&.
-.RE
-.PP
-@valuenick@
-.RS 4
-A nick name for the enum value currently being processed, this is usually generated by stripping common prefix words of all the enum values of the current enum, the words are lowercase and underscores are substituted by a minus (e\&.g\&. the\-xvalue)\&.
-.RE
-.PP
-@valuenum@
-.RS 4
-The integer value for the enum value currently being processed\&. This is calculated by using
-\fBperl\fR
-to attempt to evaluate the expression as it appears in the C source code\&. If evaluation fails then
-\fBglib\-mkenums\fR
-will exit with an error status, but this only happens if
-@valuenum@
-appears in your value production template\&. (Since: 2\&.26)
-.RE
-.PP
-@type@
-.RS 4
-This is substituted either by "enum" or "flags", depending on whether the enum value definitions contained bit\-shift operators or not (e\&.g\&. flags)\&.
-.RE
-.PP
-@Type@
-.RS 4
-The same as
-@type@
-with the first letter capitalized (e\&.g\&. Flags)\&.
-.RE
-.PP
-@TYPE@
-.RS 4
-The same as
-@type@
-with all letters uppercased (e\&.g\&. FLAGS)\&.
-.RE
-.PP
-@filename@
-.RS 4
-The name of the input file currently being processed (e\&.g\&. foo\&.h)\&.
-.RE
-.PP
-@basename@
-.RS 4
-The base name of the input file currently being processed (e\&.g\&. foo\&.h)\&. (Since: 2\&.22)
-.RE
-.SS "Trigraph extensions"
-.PP
-Some C comments are treated specially in the parsed enum definitions, such comments start out with the trigraph sequence
-/*<
-and end with the trigraph sequence
->*/\&. Per enum definition, the options "skip" and "flags" can be specified, to indicate this enum definition to be skipped, or for it to be treated as a flags definition, or to specify the common prefix to be stripped from all values to generate value nicknames, respectively\&. The "lowercase_name" option can be used to specify the word separation used in the *_get_type() function\&. For instance, /*< lowercase_name=gnome_vfs_uri_hide_options >*/\&.
-.PP
-Per value definition, the options "skip" and "nick" are supported\&. The former causes the value to be skipped, and the latter can be used to specify the otherwise auto\-generated nickname\&. Examples:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-typedef enum /*< skip >*/
-{
- PREFIX_FOO
-} PrefixThisEnumWillBeSkipped;
-typedef enum /*< flags,prefix=PREFIX >*/
-{
- PREFIX_THE_ZEROTH_VALUE, /*< skip >*/
- PREFIX_THE_FIRST_VALUE,
- PREFIX_THE_SECOND_VALUE,
- PREFIX_THE_THIRD_VALUE, /*< nick=the\-last\-value >*/
-} PrefixTheFlagsEnum;
-.fi
-.if n \{\
-.RE
-.\}
-.sp
-.SH "SEE ALSO"
-.PP
-
-\fBglib-genmarshal\fR(1)
+++ /dev/null
-'\" t
-.\" Title: gobject-query
-.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 04/19/2010
-.\" Manual: User Commands
-.\" Source: User Commands
-.\" Language: English
-.\"
-.TH "GOBJECT\-QUERY" "1" "04/19/2010" "User Commands" "User Commands"
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-.SH "NAME"
-gobject-query \- display a tree of types
-.SH "SYNOPSIS"
-.HP \w'\fBgobject\-query\fR\ 'u
-\fBgobject\-query\fR froots [options...]
-.HP \w'\fBgobject\-query\fR\ 'u
-\fBgobject\-query\fR tree [options...]
-.SH "DESCRIPTION"
-.PP
-
-\fBgobject\-query\fR
-is a small utility that draws a tree of types\&.
-.SH "INVOCATION"
-.PP
-
-\fBgobject\-query\fR
-takes a mandatory argument that specifies whether it should iterate over the fundamental types or print a type tree\&.
-.SS "Options"
-.PP
-\fBfroots\fR
-.RS 4
-iterate over fundamental roots
-.RE
-.PP
-\fBtree\fR
-.RS 4
-print type tree
-.RE
-.PP
-\fB\-r\fR \fItype\fR
-.RS 4
-specify the root type
-.RE
-.PP
-\fB\-n\fR
-.RS 4
-don\'t descend type tree
-.RE
-.PP
-\fB\-b\fR \fIstring\fR
-.RS 4
-specify indent string
-.RE
-.PP
-\fB\-i\fR \fIstring\fR
-.RS 4
-specify incremental indent string
-.RE
-.PP
-\fB\-s\fR \fInumber\fR
-.RS 4
-specify line spacing
-.RE
-.PP
-\fB\-h\fR, \fB\-\-help\fR
-.RS 4
-Print brief help and exit\&.
-.RE
-.PP
-\fB\-v\fR, \fB\-\-version\fR
-.RS 4
-Print version and exit\&.
-.RE
makefile.msc.in \
gobject.rc.in \
libgobject-gdb.py.in \
- glib-genmarshal.1 \
glib-mkenums.in \
- glib-mkenums.1 \
abicheck.sh \
pltcheck.sh
+++ /dev/null
-.TH GLIB-GENMARSHAL 1 "18 Oct 2000"
-.SH NAME
-glib-genmarshal \- C code marshaller generation utility for GLib closures
-.SH SYNOPSIS
-
-\fBglib-genmarshal\fP [\fIoptions\fP] [\fIfiles...\fP]
-
-.SH DESCRIPTION
-\fBglib-genmarshal\fP is a small utility that generates C code marshallers
-for callback functions of the GClosure mechanism in the GObject sublibrary
-of GLib. The marshaller functions have a standard signature, they get passed
-in the invoking closure, an array of value structures holding the callback
-function parameters and a value structure for the return value of the
-callback. The marshaller is then responsible to call the respective C code
-function of the closure with all the parameters on the stack and to collect
-its return value.
-
-.SH INVOCATION
-
-\fBglib-genmarshal\fP takes a list of marshallers to generate as input.
-The marshaller list is either read from standard input or from files
-passed as additional arguments on the command line.
-
-.SS Options
-.TP
-\fI--header
-Generate header file contents of the marshallers.
-.TP
-\fI--body
-Generate C code file contents of the marshallers.
-.TP
-\fI--prefix=string, --prefix string
-Specify marshaller prefix. The default prefix is `\fIg_cclosure_marshal\fP'.
-.TP
-\fI--skip-source
-Skip source location remarks in generated comments.
-.TP
-\fI--nostdinc
-Do not use the standard marshallers of the GObject library, and skip
-gmarshal.h include directive in generated header files.
-.TP
-\fI--internal
-Mark generated function as internal by using the G_GNUC_INTERNAL macro.
-.TP
-\fI--g-fatal-warnings
-Make warnings fatal, that is, exit immediately once a warning occurs.
-.TP
-\fI-h, --help\fP
-Print brief help and exit.
-.TP
-\fI-v, --version\fP
-Print version and exit.
-.PP
-
-.SS Marshaller list format
-.PP
-The marshaller lists are processed line by line, a line can contain a
-comment in the form of
-.RS
-.PP
-# this is a comment
-.PP
-.RE
-or a marshaller specification of the form
-.RS
-.PP
-\fIRTYPE\fP:\fBPTYPE\fP
-.PP
-\fIRTYPE\fP:\fBPTYPE\fP,\fBPTYPE\fP
-.PP
-\fIRTYPE\fP:\fBPTYPE\fP,\fBPTYPE\fP,\fBPTYPE\fP
-.PP
-# up to 16 \fBPTYPE\fPs may be present
-.PP
-.RE
-The \fIRTYPE\fP part specifies the callback's return type and
-the \fBPTYPE\fPs right to the colon specify the callback's
-parameter list, except for the first and the last arguments which
-are always pointers.
-.PP
-
-.SS Parameter types
-Currently, the following types are supported:
-.TP 12
-\fIVOID
-indicates no return type, or no extra parameters. if \fIVOID\fP is used as
-the parameter list, no additional parameters may be present.
-.TP 12
-\fIBOOLEAN
-for boolean types (gboolean)
-.TP 12
-\fICHAR
-for signed char types (gchar)
-.TP 12
-\fIUCHAR
-for unsigned char types (guchar)
-.TP 12
-\fIINT
-for signed integer types (gint)
-.TP 12
-\fIUINT
-for unsigned integer types (guint)
-.TP 12
-\fILONG
-for signed long integer types (glong)
-.TP 12
-\fIULONG
-for unsigned long integer types (gulong)
-.TP 12
-\fIINT64
-for signed 64bit integer types (gint64)
-.TP 12
-\fIUINT64
-for unsigned 64bit integer types (guint64)
-.TP 12
-\fIENUM
-for enumeration types (gint)
-.TP 12
-\fIFLAGS
-for flag enumeration types (guint)
-.TP 12
-\fIFLOAT
-for single-precision float types (gfloat)
-.TP 12
-\fIDOUBLE
-for double-precision float types (gdouble)
-.TP 12
-\fISTRING
-for string types (gchar*)
-.TP 12
-\fIBOXED
-for boxed (anonymous but reference counted) types (GBoxed*)
-.TP 12
-\fIPARAM
-for GParamSpec or derived types (GParamSpec*)
-.TP 12
-\fIPOINTER
-for anonymous pointer types (gpointer)
-.TP 12
-\fIOBJECT
-for GObject or derived types (GObject*)
-.TP 12
-\fINONE
-deprecated alias for \fIVOID\fP
-.TP 12
-\fIBOOL
-deprecated alias for \fIBOOLEAN\fP
-
-.SH EXAMPLE
-To generate marshallers for the following callback functions:
-.PP
-.RS
-.nf
-void foo (gpointer data1,
- gpointer data2);
-void bar (gpointer data1,
- gint param1,
- gpointer data2);
-gfloat baz (gpointer data1,
- gboolean param1,
- guchar param2,
- gpointer data2);
-.fi
-.RE
-.PP
-The marshaller list has to look like this:
-.PP
-.RS
-.nf
-VOID:VOID
-VOID:INT
-FLOAT:BOOLEAN,UCHAR
-.fi
-.RE
-.PP
-The generated marshallers have the arguments encoded
-in their function name. For this particular list, they
-are
-g_cclosure_marshal_VOID__VOID(),
-g_cclosure_marshal_VOID__INT(),
-g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR().
-.PP
-They can be used directly for GClosures or be passed in as
-the GSignalCMarshaller c_marshaller; argument upon creation
-of signals:
-.PP
-.nf
-GClosure *cc_foo, *cc_bar, *cc_baz;
-
-cc_foo = g_cclosure_new (NULL, foo, NULL);
-g_closure_set_marshal (cc_foo, g_cclosure_marshal_VOID__VOID);
-cc_bar = g_cclosure_new (NULL, bar, NULL);
-g_closure_set_marshal (cc_bar, g_cclosure_marshal_VOID__INT);
-cc_baz = g_cclosure_new (NULL, baz, NULL);
-g_closure_set_marshal (cc_baz, g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR);
-.fi
-.PP
-
-
-.SH SEE ALSO
-\fB
-glib-mkenums(1)
-\fP
-
-.SH BUGS
-None known yet.
-
-.SH AUTHOR
-.B glib-genmarshal
-has been written by Tim Janik <timj@gtk.org>.
-.PP
-This manual page was provided by Tim Janik <timj@gtk.org>.
+++ /dev/null
-.TH GLIB-MKENUMS 1 "27 Jul 2002"
-.SH NAME
-glib-mkenums \- C language enum description generation utility
-.SH SYNOPSIS
-
-\fBglib-mkenums\fP [\fIoptions\fP] [\fIfiles...\fP]
-
-.SH DESCRIPTION
-\fBglib-mkenums\fP is a small perl-script utility that parses C code to extract enum
-definitions and produces enum descriptions based on text templates specified
-by the user. Most frequently this script is used to produce C code that contains
-enum values as strings so programs can provide value name strings for introspection.
-
-.SH INVOCATION
-
-\fBglib-mkenums\fP takes a list of valid C code files as input. The options
-specified control the text that is output, certain substitutions are performed
-on the text templates for keywords enclosed in @ characters.
-
-
-.SS Options
-.TP
-\fI--fhead <text>
-Put out <text> prior to processing input files.
-.TP
-\fI--fprod <text>
-Put out <text> everytime a new input file is being processed.
-.TP
-\fI--ftail <text>
-Put out <text> after all input files have been processed.
-.TP
-\fI--eprod <text>
-Put out <text> everytime an enum is encountered in the input files.
-.TP
-\fI--vhead <text>
-Put out <text> before iterating over the set of values of an enum.
-.TP
-\fI--vprod <text>
-Put out <text> for every value of an enum.
-.TP
-\fI--vtail <text>
-Put out <text> after iterating over all values of an enum.
-.TP
-\fI--comments <text>
-Template for auto-generated comments, the default (for C code generations) is
-"/* @comment@ */".
-.TP
-\fI--template file
-Read templates from the given file. The templates are enclosed in
-specially-formatted C comments
-.PP
-.RS
-.nf
-/*** BEGIN section ***/
-/*** END section ***/
-.fi
-.PP
-where section may be file-header, file-production, file-tail,
-enumeration-production, value-header, value-production, value-tail or
-comment.
-.TP
-\fI-h, --help\fP
-Print brief help and exit.
-.TP
-\fI-v, --version\fP
-Print version and exit.
-.PP
-
-
-.SS Production text substitutions
-Certain keywords enclosed in @ characters will be substituted in the outputted
-text. For the substitution examples of the keywords below, the following example
-enum definition is assumed:
-.PP
-.RS
-.nf
-typedef enum
-{
- PREFIX_THE_XVALUE = 1 << 3,
- PREFIX_ANOTHER_VALUE = 1 << 4
-} PrefixTheXEnum;
-.fi
-.RE
-
-.TP 12
-\fI@EnumName@
-The name of the enum currently being processed, enum names are assumed to be
-properly namespaced and to use mixed capitalization to separate
-words (e.g. PrefixTheXEnum).
-.TP 12
-\fI@enum_name@
-The enum name with words lowercase and word-separated by underscores (e.g. prefix_the_xenum).
-.TP 12
-\fI@ENUMNAME@
-The enum name with words uppercase and word-separated by underscores (e.g. PREFIX_THE_XENUM).
-.TP 12
-\fI@ENUMSHORT@
-The enum name with words uppercase and word-separated by underscores, prefix stripped (e.g. THE_XENUM).
-.TP 12
-\fI@VALUENAME@
-The enum value name currently being processed with words uppercase and word-separated by underscores,
-this is the assumed literal notation of enum values in the C sources (e.g. PREFIX_THE_XVALUE).
-.TP 12
-\fI@valuenick@
-A nick name for the enum value currently being processed, this is usually generated by stripping
-common prefix words of all the enum values of the current enum, the words are lowercase and
-underscores are substituted by a minus (e.g. the-xvalue).
-.TP 12
-\fI@type@
-This is substituted either by "enum" or "flags", depending on whether the enum value definitions
-contained bit-shift operators or not (e.g. flags).
-.TP 12
-\fI@Type@
-The same as \fI@type@\fP with the first letter capitalized (e.g. Flags).
-.TP 12
-\fI@TYPE@
-The same as \fI@type@\fP with all letters uppercased (e.g. FLAGS).
-.TP 12
-\fI@filename@
-The name of the input file currently being processed (e.g. foo.h).
-.TP 12
-\fI@basename@
-The base name of the input file currently being processed (e.g. foo.h). (Since: 2.22)
-
-.SS Trigraph extensions
-Some C comments are treated specially in the parsed enum definitions, such comments
-start out with the trigraph sequence "/*<" and end with the trigraph sequence ">*/".
-.PP
-Per enum definition, the options "skip" and "flags" can be specified, to indicate
-this enum definition to be skipped, or for it to be treated as a flags definition, or
-to specify the common prefix to be stripped from all values to generate value nicknames,
-respectively. The "underscore_name" option can be used to specify the underscorized name
-variant used in the *_get_type() function and *_TYPE_* macro. For instance,
-/*< underscore_name=gnome_vfs_uri_hide_options >*/.
-.PP
-Per value definition, the options "skip" and "nick" are supported. The former causes the
-value to be skipped, and the latter can be used to specify the otherwise auto-generated
-nickname.
-Examples:
-.PP
-.RS
-.nf
-typedef enum /*< skip >*/
-{
- PREFIX_FOO
-} PrefixThisEnumWillBeSkipped;
-typedef enum /*< flags,prefix=PREFIX >*/
-{
- PREFIX_THE_ZEROTH_VALUE, /*< skip >*/
- PREFIX_THE_FIRST_VALUE,
- PREFIX_THE_SECOND_VALUE,
- PREFIX_THE_THIRD_VALUE, /*< nick=the-last-value >*/
-} PrefixTheFlagsEnum;
-.fi
-.RE
-
-.SH SEE ALSO
-\fB
-glib-genmarshal(1)
-\fP
-
-.SH BUGS
-None known yet.
-
-.SH AUTHOR
-.B glib-mkenums
-was written by Tim Janik <timj@gtk.org> and Owen Taylor <otaylor@redhat.com>.
-.PP
-This manual page was provided by Tim Janik <timj@gtk.org>.
projects / platform / upstream / glib.git / commitdiff