diff options
author | lovetox <philipp@hoerist.com> | 2022-08-21 16:35:06 +0300 |
---|---|---|
committer | lovetox <philipp@hoerist.com> | 2022-08-21 17:47:05 +0300 |
commit | d8d3999a46a3a2832720541cc328cb896994f35f (patch) | |
tree | c219cf64ee0daf62699a20197e0799c072f2772e /data | |
parent | ca5f740cd7c198309c3929a27f57277fde22795a (diff) |
chore: Update man pages
Move man page creation to markdown syntax. This allows for easier
editing than groff syntax.
Diffstat (limited to 'data')
-rw-r--r-- | data/gajim-remote.1 | 187 | ||||
-rw-r--r-- | data/gajim-remote.1.md | 72 | ||||
-rw-r--r-- | data/gajim.1 | 244 | ||||
-rw-r--r-- | data/gajim.1.md | 103 |
4 files changed, 358 insertions, 248 deletions
diff --git a/data/gajim-remote.1 b/data/gajim-remote.1 index 72a242140..0ddf2caff 100644 --- a/data/gajim-remote.1 +++ b/data/gajim-remote.1 @@ -1,116 +1,71 @@ -.Dd January 21, 2018 -.Dt GAJIM-REMOTE 1 URM -.Os UNIX -.Sh NAME -.Nm gajim-remote -.Nd a remote control utility for -.Xr gajim 1 -.Sh SYNOPSIS -.Nm -.Ar command -.Sh DESCRIPTION -.Nm -is a script to control and communicate with a running instance of -.Xr gajim 1 -by D-Bus. -.Sh OPTIONS -.Bl -tag -width Ds -.It Available commands -.El -.Ss account_info Aq account -Gets detailed info on a account -.Ss change_status Bo status Bc Bo message Bc Bq account -Changes the status of account or accounts -.Ss check_gajim_running -Check if Gajim is running -.Ss contact_info Aq jid -Gets detailed info on a contact -.Ss get_status Bq account -Returns current status (the global one unless account is specified) -.Ss get_status_message Bq account -Returns current status message (the global one unless account is specified) -.Ss get_unread_msgs_number -Returns number of unread messages -.Ss help Bq command -Shows a help on specific command -.Ss list_accounts -Prints a list of registered accounts -.Ss list_contacts Bq account -Prints a list of all contacts in the roster. Each contact appears on a separate line -.Ss remove_contact Ao jid Ac Bq account -Removes contact from roster -.Ss send_chat_message Ao jid Ac Ao message Ac Bo PGP key Bc Bq account -Sends new chat message to a contact in the roster. Both OpenPGP key and account are optional. If you want to set only 'account', without 'OpenPGP key', just set 'OpenPGP key' to ''. -.Ss send_file Ao file Ac Ao jid Ac Bq account -Sends file to a contact -.Ss send_groupchat_message Ao room_jid Ac Ao message Ac Bq account -Sends new message to a groupchat you've joined. -.Ss send_single_message Ao jid subject Ac Ao message Ac Bo PGP key Bc Bq account -Sends new single message to a contact in the roster. Both OpenPGP key and account are optional. If you want to set only 'account', without 'OpenPGP key', just set 'OpenPGP key' to ''. -.Ss send_xml Ao xml Ac Bq account -Sends custom XML -.Ss set_priority Ao priority Ac Bq account -Changes the priority of account or accounts -.Ss show_next_pending_event -Pops up a window with the next pending event -.Ss toggle_roster_appearance -Shows or hides the roster window -.Sh EXAMPLES -Open a URI of group chat gajim -.Pp -.Dl $ gajim-remote handle_uri xmpp:gajim@conference.gajim.org?join -.Pp -Send custom XML -.Pp -.Dl $ gajim-remote send_xml $(cat Pa filename.xml ) Qq your@jabber.id -.Sh AUTHORS -.An -nosplit -.Nm -is written and maintained by -.An Yann Leboulanger , -and -.An Denis Fomin , -with contributions and patches merged from many individuals around the world. -See files -.Pa AUTHORS -and -.Pa THANKS , -for a complete list. -.Sh COPYRIGHT -Copyright (C) 2003-2022 Gajim Team -.Pp -.Nm -is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 3 only. -.Pp -.Nm -is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. -.Pp -You should have received a copy of the GNU General Public License along with -.Nm . -If not, see <https://www.gnu.org/licenses/>. -.Sh FEEDBACK -You can report bugs or feature requests in our bug tracker at -.Em https://dev.gajim.org/gajim/gajim/issues -or in the -.Em gajim-devel -mailing list; if you want to send us a patch, please do so in our bug tracker. -You can also find us in our chat room. -.Sh WWW -https://www.gajim.org/ -.Sh XMPP -You are welcome to join us at gajim@conference.gajim.org -.Sh MAILING LIST -Below are public mailing lists on lists.gajim.org -.Bd -literal -offset indent -https://lists.gajim.org/cgi-bin/listinfo/gajim-devel -https://lists.gajim.org/cgi-bin/listinfo/translators -.Ed -.Pp -More mailing lists at -.Bd -literal -offset indent -https://lists.gajim.org/cgi-bin/listinfo -.Ed -.Sh BUGS -Please submit bugs at https://dev.gajim.org/gajim/gajim/issues -.Sh SEE ALSO -.Xr gajim 1 +.\" Automatically generated by Pandoc 2.9.2.1 +.\" +.TH "gajim-remote" "1" "August 2022" "" "Manual" +.hy +.SH NAME +.PP +gajim-remote - a remote control utility for \f[B]gajim\f[R](1) +.SH SYNOPSIS +.PP +gajim-remote -h +.PD 0 +.P +.PD +gajim-remote \f[I]command\f[R] [arguments \&...] +.SH DESCRIPTION +.PP +gajim-remote is an application to control and communicate with a running +instance of \f[B]gajim\f[R](1) via dbus. +.SH OPTIONS +.TP +\f[B]\f[CB]-h, --help\f[B]\f[R] +Display the help +.TP +\f[B]\f[CB]--app-id\f[B]\f[R] APP_ID +The application id of the running \f[B]gajim\f[R](1) instance +.SH COMMANDS +.TP +\f[B]\f[CB]list_contacts\f[B]\f[R] account +Get all roster contacts +.TP +\f[B]\f[CB]list_accounts\f[B]\f[R] +Get the list of accounts +.TP +\f[B]\f[CB]change_status\f[B]\f[R] {offline,online,away,xa,dnd} message account +Change the status +.TP +\f[B]\f[CB]send_chat_message\f[B]\f[R] address message account +Send a chat message to a contact +.TP +\f[B]\f[CB]send_groupchat_message\f[B]\f[R] address message account +Send a chat message to a group chat +.TP +\f[B]\f[CB]account_info\f[B]\f[R] account +Get account details +.TP +\f[B]\f[CB]get_status\f[B]\f[R] account +Get the current status +.TP +\f[B]\f[CB]get_status_message\f[B]\f[R] account +Get the current status message +.TP +\f[B]\f[CB]get_unread_msgs_number\f[B]\f[R] +Get the unread message count +.SH BUGS +.PP +Please submit bugs at https://dev.gajim.org/gajim/gajim/issues. +.SH SUPPORT +.PP +You are welcome to join us at xmpp:gajim\[at]conference.gajim.org?join. +.SH COPYRIGHT +.PP +gajim is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free +Software Foundation; version 3 only. +.PP +gajim is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. +See the GNU General Public License for more details. +.SH AUTHORS +Philipp H\[:o]rist, Yann Leboulanger. diff --git a/data/gajim-remote.1.md b/data/gajim-remote.1.md new file mode 100644 index 000000000..caf64e276 --- /dev/null +++ b/data/gajim-remote.1.md @@ -0,0 +1,72 @@ +% gajim-remote(1) | Manual +% Philipp Hörist, Yann Leboulanger +% August 2022 + +# NAME + +gajim-remote - a remote control utility for **gajim**(1) + +# SYNOPSIS + +gajim-remote -h\ +gajim-remote *command* [arguments ...] + +# DESCRIPTION + +gajim-remote is an application to control and communicate with a running instance of **gajim**(1) via dbus. + +# OPTIONS + +`-h, --help` +: Display the help + +`--app-id` APP_ID +: The application id of the running **gajim**(1) instance + +# COMMANDS + +`list_contacts` account +: Get all roster contacts + +`list_accounts` +: Get the list of accounts + +`change_status` {offline,online,away,xa,dnd} message account +: Change the status + +`send_chat_message` address message account +: Send a chat message to a contact + +`send_groupchat_message` address message account +: Send a chat message to a group chat + +`account_info` account +: Get account details + +`get_status` account +: Get the current status + +`get_status_message` account +: Get the current status message + +`get_unread_msgs_number` +: Get the unread message count + +# BUGS + +Please submit bugs at https://dev.gajim.org/gajim/gajim/issues. + +# SUPPORT + +You are welcome to join us at xmpp:gajim@conference.gajim.org?join. + +# COPYRIGHT + +gajim is free software; you can redistribute it and/or modify it under the +terms of the GNU General Public License as published by the +Free Software Foundation; version 3 only. + +gajim is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. +See the GNU General Public License for more details. diff --git a/data/gajim.1 b/data/gajim.1 index ae1ba4376..d887d72a0 100644 --- a/data/gajim.1 +++ b/data/gajim.1 @@ -1,137 +1,117 @@ -.Dd January 21, 2018 -.Dt GAJIM 1 URM -.Os UNIX -.Sh NAME -.Nm gajim -.Nd A fully-featured XMPP chat client -.Sh SYNOPSIS -.Nm -.Fl h -.Nm -.Op Fl q -.Op Fl v -.Op Fl w -.Op Fl l Ar subsystem=level -.Op Fl p Ar name -.Op Fl s -.Op Fl c Ar directory -.Sh DESCRIPTION -.Nm -aims to be an easy to use and fully-featured XMPP client. -Just chat with your friends or family, easily share pictures and thoughts or -discuss the news with your groups. +.\" Automatically generated by Pandoc 2.9.2.1 +.\" +.TH "gajim" "1" "August 2022" "" "Manual" +.hy +.SH NAME +.PP +gajim - a fully-featured XMPP chat client +.SH SYNOPSIS +.PP +gajim -h +.PD 0 +.P +.PD +gajim --show +.PD 0 +.P +.PD +gajim --start-chat +.PD 0 +.P +.PD +gajim [-q] [-v] [-w] [-l subsystem=level] [-p name] [-s] [-c directory] +[--gdebug] [--cprofile] +.SH DESCRIPTION +.PP +\f[B]gajim\f[R] aims to be an easy to use and fully-featured XMPP +client. +Just chat with your friends or family, easily share pictures and +thoughts or discuss the news with your groups. Chat securely with End-to-End encryption via OMEMO or OpenPGP. -.Nm -integrates well with your other devices: -simply continue conversations on your mobile device. -.Pp +gajim integrates well with your other devices: simply continue +conversations on your mobile device. +.PP XMPP is the Extensible Messaging and Presence Protocol, a set of open technologies for instant messaging, presence, multi-party chat, voice -and video calls, collaboration, lightweight middleware, content -syndication, and generalized routing of XML data. For more information -on the XMPP protocol see <https://xmpp.org/about/>. -.Sh OPTIONS -.Bl -tag -width Ds -.It Fl h Fl Fl help +and video calls, collaboration, lightweight middle\[hy] ware, content +syndication, and generalized routing of XML data. +For more information on the XMPP protocol see https://xmpp.org/about/. +.SH OPTIONS +.TP +\f[B]\f[CB]-h, --help\f[B]\f[R] Show help options -.It Fl q Fl Fl quiet +.TP +\f[B]\f[CB]-V, --version\f[B]\f[R] +Show the application\[cq]s version +.TP +\f[B]\f[CB]-q, --quiet\f[B]\f[R] Show only critical errors -.It Fl s Fl Fl separate -Separate profiles completely (even history db and plugins) -.It Fl v Fl Fl verbose -Print xml stanzas and other debug information -.It Fl w Fl Fl warnings -Show all GTK warnings with traceback -.It Fl l Fl Fl loglevel Em subsystem=level Bq , Em subsystem=level Bq Em ... -Configure logging system. -Subsystem can be -.Em gajim.c.preview , -.Em gajim.gui.preview , -.Em .nbxmpp.stream , -etc. -.Pp -Level can be -.Em DEBUG , -.Em INFO , -.Em WARNING , -.Em ERROR -or -.Em CRITICAL . -.It Fl p Fl Fl profile Em name -Run -.Nm -using -.Pa config.name -in configuration directory -.It Fl c Fl Fl config-path Em directory -Where to look for configuration files -.El -.Sh FILES -.Bl -tag -width Ds -.It $XDG_CACHE_HOME/gajim/cache.db -Cache database file of transports, caps, roster entry, and roster group. -.It $XDG_CACHE_HOME/gajim/avatars/ -Cache directory of avatars. -.It $XDG_CONFIG_HOME/gajim/ -The config-path used when -.Op Fl c -is not specified. -.It $XDG_DATA_HOME/gajim/certs/ -Directory where certificates are stored. -.It $XDG_DATA_HOME/gajim/logs.db -The history database log file. -For more information on database logs see -<https://dev.gajim.org/gajim/gajim/wikis/development/LogsDatabase>. -.El -.Sh AUTHORS -.An -nosplit -.Nm -is written and maintained by -.An Yann Leboulanger -and -.An Philipp Hörist , -with contributions and patches merged from many individuals around the world. -See the About Dialog for a complete list. -.Sh COPYRIGHT -Copyright (C) 2003-2022 Gajim Team -.Pp -.Nm -is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 3 only. -.Pp -.Nm -is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. -.Pp -You should have received a copy of the GNU General Public License along with -.Nm . -If not, see <https://www.gnu.org/licenses/>. -.Sh FEEDBACK -You can report bugs or feature requests in our bug tracker at -.Em https://dev.gajim.org/gajim/gajim/issues -or in the -.Em gajim-devel -mailing list; if you want to send us a patch, please do so in our bug tracker. -You can also find us in our chat room. -.Sh WWW -https://www.gajim.org/ -.Sh XMPP -You are welcome to join us at gajim@conference.gajim.org -.Sh MAILING LIST -Below are public mailing lists on lists.gajim.org -.Bd -literal -offset indent -https://lists.gajim.org/cgi-bin/listinfo/gajim-devel -https://lists.gajim.org/cgi-bin/listinfo/translators -.Ed -.Pp -More mailing lists at -.Bd -literal -offset indent -https://lists.gajim.org/cgi-bin/listinfo -.Ed -.Sh BUGS -Please submit bugs at -.Bd -literal -offset indent -https://dev.gajim.org/gajim/gajim/issues -https://dev.gajim.org/gajim/gajim-plugins/issues -https://dev.gajim.org/gajim/python-nbxmpp/issues -.Ed -.Sh SEE ALSO -.Xr gajim-remote 1 +.TP +\f[B]\f[CB]-s, --separate\f[B]\f[R] +Separate profile files completely (even history database and plugins) +.TP +\f[B]\f[CB]-v, --verbose\f[B]\f[R] +Print XML stanzas and other debug information +.TP +\f[B]\f[CB]-p, --profile=NAME\f[B]\f[R] +Use defined profile in configuration directory +.TP +\f[B]\f[CB]-c, --config-path=PATH\f[B]\f[R] +Set configuration directory +.TP +\f[B]\f[CB]-l, --loglevel=SUBSYSTEM=LEVEL\f[B]\f[R] +Configure logging. +.RS +.PP +SUBSYSTEM e.g.\ gajim.c.m +.PD 0 +.P +.PD +LEVEL (DEBUG, INFO, WARNING, ERROR, CRITICAL) +.PP +Example: gajim.c.m=DEBUG +.RE +.TP +\f[B]\f[CB]-w, --warnings\f[B]\f[R] +Show all warnings +.TP +\f[B]\f[CB]--gdebug\f[B]\f[R] +Sets an environment variable so GLib debug messages are printed +.TP +\f[B]\f[CB]--cprofile\f[B]\f[R] +Profile application with cprofile +.TP +\f[B]\f[CB]--start-chat\f[B]\f[R] +Start a new chat +.TP +\f[B]\f[CB]--show\f[B]\f[R] +Show Gajim +.SH FILES +.TP +$XDG_CACHE_HOME/gajim/ +The directory for cached data. +.TP +$XDG_CONFIG_HOME/gajim/ +The directory where settings and configurations are stored. +.TP +$XDG_DATA_HOME/gajim/ +The directory where all persistent data, e.g.\ the message database, is +stored. +.SH BUGS +.PP +Please submit bugs at https://dev.gajim.org/gajim/gajim/issues. +.SH SUPPORT +.PP +You are welcome to join us at xmpp:gajim\[at]conference.gajim.org?join. +.SH COPYRIGHT +.PP +gajim is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free +Software Foundation; version 3 only. +.PP +gajim is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. +See the GNU General Public License for more details. +.SH AUTHORS +Philipp H\[:o]rist, Daniel Br\[:o]tzmann, Yann Leboulanger. diff --git a/data/gajim.1.md b/data/gajim.1.md new file mode 100644 index 000000000..53816654d --- /dev/null +++ b/data/gajim.1.md @@ -0,0 +1,103 @@ +% gajim(1) | Manual +% Philipp Hörist, Daniel Brötzmann, Yann Leboulanger +% August 2022 + +# NAME + +gajim - a fully-featured XMPP chat client + +# SYNOPSIS + +gajim -h\ +gajim \--show\ +gajim \--start-chat\ +gajim [-q] [-v] [-w] [-l subsystem=level] [-p name] [-s] [-c directory] [\--gdebug] [\--cprofile] + +# DESCRIPTION + +**gajim** aims to be an easy to use and fully-featured XMPP client. Just chat with your friends or +family, easily share pictures and thoughts or discuss the news with your groups. Chat securely +with End-to-End encryption via OMEMO or OpenPGP. gajim integrates well with your other devices: +simply continue conversations on your mobile device. + +XMPP is the Extensible Messaging and Presence Protocol, a set of open technologies for instant +messaging, presence, multi-party chat, voice and video calls, collaboration, lightweight middle‐ +ware, content syndication, and generalized routing of XML data. For more information on the XMPP +protocol see https://xmpp.org/about/. + +# OPTIONS + +`-h, --help` + +: Show help options + +`-V, --version` +: Show the application's version + +`-q, --quiet` +: Show only critical errors + +`-s, --separate` +: Separate profile files completely (even history database and plugins) + +`-v, --verbose` +: Print XML stanzas and other debug information + +`-p, --profile=NAME` +: Use defined profile in configuration directory + +`-c, --config-path=PATH` +: Set configuration directory + +`-l, --loglevel=SUBSYSTEM=LEVEL` +: Configure logging. + + SUBSYSTEM e.g. gajim.c.m\ + LEVEL (DEBUG, INFO, WARNING, ERROR, CRITICAL) + + Example: gajim.c.m=DEBUG + +`-w, --warnings` +: Show all warnings + +`--gdebug` +: Sets an environment variable so GLib debug messages are printed + +`--cprofile` +: Profile application with cprofile + +`--start-chat` +: Start a new chat + +`--show` +: Show Gajim + +# FILES + +$XDG_CACHE_HOME/gajim/ +: The directory for cached data. + +$XDG_CONFIG_HOME/gajim/ +: The directory where settings and configurations are stored. + +$XDG_DATA_HOME/gajim/ +: The directory where all persistent data, e.g. the message database, is stored. + +# BUGS + +Please submit bugs at https://dev.gajim.org/gajim/gajim/issues. + +# SUPPORT + +You are welcome to join us at xmpp:gajim@conference.gajim.org?join. + +# COPYRIGHT + +gajim is free software; you can redistribute it and/or modify it under the +terms of the GNU General Public License as published by the +Free Software Foundation; version 3 only. + +gajim is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. +See the GNU General Public License for more details. |