aboutsummaryrefslogtreecommitdiff
path: root/development/ghex/README
diff options
context:
space:
mode:
Diffstat (limited to 'development/ghex/README')
-rw-r--r--development/ghex/README24
1 files changed, 14 insertions, 10 deletions
diff --git a/development/ghex/README b/development/ghex/README
index 0bb79b17b4..2426843295 100644
--- a/development/ghex/README
+++ b/development/ghex/README
@@ -1,17 +1,21 @@
-ghex (hex editor with GTK+3 GUI)
+ghex (hex editor with GTK4 GUI)
GHex allows the user to load data from any file, view and edit it in
either hex or ASCII. Useful for debugging problems with object code
or encodings. Also used by kids who cheat at computer games, by adding
score or lives to saved games.
-Optional dependency: yelp. Required for viewing the built-in help
-(Help->Contents, or F1 key). Alternatively, an HTML version of the
-help is included in /usr/doc/ghex-$VERSION/html/index.html for your
-perusal (in English only, though).
+Optional dependency: yelp. Enable by setting the SlackBuild option
+YELP=true if desired. This allows for the built-in help to be viewed
+natively with the standard GNOME help tool.
-Note: Trying to copy/paste arbitrary binary data into or out of
-ghex isn't going to work very well, because modern GTK+ insists the
-copy buffer has to be UTF-8 encoded Unicode. The result is lots
-of "\Uffffffff" (meaning "Invalid UTF-8") rather than the binary
-data. There's nothing we can do to fix this without major surgery.
+If this option is not enabled, the build will enable static HTML help by
+default, which will allow the built-in help to be viewed with other help
+viewers, such as KDE's help viewer, or by manually navigating to
+/usr/doc/HTML/{lang}/ghex, where "{lang}" is the applicable ISO language
+code.
+
+Buliding the libgtkhex API documentation requires `gi-docgen`, which is
+not presently in the slackbuilds.org repositories at the of writing. If
+you choose to install this manually and wish to build the API
+documentation, you can set the SlackBuild option GTK_DOC=true