From 8e7f443045f8e77bb5c841c2b7bfe2e1e3fcceb9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Noel?= <sebastien@twolife.be>
Date: Tue, 10 Sep 2024 16:43:58 +0200
Subject: doc: Provide a man page for gpgme-json.

* doc/gpgme-json.texi: New.
* configure.ac: Check for yat2m.
* doc/Makefile.am (YAT2M_OPTIONS): New.  Also add all the other man
page stuff similar to what is used in gnupg.
--

ChangeLog entries by wk.
---
 doc/gpgme-json.texi | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 doc/gpgme-json.texi

(limited to 'doc/gpgme-json.texi')

diff --git a/doc/gpgme-json.texi b/doc/gpgme-json.texi
new file mode 100644
index 00000000..e5646662
--- /dev/null
+++ b/doc/gpgme-json.texi
@@ -0,0 +1,70 @@
+\input texinfo                   @c -*- mode: texinfo; coding: utf-8; -*-
+@documentencoding UTF-8
+@setfilename gpgme-json.info
+@include defs.inc
+
+@manpage gpgme-json.1
+@ifset manverb
+.B gpgme-json
+\- Native messaging based GPGME operations
+@end ifset
+
+@mansect synopsis
+@ifset manverb
+.B  gpgme-json
+.RB [ \-\-interactive | \-i ]
+.RB [ \-\-single | \-s ]
+.RB [ \-\-identify
+.IR file ]
+.RB [ \-\-lib\-version ]
+.RB [ \-\-help | \-h ]
+@end ifset
+
+@mansect description
+@command{gpgme-json} is a JSON to GPGME bridge.
+This interface allows web-browser extensions to communicate with the
+GPGME library through the Native Messaging facility from web-browser.
+
+
+@mansect options
+@command{gpgme-json} accepts the following options on the command line:
+
+@item -i
+@itemx --interactive
+@opindex interactive
+Enable interactive mode.  Interactive mode also provides some online help.
+
+@item -s
+@itemx --single
+@opindex single
+Enable single request mode.
+
+@item --identify @var{file|-}
+@opindex identify
+Identify the type of the data found in @file{file} or standard input @var{-}.
+
+@item --debug
+@opindex single
+Enable debug mode. Logs are saved to to @file{~/.gnupg/S.gpgme-json.log}.
+
+Note that you can also turn debug mode on and specify a custom logfile using
+the environment variable @code{GPGME_JSON_DEBUG}.
+
+@item --lib-version
+@opindex version
+Print GPGME library version.
+
+@item -h
+@itemx --help
+@opindex help
+Print a usage message summarizing the most useful command-line options.
+
+@mansect bugs
+Please report bugs to <https://bugs.gnupg.org>.
+
+@mansect copyright
+@command{gpgme-json} is Copyright 2018-2024 g10 Code GmbH.
+LGPL version 2.1 or later <https://www.gnu.org/licenses/>
+
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
-- 
cgit v1.2.3