From: Rico Tzschichholz Date: Wed, 19 Sep 2018 12:22:26 +0000 (+0200) Subject: doc: Add valadbusgen manpage X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d7c00707c913c2e3f6d631154430a8217274bbfd;p=thirdparty%2Fvala.git doc: Add valadbusgen manpage --- diff --git a/doc/Makefile.am b/doc/Makefile.am index d2684a0e0..6e500a8cd 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -6,6 +6,7 @@ SUBDIRS = \ dist_man_MANS = \ valac.1 \ + valadbusgen.1 \ vala-gen-introspect.1 \ vapigen.1 \ $(NULL) @@ -18,6 +19,7 @@ endif EXTRA_DIST = \ valac.h2m \ + valadbusgen.h2m \ valadoc.h2m \ vala-gen-introspect.h2m \ vapigen.h2m \ @@ -25,9 +27,9 @@ EXTRA_DIST = \ if HAVE_HELP2MAN if ENABLE_VALADOC -manpages: valac.1 valadoc.1 vala-gen-introspect.1 vapigen.1 +manpages: valac.1 valadbusgen.1 valadoc.1 vala-gen-introspect.1 vapigen.1 else -manpages: valac.1 vala-gen-introspect.1 vapigen.1 +manpages: valac.1 valadbusgen.1 vala-gen-introspect.1 vapigen.1 endif @rm $^ $(MAKE) $(AM_MAKEFLAGS) $^ @@ -37,6 +39,11 @@ valac.1: --include $(srcdir)/valac.h2m \ --libtool --no-info \ --output=$@ +valadbusgen.1: + $(HELP2MAN) $(top_builddir)/dbusgen/valadbusgen \ + --include $(srcdir)/valadbusgen.h2m \ + --libtool --no-info \ + --output=$@ if ENABLE_VALADOC valadoc.1: $(HELP2MAN) $(top_builddir)/valadoc/valadoc \ @@ -60,6 +67,7 @@ endif if ENABLE_UNVERSIONED install-data-hook: cd $(DESTDIR)$(man1dir) && $(LN_S) -f valac@PACKAGE_SUFFIX@.1 valac.1 + cd $(DESTDIR)$(man1dir) && $(LN_S) -f valadbusgen@PACKAGE_SUFFIX@.1 valadbusgen.1 if ENABLE_VALADOC cd $(DESTDIR)$(man1dir) && $(LN_S) -f valadoc@PACKAGE_SUFFIX@.1 valadoc.1 endif diff --git a/doc/valadbusgen.1 b/doc/valadbusgen.1 new file mode 100644 index 000000000..a0404f7ef --- /dev/null +++ b/doc/valadbusgen.1 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.1. +.TH VALADBUSGEN "1" "April 2021" "Vala DBus Interface Generator 0.52.2" "User Commands" +.SH NAME +valadbusgen \- generate a Vala API from DBus xml +.SH SYNOPSIS +.B valadbusgen \fISOURCE\fP \fIPKGBASE\fP +[\fIOPTION\fR]... [\fIFILE\fR]... +.SH DESCRIPTION +.B valadbusgen +is a utility which generates Vala API (VAPI) files from DBus xml files. +.SS "Usage:" +.IP +valadbusgen [OPTION?] FILE... \- Vala DBus Interface Generator +.SS "Help Options:" +.TP +\fB\-h\fR, \fB\-\-help\fR +Show help options +.SS "Application Options:" +.TP +\fB\-\-vapidir\fR=\fI\,DIRECTORY\/\fR... +Look for package bindings in DIRECTORY +.TP +\fB\-\-pkg\fR=\fI\,PACKAGE\/\fR... +Include binding for PACKAGE +.TP +\fB\-d\fR, \fB\-\-directory\fR=\fI\,DIRECTORY\/\fR +Output directory +.TP +\fB\-\-disable\-warnings\fR +Disable warnings +.TP +\fB\-\-dbus\-timeout\fR +DBus timeout +.TP +\fB\-\-version\fR +Display version number +.TP +\fB\-q\fR, \fB\-\-quiet\fR +Do not print messages to the console +.SH BUGS +https://gitlab.gnome.org/GNOME/vala/issues +.SH "HOMEPAGE OR CONTACT" +https://wiki.gnome.org/Projects/Vala +.SH AUTHORS +Chris Daley, Rico Tzschichholz. +.SH EXAMPLES +This can then be converted to a Vala API as follows: +.B valadbusgen /usr/share/dbus-1/interfaces/org.freedesktop.GeoClue2.xml diff --git a/doc/valadbusgen.h2m b/doc/valadbusgen.h2m new file mode 100644 index 000000000..632978351 --- /dev/null +++ b/doc/valadbusgen.h2m @@ -0,0 +1,23 @@ +[NAME] +valadbusgen \- generate a Vala API from DBus xml + +[SYNOPSIS] +.B valadbusgen \fISOURCE\fP \fIPKGBASE\fP +[\fIOPTION\fR]... [\fIFILE\fR]... + +[DESCRIPTION] +.B valadbusgen +is a utility which generates Vala API (VAPI) files from DBus xml files. + +[EXAMPLES] +This can then be converted to a Vala API as follows: +.B valadbusgen /usr/share/dbus-1/interfaces/org.freedesktop.GeoClue2.xml + +[BUGS] +https://gitlab.gnome.org/GNOME/vala/issues + +[HOMEPAGE or CONTACT] +https://wiki.gnome.org/Projects/Vala + +[AUTHORS] +Chris Daley, Rico Tzschichholz.