ashley/jami-client-qt
1
0
Fork 0
mirror of https://git.jami.net/savoirfairelinux/jami-client-qt.git synced 2024-10-28 00:39:36 +01:00
Code Activity

doc: Add and install jami(1) man page.

Browse source 
* CMakeLists.txt: Install the man page.
* doc/jami.1: Rewrite to be a proper man page.

Change-Id: If0b566556d41c5adada87c93db7e6097dfdfa1e8
This commit is contained in:
Amin Bandali 2022-12-29 14:44:19 -05:00
parent 9d70fe10eb
commit bf46264b74
2 changed files with 70 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CMakeLists.txt
View file

@ -656,6 +656,11 @@ elseif (NOT APPLE)
FILES ${DATA_DIR}/jami.appdata.xml
DESTINATION ${CMAKE_INSTALL_PREFIX}/share/metainfo)
# man page
install(
FILES ${DOC_DIR}/jami.1
DESTINATION ${CMAKE_INSTALL_PREFIX}/share/man/man1)
# Add a target to generate API documentation using Doxygen and
# graphviz-dot.
find_package(Doxygen)

75
doc/jami.1
View file

@ -1,21 +1,76 @@
.\" Manpage for jami.
.TH man 8 "08 April 2021" "1.0" "jami man page"
.TH JAMI 1 "2022-12-29" "Jami" "GNU"
.SH NAME
jami \- Client for jami.net
jami \- Qt-based user interface for Jami
.SH SYNOPSIS
jami [options]
.SH DESCRIPTION
jami is a qt client for jami.net
jami is a Qt-based client application (user interface) for Jami, an
official GNU package for universal communication that respects the
freedom and privacy of its users.
.SH OPTIONS
.B \-v, \-\-version
Display the version and exit.
.TP
.B \-d, \-\-debug
Enable debug.
.TP
.B \-h, \-\-help
Display help text and exit.
Display help on command line options and exit.
.TP
.B \-\-help\-all
Display help including Qt-specific command line options and exit.
.TP
.B \-v, \-\-version
Display version information and exit.
.TP
.B \-\-disable\-web\-security
Don't enforce the same-origin policy. This is currently used by jami
by default to allow loading local resources in the chatview (for media
and link preview, and emoji picker).
This is a Qt WebEngine Chromium flag and is only applicable if jami
was built with Qt WebEngine.
.TP
.B \-\-no\-sandbox
Disable the security sandbox for Qt WebEngine's renderer and plugin
processes.
This is a Qt WebEngine Chromium flag and is only applicable if jami
was built with Qt WebEngine.
.TP
.B \-\-single\-process
Run Qt WebEngine's renderer and plugins in the same process as its
browser, useful for getting stack traces for renderer crashes. This
is currently used by jami by default.
This is a Qt WebEngine Chromium flag and is only applicable if jami
was built with Qt WebEngine.
.TP
.B \-\-remote\-debugging\-port=<port_number>
Local port to run the Qt WebEngine developer tools interface on,
useful for inspecting and debugging web views.
To access the Qt WebEngine developer tools after launching jami with
this flag, open the address http://localhost:<port_number> in your web
browser.
This is a Qt WebEngine flag and is only applicable if jami was built
with Qt WebEngine.
.TP
.B \-m, \-\-minimized
Start jami minimized.
.TP
.B \-d, \-\-debug
Enable debug mode for more verbose console output.
.TP
.B \-f, \-\-file=<file>
Write debug output to <file>.
.TP
.B \-t, \-\-term
Terminate all other currently running instances of jami.
.TP
.B \-q, \-\-quiet
Mute daemon logging, useful for debugging only the Qt-based client
application (user interface).
This is only applicable when debug mode is enabled.
.SH SEE ALSO
jamid(1)
.SH AUTHOR
Alexandre Viau (alexandre.viau@savoirfairelinux.net)
Amin Bandali (bandali@gnu.org)