summaryrefslogtreecommitdiff
path: root/gobject
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2010-05-21 22:28:42 -0400
committerMatthias Clasen <mclasen@redhat.com>2010-05-21 22:28:42 -0400
commit8db946fdfb71167dd8b740b4ba20213303a0f2bf (patch)
tree5c5b069844aded79091cda3e7418d83edb26558c /gobject
parentd818bebf4949617fdf5ffc7833c8f87ccca5c1a1 (diff)
downloadglib-8db946fdfb71167dd8b740b4ba20213303a0f2bf.tar.gz
Clean up man page handling
Remove all formatted man pages from git, and use the same Makefile fragment in all doc dirs.
Diffstat (limited to 'gobject')
-rw-r--r--gobject/Makefile.am2
-rw-r--r--gobject/glib-genmarshal.1212
-rw-r--r--gobject/glib-mkenums.1169
3 files changed, 0 insertions, 383 deletions
diff --git a/gobject/Makefile.am b/gobject/Makefile.am
index 5f31e2a23..9abcabc32 100644
--- a/gobject/Makefile.am
+++ b/gobject/Makefile.am
@@ -235,9 +235,7 @@ EXTRA_DIST += \
makefile.msc.in \
gobject.rc.in \
libgobject-gdb.py.in \
- glib-genmarshal.1 \
glib-mkenums.in \
- glib-mkenums.1 \
abicheck.sh \
pltcheck.sh
diff --git a/gobject/glib-genmarshal.1 b/gobject/glib-genmarshal.1
deleted file mode 100644
index f0adfaafd..000000000
--- a/gobject/glib-genmarshal.1
+++ /dev/null
@@ -1,212 +0,0 @@
-.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>.
diff --git a/gobject/glib-mkenums.1 b/gobject/glib-mkenums.1
deleted file mode 100644
index cacddfff6..000000000
--- a/gobject/glib-mkenums.1
+++ /dev/null
@@ -1,169 +0,0 @@
-.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>.