luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-02 07:23:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Port the man pages from DocBook to reStructuredText

Browse Source 
So they are consistent with the way we’re building man pages in other
projects, and because some people are allergic to XML.

This changes the build-time dependencies from `xsltproc` to `rst2man`,
and also takes the opportunity to change the `-Dman` Meson option from a
boolean to a feature (so you should use `-Dman-pages={enabled,disabled}`
now, rather than `-Dman={true,false}`).

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
This commit is contained in:
Philip Withnall
2023-12-20 14:04:11 +00:00
parent 385641572d
commit 031e65808d
37 changed files with 3524 additions and 5326 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/reference/gio/gresource.rst Normal file
View File

@@ -0,0 +1,66 @@
.. _gresource(1):
.. meta::
:copyright: Copyright 2012 Red Hat, Inc.
:license: LGPL-2.1-or-later
..
This has to be duplicated from above to make it machine-readable by `reuse`:
SPDX-FileCopyrightText: 2012 Red Hat, Inc.
SPDX-License-Identifier: LGPL-2.1-or-later
=========
gresource
=========
--------------
GResource tool
--------------
SYNOPSIS
--------
| **gresource** [--section *SECTION*] list *FILE* [*PATH*]
| **gresource** [--section *SECTION*] details *FILE* [*PATH*]
| **gresource** [--section *SECTION*] extract *FILE* *PATH*
| **gresource** sections *FILE*
| **gresource** help [*COMMAND*]
DESCRIPTION
-----------
``gresource`` offers a simple commandline interface to ``GResource``. It lets
you list and extract resources that have been compiled into a resource file or
included in an ELF file (a binary or a shared library).
The file to operate on is specified by the ``FILE`` argument.
If an ELF file includes multiple sections with resources, it is possible to
select which one to operate on with the ``--section`` option. Use the
``sections`` command to find available sections.
COMMANDS
--------
``list``
Lists resources. If ``SECTION`` is given, only list resources in this section.
If ``PATH`` is given, only list matching resources.
``details``
Lists resources with details. If ``SECTION`` is given, only list resources in
this section. If ``PATH`` is given, only list matching resources. Details
include the section, size and compression of each resource.
``extract``
Extracts the resource named by ``PATH`` to stdout. Note that resources may
contain binary data.
``sections``
Lists sections containing resources. This is only interesting if ``FILE`` is
an ELF file.
``help``
Prints help and exits.