diff --git a/docs/reference/gio/gdbus-codegen.xml b/docs/reference/gio/gdbus-codegen.xml index 73a5d3fef..babbca2a7 100644 --- a/docs/reference/gio/gdbus-codegen.xml +++ b/docs/reference/gio/gdbus-codegen.xml @@ -1,5 +1,18 @@ + + gdbus + GIO + + + Developer + David + Zeuthen + zeuthen@gmail.com + + + + gdbus-codegen 1 @@ -819,14 +832,6 @@ on_handle_hello_world (MyAppFrobber *interface, - - Author - - Written by David Zeuthen with - a lot of help from many others. - - - Bugs diff --git a/docs/reference/gio/gdbus.xml b/docs/reference/gio/gdbus.xml index 4c81ce99d..81682d921 100644 --- a/docs/reference/gio/gdbus.xml +++ b/docs/reference/gio/gdbus.xml @@ -1,5 +1,18 @@ + + gdbus + GIO + + + Developer + David + Zeuthen + zeuthen@gmail.com + + + + gdbus 1 @@ -89,7 +102,8 @@ gdbus is a simple tool for working with D-Bus objects. - + + Commands @@ -140,7 +154,6 @@ - @@ -327,15 +340,7 @@ $ gdbus emit --session --object-path /bar --signal org.bar.Bar someString --dest - AUTHOR - - Written by David Zeuthen zeuthen@gmail.com with - a lot of help from many others. - - - - - BUGS + Bugs Please send bug reports to either the distribution bug tracker or the upstream bug tracker at @@ -344,7 +349,7 @@ $ gdbus emit --session --object-path /bar --signal org.bar.Bar someString --dest - SEE ALSO + See Also dbus-send1 diff --git a/docs/reference/gio/gio-querymodules.xml b/docs/reference/gio/gio-querymodules.xml index 7fecd3e3a..c9c5eeccc 100644 --- a/docs/reference/gio/gio-querymodules.xml +++ b/docs/reference/gio/gio-querymodules.xml @@ -1,5 +1,17 @@ + + glib-compile-schemas + GIO + + + Developer + Alexander + Larsson + + + + gio-querymodules 1 @@ -14,7 +26,7 @@ gio-querymodules - directory + DIRECTORY diff --git a/docs/reference/gio/glib-compile-resources.xml b/docs/reference/gio/glib-compile-resources.xml index 81ca220fb..700ff9a34 100644 --- a/docs/reference/gio/glib-compile-resources.xml +++ b/docs/reference/gio/glib-compile-resources.xml @@ -1,5 +1,17 @@ + + glib-compile-schemas + GIO + + + Developer + Alexander + Larsson + + + + glib-compile-resources 1 @@ -14,14 +26,14 @@ glib-compile-resources - option - file + OPTION + FILE Description glib-compile-resources reads the resource description from -file and the files that it references +FILE and the files that it references and creates a binary resource bundle that is suitable for use with the GResource API. The resulting bundle is then written out as-is, or as C source for linking into @@ -32,8 +44,9 @@ The XML resource files normally have the filename extension .gresource For a detailed description of the XML file format, see the GResource documentation. + -Options +Options @@ -44,18 +57,19 @@ Print help and exit - + -Store the compiled resources in TARGETFILE. If not specified a filename based -on the file basename is used. +Store the compiled resources in the file TARGET. +If not specified a filename based on the FILE +basename is used. - + -The files references in file are loaded from this directory. If -not specified the current directory is used. +The files referenced in FILE are loaded from +this directory. If not specified, the current directory is used. @@ -83,15 +97,17 @@ Write the output file in the format selected for by its filename extension: -Instead of a writing the resource bundle in binary form create a C source file that contains the -resource bundle. This can then be compiled into an application for easy access. +Instead of a writing the resource bundle in binary form create a C source file +that contains the resource bundle. This can then be compiled into an +application for easy access. -Generate a header file for use with C code generated by . +Generate a header file for use with C code generated by +. @@ -99,10 +115,10 @@ Generate a header file for use with C code generated by - + -Environment Variables +Environment XMLLINT -The full path to the xmllint executable. This is used to preprocess resources with the -xml-stripblanks preprocessing option. If this environment variable is not -set, xmllint is searched in the PATH. +The full path to the xmllint executable. This is used to preprocess resources +with the xml-stripblanks preprocessing option. If this +environment variable is not set, xmllint is searched in the +PATH. GDK_PIXBUF_PIXDATA -The full path to the gdk-pixbuf-pixdata executable. This is used to preprocess resources with the -to-pixdata preprocessing option. If this environment variable is not -set, gdk-pixbuf-pixdata is searched in the PATH. +The full path to the gdk-pixbuf-pixdata executable. This is used to preprocess +resources with the to-pixdata preprocessing option. If this +environment variable is not set, gdk-pixbuf-pixdata is searched in the +PATH. - - - -See also diff --git a/docs/reference/gio/glib-compile-schemas.xml b/docs/reference/gio/glib-compile-schemas.xml index 40c3fa113..04ed05f57 100644 --- a/docs/reference/gio/glib-compile-schemas.xml +++ b/docs/reference/gio/glib-compile-schemas.xml @@ -1,5 +1,17 @@ + + glib-compile-schemas + GIO + + + Developer + Ryan + Lortie + + + + glib-compile-schemas 1 @@ -14,14 +26,14 @@ glib-compile-schemas - option - directory + OPTION + DIRECTORY Description glib-compile-schemas compiles all the GSettings XML -schema files in directory into a binary file +schema files in DIRECTORY into a binary file with the name gschemas.compiled that can be used by GSettings. The XML schema files must have the filename extension .gschema.xml. @@ -50,8 +62,9 @@ numbered files have higher priority (eg: if the same override is made in a file numbered 10 and then again in a file numbered 20, the override from 20 will take precedence). + -Options +Options @@ -62,9 +75,9 @@ Print help and exit - + -Store gschemas.compiled in TARGETDIR instead of directory. +Store gschemas.compiled in the TARGET directory instead of DIRECTORY. @@ -86,9 +99,5 @@ in the future. - - -See also - diff --git a/docs/reference/gio/gresource.xml b/docs/reference/gio/gresource.xml index c577d26c8..7e4301527 100644 --- a/docs/reference/gio/gresource.xml +++ b/docs/reference/gio/gresource.xml @@ -1,5 +1,17 @@ + + gresource + GIO + + + Developer + Matthias + Clasen + + + + gresource 1 @@ -62,8 +74,9 @@ possible to select which one to operate on with the --section option. Use the sections command to find available sections. + -Commands +Commands @@ -109,8 +122,6 @@ Prints help and exits. - - diff --git a/docs/reference/gio/gsettings.xml b/docs/reference/gio/gsettings.xml index f55784dc2..7105d5912 100644 --- a/docs/reference/gio/gsettings.xml +++ b/docs/reference/gio/gsettings.xml @@ -1,5 +1,17 @@ + + gsettings + GIO + + + Developer + Ryan + Lortie + + + + gsettings 1 @@ -104,8 +116,9 @@ so e.g. a string must include explicit quotes: "'foo'". This format is also used when printing out values. + -Commands +Commands @@ -211,8 +224,6 @@ Prints help and exits. - - diff --git a/docs/reference/glib/glib-gettextize.xml b/docs/reference/glib/glib-gettextize.xml index e1183978f..f016b2855 100644 --- a/docs/reference/glib/glib-gettextize.xml +++ b/docs/reference/glib/glib-gettextize.xml @@ -1,5 +1,17 @@ + +glib-gettextize +GLib + + +Developer +Owen +Taylor + + + + glib-gettextize 1 @@ -14,8 +26,8 @@ glib-gettextize -option -directory +OPTION +DIRECTORY @@ -33,7 +45,9 @@ from gettextize in that it doesn't create an gettextize behave like this when called with the option). -Options + + +Options @@ -64,7 +78,6 @@ force writing of new files even if old ones exist - See also @@ -73,5 +86,3 @@ force writing of new files even if old ones exist - - diff --git a/docs/reference/glib/gtester-report.xml b/docs/reference/glib/gtester-report.xml index 09c10d394..3196ce8ba 100644 --- a/docs/reference/glib/gtester-report.xml +++ b/docs/reference/glib/gtester-report.xml @@ -1,5 +1,17 @@ + +gtester-report +GLib + + +Developer +Tim +Janik + + + + gtester-report 1 @@ -23,8 +35,9 @@ gtester-report is a script which converts the XML output generated by gtester into HTML. + -Options +Options @@ -42,7 +55,6 @@ print version information and exit - See also @@ -54,5 +66,3 @@ print version information and exit - - diff --git a/docs/reference/glib/gtester.xml b/docs/reference/glib/gtester.xml index 75a1cea9c..b1c126bd9 100644 --- a/docs/reference/glib/gtester.xml +++ b/docs/reference/glib/gtester.xml @@ -1,5 +1,22 @@ + +gtester +GLib + + +Developer +Tim +Janik + + +Developer +Sven +Herzberg + + + + gtester 1 @@ -14,7 +31,7 @@ gtester -option +OPTION testprogram @@ -28,8 +45,9 @@ When called with the option, gtester writes an XML report of the test results, which can be converted into HTML using the gtester-report utility. + -Options +Options @@ -73,33 +91,43 @@ list paths of available test cases run test cases in MODE, which can be one of: + run performance tests + + , run slow tests, or repeat non-deterministic tests more often + + do not run slow or performance tests, or do extra repeats of non-deterministic tests (default) + + run test cases that deliberately provoke checks or assertion failures, if implemented (default) + + do not run test cases that deliberately provoke checks or assertion failures + @@ -148,7 +176,6 @@ report success per testcase - See also diff --git a/docs/reference/gobject/glib-genmarshal.xml b/docs/reference/gobject/glib-genmarshal.xml index 1c8f673c4..db4f69241 100644 --- a/docs/reference/gobject/glib-genmarshal.xml +++ b/docs/reference/gobject/glib-genmarshal.xml @@ -1,5 +1,17 @@ + + glib-genmarshal + GObject + + + Developer + Tim + Janik + + + + glib-genmarshal 1 @@ -14,113 +26,27 @@ glib-genmarshal -options -files +OPTION +FILE Description -glib-genmarshal 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, +glib-genmarshal 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 +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. - -Invocation -glib-genmarshal takes a list of marshallers to generate as +glib-genmarshal 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. -Options - - - - - -Generate header file contents of the marshallers. - - - - - - -Generate C code file contents of the marshallers. - - - - -, - -Specify marshaller prefix. The default prefix is `g_cclosure_marshal'. - - - - - - -Skip source location remarks in generated comments. - - - - - - -Do not use the standard marshallers of the GObject library, and skip -gmarshal.h include directive in generated header files. - - - - - - -Mark generated functions as internal, using G_GNUC_INTERNAL. - - - - - - -Generate valist marshallers, for use with g_signal_set_va_marshaller(). - - - - -, - -Print version information. - - - - - - -Make warnings fatal, that is, exit immediately once a warning occurs. - - - - -, - -Print brief help and exit. - - - - -, - -Print version and exit. - - - - - - Marshaller list format The marshaller lists are processed line by line, a line can contain a @@ -137,9 +63,9 @@ or a marshaller specification of the form (up to 16 PTYPEs may be present). -The RTYPE part specifies the callback's return -type and the PTYPEs right to the colon specify -the callback's parameter list, except for the first and the last arguments +The RTYPE part specifies the callback's return +type and the PTYPEs right to the colon specify +the callback's parameter list, except for the first and the last arguments which are always pointers. @@ -150,8 +76,8 @@ Currently, the following types are supported: VOID -indicates no return type, or no extra parameters. -If VOID is used as the parameter list, no +indicates no return type, or no extra parameters. +If VOID is used as the parameter list, no additional parameters may be present. @@ -306,6 +232,91 @@ deprecated alias for BOOLEAN + +Options + + + + + +Generate header file contents of the marshallers. + + + + + + +Generate C code file contents of the marshallers. + + + + + + +Specify marshaller prefix. The default prefix is `g_cclosure_marshal'. + + + + + + +Skip source location remarks in generated comments. + + + + + + +Do not use the standard marshallers of the GObject library, and skip +gmarshal.h include directive in generated header files. + + + + + + +Mark generated functions as internal, using G_GNUC_INTERNAL. + + + + + + +Generate valist marshallers, for use with g_signal_set_va_marshaller(). + + + + +, + +Print version information. + + + + + + +Make warnings fatal, that is, exit immediately once a warning occurs. + + + + +, + +Print brief help and exit. + + + + +, + +Print version and exit. + + + + + + Example To generate marshallers for the following callback functions: @@ -330,16 +341,16 @@ VOID:INT FLOAT:BOOLEAN,UCHAR -The generated marshallers have the arguments encoded in their function name. +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_VOID__INT(), g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR(). -They can be used directly for GClosures or be passed in as the +They can be used directly for GClosures or be passed in as the GSignalCMarshaller c_marshaller; argument upon creation of signals: @@ -355,22 +366,10 @@ g_closure_set_marshal (cc_baz, g_cclosure_marshal_FLOAT__BOOLEAN_UCHAR); See also -glib-mkenums(1) - - -Bugs - -None known yet. - - -Author -glib-genmarshal has been written by Tim Janik -timj@gtk.org. - - -This manual page was provided by Tim Janik timj@gtk.org. + +glib-mkenums +1 + - - diff --git a/docs/reference/gobject/glib-mkenums.xml b/docs/reference/gobject/glib-mkenums.xml index ec91fec3c..d22c37a59 100644 --- a/docs/reference/gobject/glib-mkenums.xml +++ b/docs/reference/gobject/glib-mkenums.xml @@ -1,5 +1,17 @@ + + gdbus + GObject + + + Developer + Owen + Taylor + + + + glib-mkenums 1 @@ -14,154 +26,29 @@ glib-mkenums -options -files +OPTION +FILE Description -glib-mkenums 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 +glib-mkenums 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. - -Invocation glib-mkenums 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 +input. The options specified control the text that is output, certain +substitutions are performed on the text templates for keywords enclosed in @ characters. -Options - - - - text - -Put out text prior to processing input files. - - - - - text - -Put out text everytime a new input file -is being processed. - - - - - text - -Put out text after all input files have been -processed. - - - - - text - -Put out text everytime an enum is encountered -in the input files. - - - - - text - -Put out text before iterating over the set of -values of an enum. - - - - - text - -Put out text for every value of an enum. - - - - - text - -Put out text after iterating over all values -of an enum. - - - - - text - -Template for auto-generated comments, the default (for C code generations) is -"/* @comment@ */". - - - - - file - -Read templates from the given file. The templates are enclosed in -specially-formatted C comments - -/*** BEGIN section ***/ -/*** END section ***/ - -where section may be file-header, -file-production, file-tail, -enumeration-production, value-header, -value-production, value-tail or -comment. - - - - - prefix - -Indicates what portion of the enum name should be intepreted as the -prefix (eg, the "Gtk" in -"GtkDirectionType"). Normally this will be figured -out automatically, but you may need to override the default if your -namespace is capitalized oddly. - - - - - prefix - -Indicates what prefix should be used to correspond to the identifier -prefix in related C function names (eg, the "gtk" -in "gtk_direction_type_get_type". Equivalently, -this is the lowercase version of the prefix component of the enum -value names (eg, the "GTK" in -"GTK_DIR_UP". The default value is the identifier -prefix, converted to lowercase. - - - - - - -Print brief help and exit. - - - - - - -Print version and exit. - - - - - - Production text substitutions -Certain keywords enclosed in @ characters will be substituted in the -emitted text. For the substitution examples of the keywords below, +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: typedef enum @@ -183,7 +70,7 @@ words (e.g. PrefixTheXEnum). @enum_name@ -The enum name with words lowercase and word-separated by underscores +The enum name with words lowercase and word-separated by underscores (e.g. prefix_the_xenum). @@ -191,7 +78,7 @@ The enum name with words lowercase and word-separated by underscores @ENUMNAME@ -The enum name with words uppercase and word-separated by underscores +The enum name with words uppercase and word-separated by underscores (e.g. PREFIX_THE_XENUM). @@ -199,7 +86,7 @@ The enum name with words uppercase and word-separated by underscores @ENUMSHORT@ -The enum name with words uppercase and word-separated by underscores, +The enum name with words uppercase and word-separated by underscores, prefix stripped (e.g. THE_XENUM). @@ -207,9 +94,9 @@ prefix stripped (e.g. THE_XENUM). @VALUENAME@ -The enum value name currently being processed with words uppercase and +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 +this is the assumed literal notation of enum values in the C sources (e.g. PREFIX_THE_XVALUE). @@ -217,9 +104,9 @@ this is the assumed literal notation of enum values in the C sources @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 +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). @@ -239,7 +126,7 @@ production template. (Since: 2.26) @type@ -This is substituted either by "enum" or "flags", depending on whether the +This is substituted either by "enum" or "flags", depending on whether the enum value definitions contained bit-shift operators or not (e.g. flags). @@ -276,19 +163,19 @@ The base name of the input file currently being processed (e.g. foo.h). (Since: Trigraph extensions -Some C comments are treated specially in the parsed enum definitions, -such comments start out with the trigraph sequence /*< +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 +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 word separation used in the *_get_type() function. For instance, /*< underscore_name=gnome_vfs_uri_hide_options >*/. -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 +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: @@ -307,6 +194,130 @@ typedef enum /*< flags,prefix=PREFIX >*/ + +Options + + + + TEXT + +Put out TEXT prior to processing input files. + + + + + TEXT + +Put out TEXT everytime a new input file +is being processed. + + + + + TEXT + +Put out TEXT after all input files have been +processed. + + + + + TEXT + +Put out TEXT everytime an enum is encountered +in the input files. + + + + + TEXT + +Put out TEXT before iterating over the set of +values of an enum. + + + + + TEXT + +Put out TEXT for every value of an enum. + + + + + TEXT + +Put out TEXT after iterating over all values +of an enum. + + + + + TEXT + +Template for auto-generated comments, the default (for C code generations) is +"/* @comment@ */". + + + + + FILE + +Read templates from the given file. The templates are enclosed in +specially-formatted C comments + +/*** BEGIN section ***/ +/*** END section ***/ + +where section may be file-header, +file-production, file-tail, +enumeration-production, value-header, +value-production, value-tail or +comment. + + + + + PREFIX + +Indicates what portion of the enum name should be intepreted as the +prefix (eg, the "Gtk" in +"GtkDirectionType"). Normally this will be figured +out automatically, but you may need to override the default if your +namespace is capitalized oddly. + + + + + PREFIX + +Indicates what prefix should be used to correspond to the identifier +prefix in related C function names (eg, the "gtk" +in "gtk_direction_type_get_type". Equivalently, +this is the lowercase version of the prefix component of the enum +value names (eg, the "GTK" in +"GTK_DIR_UP". The default value is the identifier +prefix, converted to lowercase. + + + + + + +Print brief help and exit. + + + + + + +Print version and exit. + + + + + + See also @@ -316,5 +327,3 @@ typedef enum /*< flags,prefix=PREFIX >*/ - - diff --git a/docs/reference/gobject/gobject-query.xml b/docs/reference/gobject/gobject-query.xml index 5d9d8bc15..437d714ff 100644 --- a/docs/reference/gobject/gobject-query.xml +++ b/docs/reference/gobject/gobject-query.xml @@ -1,5 +1,17 @@ + + gobject-query + GObject + + + Developer + Tim + Janik + + + + gobject-query 1 @@ -15,47 +27,49 @@ gobject-query froots -options +OPTION gobject-query tree -options +OPTION Description -gobject-query is a small utility that draws a tree of +gobject-query is a small utility that draws a tree of types. - -Invocation gobject-query takes a mandatory argument that specifies whether it should iterate over the fundamental types or print a type tree. + -Options +Commands - iterate over fundamental roots - print type tree + + + +Options + - type + TYPE specify the root type @@ -69,14 +83,14 @@ don't descend type tree - string + STRING specify indent string - string + STRING specify incremental indent string @@ -84,7 +98,7 @@ specify incremental indent string - number + NUMBER specify line spacing @@ -105,8 +119,5 @@ Print version and exit. - - -