diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index cc7402824c..70949b9e18 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -25,7 +25,7 @@ variables: BACKEND_FLAGS: "-Dx11-backend=true -Dwayland-backend=true -Dbroadway-backend=true" FEATURE_FLAGS: "-Dvulkan=enabled -Dcloudproviders=enabled" MESON_TEST_TIMEOUT_MULTIPLIER: 3 - FEDORA_IMAGE: "registry.gitlab.gnome.org/gnome/gtk/fedora:v34" + FEDORA_IMAGE: "registry.gitlab.gnome.org/gnome/gtk/fedora:v35" FLATPAK_IMAGE: "registry.gitlab.gnome.org/gnome/gnome-runtime-images/gnome:master" .only-default: diff --git a/.gitlab-ci/fedora.Dockerfile b/.gitlab-ci/fedora.Dockerfile index ef29a10a77..97ece0e7ff 100644 --- a/.gitlab-ci/fedora.Dockerfile +++ b/.gitlab-ci/fedora.Dockerfile @@ -76,6 +76,7 @@ RUN dnf -y install \ pcre-devel \ pcre-static \ python3 \ + python3-docutils \ python3-gobject \ python3-jinja2 \ python3-markdown \ diff --git a/docs/reference/gtk/gtk4-broadwayd.rst b/docs/reference/gtk/gtk4-broadwayd.rst new file mode 100644 index 0000000000..88bd224a5d --- /dev/null +++ b/docs/reference/gtk/gtk4-broadwayd.rst @@ -0,0 +1,57 @@ +.. _gtk4-broadwayd(1): + +============== +gtk4-broadwayd +============== + +--------------------------- +The Broadway display server +--------------------------- + +SYNOPSIS +-------- +| **gtk4-broadwayd** [OPTIONS...] +| **gtk4-broadwayd** --port=PORT --address=ADDRESS +| **gtk4-broadwayd** --unixaddress=ADDRESS + + +DESCRIPTION +----------- + +``gtk4-broadwayd`` is a display server for the Broadway GDK backend. It allows +multiple GTK applications to display their windows in the same web browser, by +connecting to gtk4-broadwayd. + +When using gtk4-broadwayd, specify the display number to use, prefixed with a +colon, similar to X. The default display number is 0. + +:: + + gtk4-broadwayd :5 + + +Then point your web browser at ``http://127.0.0.1:8085``. + +Start your applications like this: + +:: + + GDK_BACKEND=broadway BROADWAY_DISPLAY=:5 gtk4-demo + + +OPTIONS +------- + +``--port PORT`` + + Use the given ``PORT`` for the HTTP connection, instead of the default ``8080 + (DISPLAY - 1)``. + +``--address ADDRESS`` + + Use the given ``address`` for the HTTP connection, instead of the default ``http://127.0.0.1``. + +``--unixsocket ADDRESS`` + + Use the given ``address`` as the unix domain socket address. This option + overrides ``--address`` and ``--port``, and it is available only on Unix-like + systems. diff --git a/docs/reference/gtk/gtk4-broadwayd.xml b/docs/reference/gtk/gtk4-broadwayd.xml deleted file mode 100644 index 4c6450944d..0000000000 --- a/docs/reference/gtk/gtk4-broadwayd.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - gtk4-broadwayd - GTK - - - Developer - Alexander - Larsson - - - - - - gtk4-broadwayd - 1 - User Commands - - - - gtk4-broadwayd - Broadway display server - - - - -gtk4-broadwayd ---port PORT ---address ADDRESS ---unixsocket ADDRESS -:DISPLAY - - - -Description - -gtk4-broadwayd is a display server for the Broadway -GDK backend. It allows multiple GTK applications to display their -windows in the same web browser, by connecting to gtk4-broadwayd. - - -When using gtk4-broadwayd, specify the display number to use, prefixed -with a colon, similar to X. The default display number is 0. - -gtk4-broadwayd :5 - -Then point your web browser at http://127.0.0.1:8085. -Start your applications like this: - -GDK_BACKEND=broadway BROADWAY_DISPLAY=:5 gtk4-demo - - - - -Options - - - --port - Use PORT as the HTTP - port, instead of the default 8080 + (DISPLAY - 1). - - - - --address - Use ADDRESS as the HTTP - address, instead of the default http://127.0.0.1:PORT. - - - - --unixsocket - Use ADDRESS as the unix domain socket - address. This option overrides --address and --port. - It is available only on Unix-like systems. - - - - - - diff --git a/docs/reference/gtk/gtk4-builder-tool.rst b/docs/reference/gtk/gtk4-builder-tool.rst new file mode 100644 index 0000000000..80998a9d96 --- /dev/null +++ b/docs/reference/gtk/gtk4-builder-tool.rst @@ -0,0 +1,85 @@ +.. _gtk4-builder-tool(1): + +================= +gtk4-builder-tool +================= + +----------------------- +GtkBuilder File Utility +----------------------- + +SYNOPSIS +-------- +| **gtk4-builder-tool** [OPTIONS...] +| +| **gtk4-builder-tool** validate +| **gtk4-builder-tool** enumerate +| **gtk4-builder-tool** simplify [OPTIONS...] +| **gtk4-builder-tool** preview [OPTIONS...] + +DESCRIPTION +----------- + +``gtk4-builder-tool`` can perform various operations on GtkBuilder UI definition +files. + +COMMANDS +-------- + +Validation +^^^^^^^^^^ + +The ``validate`` command validates the given UI definition file and reports +errors to ``stderr``. + +Enumeration +^^^^^^^^^^^ + +The ``enumerate`` command lists all the named objects that are present in the UI +definition file. + +Preview +^^^^^^^ + +The ``preview`` command displays the UI dfinition file. + +This command accepts options to specify the ID of the toplevel object and a CSS +file to use. + +``--id=ID`` + + The ID of the object to preview. If not specified, gtk4-builder-tool will + choose a suitable object on its own. + +``--css=FILE`` + + Load style information from the given CSS file. + +Simplification +^^^^^^^^^^^^^^ + +The ``simplify`` command simplifies the UI definition file by removing +properties that are set to their default values and writes the resulting XML to +the standard output, or back to the input file. + +When the ``--3to4`` option is specified, the ``simplify`` command interprets the +input as a GTK 3 UI definuition file and attempts to convert it to GTK 4 +equivalents. It performs various conversions, such as renaming properties, +translating child properties to layout properties, rewriting the setup for +GtkNotebook, GtkStack, GtkAssistant or changing toolbars into boxes. + +You should always test the modified UI definition files produced by +gtk4-builder-tool before using them in production. + +Note in particular that the conversion done with ``--3to4`` is meant as a +starting point for a port from GTK 3 to GTK 4. It is expected that you will have +to do manual fixups after the initial conversion. + +``--replace`` + + Write the content back to the UI definition file instead of using the standard + output. + +``--3to4`` + + Transform a GTK 3 UI definition file to the equivalent GTK 4 definitions. diff --git a/docs/reference/gtk/gtk4-builder-tool.xml b/docs/reference/gtk/gtk4-builder-tool.xml deleted file mode 100644 index c6c6d1ae70..0000000000 --- a/docs/reference/gtk/gtk4-builder-tool.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - gtk4-builder-tool - GTK - - - Developer - Matthias - Clasen - - - - - - gtk4-builder-tool - 1 - User Commands - - - - gtk4-builder-tool - GtkBuilder file utility - - - - -gtk4-builder-tool -COMMAND -OPTION -FILE - - - -Description - - gtk4-builder-tool can perform various operations - on GtkBuilder .ui files. - - - The command validates the .ui file and reports - errors to stderr. - - - The command lists all the named objects that - are created in the .ui file. - - - The command displays the .ui file. This command - accepts options to specify the ID of the toplevel object and a .css file - to use. - - - The command simplifies the .ui file by removing - properties that are set to their default values and writes the resulting XML - to stdout, or back to the input file. - - - When the is specified, - interprets the input as a GTK 3 ui file and attempts to convert it to GTK 4 - equivalents. It performs various conversions, such as renaming properties, - translating child properties to layout properties, rewriting the setup for - GtkNotebook, GtkStack, GtkAssistant or changing toolbars into boxes. - - - You should always test the modified .ui files produced by gtk4-builder-tool - before using them in production. - - - Note in particular that the conversion - done with is meant as a starting point for a port - from GTK 3 to GTK 4. It is expected that you will have to do manual fixups - after the initial conversion. - - - -Simplify Options - The command accepts the following options: - - - - Write the content back to the .ui file instead of stdout. - - - - Transform a GTK 3 ui file to GTK 4 - - - - -Preview Options - The command accepts the following options: - - - - The ID of the object to preview. If not specified, - gtk4-builder-tool will choose a suitable object on its own. - - - - Load style information from the given .css file. - - - - - diff --git a/docs/reference/gtk/gtk4-demo-application.rst b/docs/reference/gtk/gtk4-demo-application.rst new file mode 100644 index 0000000000..0eb12ee404 --- /dev/null +++ b/docs/reference/gtk/gtk4-demo-application.rst @@ -0,0 +1,22 @@ +.. _gtk4-demo-application(1): + +===================== +gtk4-demo-application +===================== + +-------------------------- +Demonstrate GtkApplication +-------------------------- + + +SYNOPSIS +-------- +| **gtk4-demo-application** + + +DESCRIPTION +----------- + +``gtk4-demo-application`` is an example application used by ``gtk4-demo``. + +There is no need to call it manually. diff --git a/docs/reference/gtk/gtk4-demo-application.xml b/docs/reference/gtk/gtk4-demo-application.xml deleted file mode 100644 index 4b7b51972d..0000000000 --- a/docs/reference/gtk/gtk4-demo-application.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - gtk4-demo-application - GTK - - - Developer - Matthias - Clasen - - - - - - gtk4-demo-application - 1 - User Commands - - - - gtk4-demo-application - Demonstrate GtkApplication - - - - -gtk4-demo-application - - - -Description - -gtk4-demo-application is an example application -used by gtk4-demo. There is no need to call it -manually. - - - - diff --git a/docs/reference/gtk/gtk4-demo.rst b/docs/reference/gtk/gtk4-demo.rst new file mode 100644 index 0000000000..e917900988 --- /dev/null +++ b/docs/reference/gtk/gtk4-demo.rst @@ -0,0 +1,48 @@ +.. _gtk4-demo(1): + +========= +gtk4-demo +========= + +----------------------- +Demonstrate GTK widgets +----------------------- + +SYNOPSIS +-------- + +| **gtk4-demo** [OPTIONS...] + +DESCRIPTION +----------- + +``gtk4-demo`` is a collection of examples. + +Its purpose is to demonstrate many GTK widgets in a form that is useful to +application developers. + +The application shows the source code for each example, as well as other used +resources, such as UI description files and image assets. + +OPTIONS +------- + +``-h, --help`` + + Show help options. + +``--version`` + + Show program version. + +``--list`` + + List available examples. + +``--run EXAMPLE`` + + Run the named example. Use ``--list`` to see the available examples. + +``--autoquit`` + + Quit after a short timeout. This is intended for use with ``--run``, e.g. when profiling. diff --git a/docs/reference/gtk/gtk4-demo.xml b/docs/reference/gtk/gtk4-demo.xml deleted file mode 100644 index 009f82d03c..0000000000 --- a/docs/reference/gtk/gtk4-demo.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - gtk4-demo - GTK - - - Developer - Matthias - Clasen - - - - - - gtk4-demo - 1 - User Commands - - - - gtk4-demo - Demonstrate GTK widgets - - - - -gtk4-demo ---help ---version ---list ---run EXAMPLE ---autoquit - - - -Description - -gtk4-demo is a collection of examples. -Its purpose is to demonstrate many GTK widgets in a form -that is useful to application developers. - - -The application shows the source code for each example, as well as -other used resources, such as ui files and icons. - - - -Options - The following options are understood: - - - , - Show help options - - - - Show program version - - - - List available examples. - - - - Run the named example. Use to - see the available examples. - - - - Quit after a short timeout. This is intended for use - with , e.g. when profiling. - - - - - diff --git a/docs/reference/gtk/gtk4-encode-symbolic-svg.rst b/docs/reference/gtk/gtk4-encode-symbolic-svg.rst new file mode 100644 index 0000000000..6aedcbede6 --- /dev/null +++ b/docs/reference/gtk/gtk4-encode-symbolic-svg.rst @@ -0,0 +1,40 @@ +.. _gtk4-encode-symbolic-svg(1): + +======================== +gtk4-encode-symbolic-svg +======================== + +-------------------------------- +Symbolic icon conversion utility +-------------------------------- + +SYNOPSIS +-------- + +| **gtk4-encode-symbolic-svg** [OPTIONS...] x + +DESCRIPTION +----------- + +``gtk4-encode-symbolic-svg`` converts symbolic SVG icons into specially prepared +PNG files. GTK can load and recolor these PNGs, just like original SVGs, but +loading them is much faster. + +``PATH`` is the name of a symbolic SVG file, ``WIDTH`` x ``HEIGHT`` are the +desired dimensions for the generated PNG file. + +To distinguish them from ordinary PNGs, the generated files have the extension +``.symbolic.png``. + +OPTIONS +------- + +``-o, --output DIRECTORY`` + + Write png files to ``DIRECTORY`` instead of the current working directory. + +``--debug`` + + Generate PNG files of the various channels during the conversion. If these + files are not monochrome green, they are often helpful in pinpointing the + problematic parts of the source SVG. diff --git a/docs/reference/gtk/gtk4-encode-symbolic-svg.xml b/docs/reference/gtk/gtk4-encode-symbolic-svg.xml deleted file mode 100644 index 330795bc92..0000000000 --- a/docs/reference/gtk/gtk4-encode-symbolic-svg.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - gtk4-encode-symbolic-svg - GTK - - - Developer - Alexander - Larsson - - - - - - gtk4-encode-symbolic-svg - 1 - User Commands - - - - gtk4-encode-symbolic-svg - Symbolic icon conversion utility - - - - -gtk4-encode-symbolic-svg -OPTION... -PATH -WIDTHxHEIGHT - - - -Description - - gtk4-encode-symbolic-svg converts symbolic svg icons into - specially prepared png files. GTK can load and recolor these pngs, just like - original svgs, but loading them is much faster. - - - PATH is the name of a symbolic svg file, - WIDTHxHEIGHT are the - desired dimensions for the generated png file. - - - To distinguish them from ordinary pngs, the generated files have the extension - .symbolic.png. - - - -Options - - - -o DIRECTORY - --output DIRECTORY - Write png files to DIRECTORY - instead of the current working directory. - - - --debug - Generate png files of the various channels during - the conversion. If these files are not monochrome green, they - are often helpful in pinpointing the problematic parts of - the source svg. - - - - - diff --git a/docs/reference/gtk/gtk4-icon-browser.rst b/docs/reference/gtk/gtk4-icon-browser.rst new file mode 100644 index 0000000000..683b3f3054 --- /dev/null +++ b/docs/reference/gtk/gtk4-icon-browser.rst @@ -0,0 +1,28 @@ +.. _gtk4-icon-browser(1): + +================= +gtk4-icon-browser +================= + +----------------- +List themed icons +----------------- + +SYNOPSIS +-------- + +| **gtk4-icon-browser** [OPTIONS...] + +DESCRIPTION +----------- + +``gtk4-icon-browser`` is a utility to explore the icons in the current icon +theme. It shows icons in various sizes, their symbolic variants where available, +as well as a description of the icon and its context. + +OPTIONS +------- + +``-h, --help`` + + Show the application help. diff --git a/docs/reference/gtk/gtk4-icon-browser.xml b/docs/reference/gtk/gtk4-icon-browser.xml deleted file mode 100644 index ee37d55352..0000000000 --- a/docs/reference/gtk/gtk4-icon-browser.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - gtk4-icon-browser - GTK - - - Developer - Matthias - Clasen - - - - - - gtk4-icon-browser - 1 - User Commands - - - - gtk4-icon-browser - List themed icons - - - - -gtk4-icon-browser ---help - - - -Description - -gtk4-icon-browser is a utility to explore the icons -in the current icon theme. It shows icons in various sizes, their symbolic -variants where available, as well as a description of the icon and its context. - - - -Options - The following options are understood: - - - , - Show help options - - - - - diff --git a/docs/reference/gtk/gtk4-launch.rst b/docs/reference/gtk/gtk4-launch.rst new file mode 100644 index 0000000000..526df727b4 --- /dev/null +++ b/docs/reference/gtk/gtk4-launch.rst @@ -0,0 +1,50 @@ +.. _gtk4-launch(1): + +=========== +gtk4-launch +=========== + +--------------------- +Launch an application +--------------------- + +SYNOPSIS +-------- + +| **gtk4-launch** [OPTIONS...] [URI...] + +DESCRIPTION +----------- + +``gtk4-launch`` launches an application using the given name. The application is +started with proper startup notification on a default display, unless specified +otherwise. + +``gtk4-launch`` takes at least one argument, the name of the application to +launch. The name should match application desktop file name, as residing in the +applications subdirectories of the XDG data directories, with or without the +``.desktop`` suffix. + +If called with more than one argument, the rest of them besides the application +name are considered URI locations and are passed as arguments to the launched +application. + +OPTIONS +------- + +``-?, -h, --help`` + + Print the command's help and exit. + +``--version`` + + Print the command's version and exit. + +ENVIRONMENT +----------- + +Some environment variables affect the behavior of ``gtk4-launch``: + +``XDG_DATA_HOME, XDG_DATA_DIRS`` + + The environment variables specifying the XDG data directories. diff --git a/docs/reference/gtk/gtk4-launch.xml b/docs/reference/gtk/gtk4-launch.xml deleted file mode 100644 index 8ee32141a0..0000000000 --- a/docs/reference/gtk/gtk4-launch.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - gtk4-launch - GTK - - - Developer - Tomáš - Bžatek - tbzatek@redhat.com - - - - - - gtk4-launch - 1 - User Commands - - - - gtk4-launch - Launch an application - - - - -gtk4-launch -OPTION -APPLICATION -URI - - - -Description - -gtk4-launch launches an application using the given name. -The application is started with proper startup notification on a default -display, unless specified otherwise. - - -gtk4-launch takes at least one argument, the name of -the application to launch. The name should match application desktop file name, -as residing in the applications subdirectories of the XDG data directories, with -or without the '.desktop' suffix. - - -If called with more than one argument, the rest of them besides the application -name are considered URI locations and are passed as arguments to the launched -application. - - - -Options - The following options are understood: - - - , - Prints a short help text and exits. - - - - - - Prints the program version and exits. - - - - -Environment - Some environment variables affect the behavior of gtk4-launch. - - - , - The environment variables specifying the XDG dta directories. - - - - - diff --git a/docs/reference/gtk/gtk4-query-settings.rst b/docs/reference/gtk/gtk4-query-settings.rst new file mode 100644 index 0000000000..3e16b3a758 --- /dev/null +++ b/docs/reference/gtk/gtk4-query-settings.rst @@ -0,0 +1,21 @@ +.. _gtk4-query-settings(1): + +=================== +gtk4-query-settings +=================== + +------------------------------------ +Print name and value of GTK settings +------------------------------------ + +SYNOPSIS +-------- + +| **gtk4-query-settings** [PATTERN] + +DESCRIPTION +----------- + +``gtk4-query-settings`` prints both name and value of all properties available +in the ``GtkSettings`` class. Optionally, you can filter which properties to +list by specifying a ``PATTERN``. diff --git a/docs/reference/gtk/gtk4-query-settings.xml b/docs/reference/gtk/gtk4-query-settings.xml deleted file mode 100644 index 881e88180a..0000000000 --- a/docs/reference/gtk/gtk4-query-settings.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - gtk4-query-settings - GTK - - - Developer - Timm - Bäder - - - - - - gtk4-query-settings - 1 - User Commands - - - - gtk4-query-settings - Utility to print name and value of all GtkSettings properties - - - - -gtk4-query-settings -PATTERN - - - -Description - - gtk4-query-settings prints both name and value of all properties - available in the GtkSettings class. Optionally, you can filter which properties - to list by specifying a PATTERN. - - - - diff --git a/docs/reference/gtk/gtk4-update-icon-cache.rst b/docs/reference/gtk/gtk4-update-icon-cache.rst new file mode 100644 index 0000000000..2ee1f14a06 --- /dev/null +++ b/docs/reference/gtk/gtk4-update-icon-cache.rst @@ -0,0 +1,65 @@ +.. _gtk4-update-icon-cache(1): + +====================== +gtk4-update-icon-cache +====================== + +-------------------------- +Icon theme caching utility +-------------------------- + +SYNOPSIS +-------- + +| **gtk4-update-icon-cache** [OPTIONS...] + +DESCRIPTION +----------- + +``gtk4-update-icon-cache`` creates ``mmap(2)``-able cache files for icon themes. + +It expects to be given the ``PATH`` to an icon theme directory containing an +``index.theme``, e.g. ``/usr/share/icons/hicolor``, and writes a +``icon-theme.cache`` containing cached information about the icons in the +directory tree below the given directory. + +GTK can use the cache files created by ``gtk4-update-icon-cache`` to avoid a lot +of system call and disk seek overhead when the application starts. Since the +format of the cache files allows them to be shared across multiple processes, +for instance using the POSIX ``mmap(2)`` system call, the overall memory +consumption is reduced as well. + +OPTIONS +------- + +``-f, --force`` + + Overwrite an existing cache file even if it appears to be up-to-date. + +``-t, --ignore-theme-index`` + + Don't check for the existence of ``index.theme`` in the icon theme directory. + Without this option, ``gtk4-update-icon-cache`` refuses to create an icon + cache in a directory which does not appear to be the toplevel directory of an + icon theme. + +``-i, --index-only`` + + Don't include image data in the cache. + +``--include-image-data`` + + Include image data in the cache. + +``-c, --source `` + + Output a C header file declaring a constant ``NAME`` with the contents of the + icon cache. + +``-q, --quiet`` + + Turn off verbose output. + +``-v, --validate`` + + Validate existing icon cache. diff --git a/docs/reference/gtk/gtk4-update-icon-cache.xml b/docs/reference/gtk/gtk4-update-icon-cache.xml deleted file mode 100644 index 769853a57b..0000000000 --- a/docs/reference/gtk/gtk4-update-icon-cache.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - gtk4-update-icon-cache - GTK - - - Developer - Matthias - Clasen - - - - - - gtk4-update-icon-cache - 1 - User Commands - - - - gtk4-update-icon-cache - Icon theme caching utility - - - - -gtk4-update-icon-cache ---force ---ignore-theme-index - - --index-only - --include-image-data - ---source NAME ---quiet ---validate -PATH - - - -Description - - gtk4-update-icon-cache creates mmapable cache - files for icon themes. - - - It expects to be given the PATH to an icon theme - directory containing an index.theme, e.g. - /usr/share/icons/hicolor, and writes a - icon-theme.cache containing cached information about - the icons in the directory tree below the given directory. - - - GTK can use the cache files created by gtk4-update-icon-cache - to avoid a lot of system call and disk seek overhead when the application - starts. Since the format of the cache files allows them to be shared across - multiple processes, for instance using the POSIX mmap() system - call, the overall memory consumption is reduced as well. - - - -Options - - - --force - -f - Overwrite an existing cache file even if it appears to be - up-to-date. - - - - --ignore-theme-index - -t - Don't check for the existence of index.theme - in the icon theme directory. Without this option, gtk4-update-icon-cache - refuses to create an icon cache in a directory which does not appear to - be the toplevel directory of an icon theme. - - - - - --index-only - -i - Don't include image data in the cache. - - - - - --include-image-data - Include image data in the cache. - - - - - --source - -c - Output a C header file declaring a constant - NAME with the contents of the icon - cache. - - - - --quiet - -q - Turn off verbose output. - - - - - --validate - -v - Validate existing icon cache. - - - - - - diff --git a/docs/reference/gtk/gtk4-widget-factory.rst b/docs/reference/gtk/gtk4-widget-factory.rst new file mode 100644 index 0000000000..a8d23139ec --- /dev/null +++ b/docs/reference/gtk/gtk4-widget-factory.rst @@ -0,0 +1,34 @@ +.. _gtk4-widget-factory(1): + +=================== +gtk4-widget-factory +=================== + +------------------------------- +Showcase GTK widgets and styles +------------------------------- + +SYNOPSIS +-------- + +| **gtk4-widget-factory** [OPTIONS...] + +DESCRIPTION +----------- + +``gtk4-widget-factory`` is a collection of examples. + +Its purpose is to demonstrate many GTK widgets in a form that is useful to GTK theme developers. + +The application shows widgets in different, typical combinations and states. + +OPTIONS +------- + +``-h, --help`` + + Show the application help. + +``--version`` + + Show the application version. diff --git a/docs/reference/gtk/gtk4-widget-factory.xml b/docs/reference/gtk/gtk4-widget-factory.xml deleted file mode 100644 index 6233fe65df..0000000000 --- a/docs/reference/gtk/gtk4-widget-factory.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - gtk4-widget-factory - GTK - - - Developer - Matthias - Clasen - - - - - - gtk4-widget-factory - 1 - User Commands - - - - gtk4-widget-factory - Demonstrate GTK widgets - - - - -gtk4-widget-factory ---help - - - -Description - -gtk4-widget-factory is a collection of examples. -Its purpose is to demonstrate many GTK widgets in a form -that is useful to GTK theme developers. - - -The application shows widgets in different, typical combinations -and states. - - - -Options - The following options are understood: - - - , - Show help options - - - - Show program version - - - - - diff --git a/docs/reference/gtk/meson.build b/docs/reference/gtk/meson.build index 65873e5202..7ae01f0451 100644 --- a/docs/reference/gtk/meson.build +++ b/docs/reference/gtk/meson.build @@ -59,24 +59,15 @@ if get_option('gtk_doc') ) endif -xsltproc = find_program('xsltproc', required: false) -if get_option('man-pages') and not xsltproc.found() - error('No xsltproc found, but man pages were explicitly enabled') +rst2man = find_program('rst2man', required: false) +if get_option('man-pages') and not rst2man.found() + error('No rst2man found, but man pages were explicitly enabled') endif -if get_option('man-pages') and xsltproc.found() - xlstproc_flags = [ - '--nonet', - '--stringparam', 'man.output.quietly', '1', - '--stringparam', 'funcsynopsis.style', 'ansi', - '--stringparam', 'man.th.extra1.suppress', '1', - '--stringparam', 'man.authors.section.enabled', '0', - '--stringparam', 'man.copyright.section.enabled', '0', - ] - - man_files = [ - [ 'gtk4-broadwayd', '1', ], - [ 'gtk4-builder-tool', '1', ], +if get_option('man-pages') and rst2man.found() + rst_files = [ + [ 'gtk4-broadwayd', '1' ], + [ 'gtk4-builder-tool', '1' ], [ 'gtk4-encode-symbolic-svg', '1', ], [ 'gtk4-launch', '1', ], [ 'gtk4-query-settings', '1', ], @@ -84,7 +75,7 @@ if get_option('man-pages') and xsltproc.found() ] if get_option('demos') - man_files += [ + rst_files += [ [ 'gtk4-demo', '1', ], [ 'gtk4-demo-application', '1', ], [ 'gtk4-widget-factory', '1', ], @@ -92,21 +83,25 @@ if get_option('man-pages') and xsltproc.found() ] endif - foreach man: man_files - man_name = man.get(0) - man_section = man.get(1, '1') - custom_target('@0@.@1@'.format(man_name, man_section), - input: '@0@.xml'.format(man_name), + rst2man_flags = [ + '--syntax-highlight=none', + ] + + foreach rst: rst_files + man_name = rst[0] + man_section = rst.get(1, '1') + + custom_target('man-@0@'.format(man_name), + input: '@0@.rst'.format(man_name), output: '@0@.@1@'.format(man_name, man_section), command: [ - xsltproc, - xlstproc_flags, - '-o', '@OUTPUT@', - 'http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl', + rst2man, + rst2man_flags, '@INPUT@', ], + capture: true, install: true, - install_dir: join_paths(get_option('mandir'), 'man@0@'.format(man_section)), + install_dir: get_option('mandir') / 'man@0@'.format(man_section), ) endforeach endif diff --git a/docs/reference/gtk/overview.xml b/docs/reference/gtk/overview.xml deleted file mode 100644 index 0435836586..0000000000 --- a/docs/reference/gtk/overview.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - -GTK is a library for creating graphical user interfaces. It -works on many UNIX-like platforms, Windows, and OS X. -GTK is released under the GNU Library General Public License -(GNU LGPL), which allows for flexible licensing of client -applications. GTK has a C-based object-oriented architecture that -allows for maximum flexibility. Bindings for many other languages have -been written, including C++, Objective-C, Guile/Scheme, Perl, Python, -TOM, Ada95, Free Pascal, and Eiffel. The GTK library itself contains -widgets, that is, GUI components such as GtkButton -or GtkTextView. - - - -GTK depends on the following libraries: - - - -GLib - -A general-purpose utility library, not specific to graphical user interfaces. -GLib provides many useful data types, macros, type conversions, -string utilities, file utilities, a main loop abstraction, and so on. - - - - -GObject -A library that provides a type system, a collection of -fundamental types including an object type, a signal system. - - - - -GIO -A modern, easy-to-use VFS API including abstractions for -files, drives, volumes, stream IO, as well as network programming and -DBus communication. - - - - -cairo -Cairo is a 2D graphics library with support for multiple -output devices. - - - - -Pango - -Pango is a library for internationalized text handling. It centers -around the PangoLayout object, representing a paragraph of text. -Pango provides the engine for GtkTextView, GtkLabel, GtkEntry, and -other widgets that display text. - - - - -GdkPixbuf - -This is a small library which allows you to create GdkPixbuf -("pixel buffer") objects from image data or image files. -Use a GdkPixbuf in combination with GtkImage to display images. - - - - -graphene - -This is a small library which provides vector and matrix datatypes -and operations. graphene provides optimized implementations using -various SIMD instruction sets such as SSE. - - - - -GDK - -GDK is the abstraction layer that allows GTK to support multiple -windowing systems. GDK provides window system facilities on Wayland, -X11, Windows, and OS X. - - - - -GSK - -GSK is a library for creating a scene graph from render nodes, -and rendering it using different rendering APIs. GSK provides renderers -for OpenGL, Vulkan and cairo. - - - - -