go-sendxmpp/man/go-sendxmpp.5.html

125 lines
4.7 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' content='text/html;charset=utf8'>
<meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
<title>go-sendxmpp(5) - A little tool to send messages to an XMPP contact or MUC.</title>
<style type='text/css' media='all'>
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
<body id='manpage'>
<div class='mp' id='man'>
<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#LOCATION">LOCATION</a>
<a href="#FORMAT">FORMAT</a>
2020-10-01 17:18:45 +00:00
<a href="#REQUIRED-SETTINGS">REQUIRED SETTINGS</a>
<a href="#AUTHOR">AUTHOR</a>
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
<a href="#COPYRIGHT">COPYRIGHT</a>
<a href="#SEE-ALSO">SEE ALSO</a>
</div>
<ol class='man-decor man-head man head'>
<li class='tl'>go-sendxmpp(5)</li>
2020-04-23 07:11:37 +00:00
<li class='tc'></li>
<li class='tr'>go-sendxmpp(5)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>go-sendxmpp</code> - <span class="man-whatis">A little tool to send messages to an XMPP contact or MUC.</span>
</p>
<h2 id="LOCATION">LOCATION</h2>
<p>The account data is expected at ~/.config/go-sendxmpp/sendxmpprc (preferred) or ~/.sendxmpprc
(for compatibility with the original perl sendxmpp) if no other configuration file location is
2020-10-01 17:18:45 +00:00
specified with -f or --file. The configuration file is expected to be in the following format:</p>
<h2 id="FORMAT">FORMAT</h2>
2020-10-01 16:57:42 +00:00
<p>username: [<var>your_jid</var>] <br>
jserver: [<var>jabber_server</var>] <br>
port: [<var>jabber_port</var>] <br>
password: [<var>your_jabber_password</var>] <br>
2020-10-01 16:59:56 +00:00
eval_password: [<var>command_to_unlock_your_password</var>]</p>
2020-10-01 16:55:41 +00:00
2020-10-01 17:18:45 +00:00
<h2 id="REQUIRED-SETTINGS">REQUIRED SETTINGS</h2>
<p>If all necessary settings are supplied as command line arguments no config file is needed at all.
Setting <code>jserver</code> and <code>port</code> might not be necessary depending on the used server. <br>
You should either use a password manager and the setting <code>eval_password</code> or add
2020-10-01 16:55:41 +00:00
your password in plaintext to the config file with the setting <code>password</code>.</p>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Martin Dosch.</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
2020-04-23 07:11:37 +00:00
<p>Report bugs at https://salsa.debian.org/mdosch/go-sendxmpp/issues</p>
<h2 id="COPYRIGHT">COPYRIGHT</h2>
2020-04-04 07:45:46 +00:00
<p>Copyright (c) 2018 - 2020 Martin Dosch
License: BSD 2-clause License</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p><span class="man-ref">go-sendxmpp<span class="s">(1)</span></span>, <span class="man-ref">sendxmpp<span class="s">(1)</span></span></p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>October 2020</li>
<li class='tr'>go-sendxmpp(5)</li>
</ol>
</div>
</body>
</html>