Added first manpage experiments.

This commit is contained in:
Martin Dosch 2019-02-21 19:37:58 +01:00
parent ba73e67f88
commit 596a2b9cc2
6 changed files with 468 additions and 0 deletions

77
docs/go-sendxmpp.1 Normal file
View File

@ -0,0 +1,77 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GO\-SENDXMPP" "1" "February 2019" "" "go-sendxmpp"
.
.SH "NAME"
\fBgo\-sendxmpp\fR \- A little tool to send messages to an XMPP contact or MUC\.
.
.SH "SYNOPSIS"
go\-sendxmpp` [\-cdtx] [\-f value] [\-\-help] [\-j value] [\-p value] [\-r value] [\-u value] [parameters \.\.\.]
.
.SH "DESCRIPTION"
A little tool to send messages to an XMPP contact or MUC inspired by (but not as powerful as) \fBsendxmpp\fR\.
.
.br
You can either pipe a programs output to \fBgo\-sendxmpp\fR, write in your terminal (put \fB^D\fR in a new line to finish) or send the input from a file (\fB\-m\fR or \fB\-\-message\fR)\.
.
.br
The account data is expected at \fB~/\.sendxmpprc\fR if no other configuration file location is specified with \fB\-f\fR or \fB\-\-file\fR\.
.
.SH "OPTIONS"
.
.IP "\(bu" 4
\fB\-c\fR, \fB\-\-chatroom\fR=[\fIvalue\fR]: Send message to a chatroom\.
.
.IP "\(bu" 4
\fB\-d\fR, \fB\-\-debug\fR:
.
.br
Show debugging info\.
.
.IP "\(bu" 4
\fB\-f\fR, \fB\-\-file\fR=[\fIvalue\fR]: Set configuration file\. (Default: ~/\.sendxmpprc)
.
.IP "\(bu" 4
\fB\-\-help\fR: Show help\.
.
.IP "\(bu" 4
\fB\-i\fR, \fB\-\-interactive\fR: Interactive mode (for use with e\.g\. `tail \-f)\.
.
.IP "\(bu" 4
\fB\-j\fR, \fB\-\-jserver\fR=[\fIvalue\fR]: XMPP server address\.
.
.IP "\(bu" 4
\fB\-m\fR, \fB\-\-message\fR=[\fIvalue\fR]: Set file including the message\.
.
.IP "\(bu" 4
\fB\-p\fR, \fB\-\-password\fR=[\fIvalue\fR]: Password for XMPP account\.
.
.IP "\(bu" 4
\fB\-r\fR, \fB\-\-resource\fR=[\fIvalue\fR]: Set resource\. When sending to a chatroom this is used as \'alias\'\. (Default: go\-sendxmpp)
.
.IP "\(bu" 4
\fB\-t\fR, \fB\-\-tls\fR:
.
.br
Use TLS\.
.
.IP "\(bu" 4
\fB\-u\fR, \fB\-\-username\fR=[\fIvalue\fR]: Username for XMPP account\.
.
.IP "\(bu" 4
\fB\-x\fR, \fB\-\-start\-tls\fR: Use StartTLS\.
.
.IP "" 0
.
.SH "AUTHOR"
Written by Martin Dosch\.
.
.SH "REPORTING BUGS"
Report bugs at https://salsa\.debian\.org/mdosch\-guest/go\-sendxmpp/issues
.
.SH "COPYRIGHT"
Copyright (c) 2018 Martin Dosch License: MIT License
.
.SH "SEE ALSO"
go\-sendxmpp(5), sendxmpp(1)

144
docs/go-sendxmpp.1.html Normal file
View File

@ -0,0 +1,144 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<title>go-sendxmpp(1) - 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="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#OPTIONS">OPTIONS</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(1)</li>
<li class='tc'>go-sendxmpp</li>
<li class='tr'>go-sendxmpp(1)</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="SYNOPSIS">SYNOPSIS</h2>
<p>go-sendxmpp` [-cdtx] [-f value] [--help] [-j value] [-p value] [-r value] [-u value] [parameters ...]</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>A little tool to send messages to an XMPP contact or MUC inspired by (but not as powerful as) <code>sendxmpp</code>. <br />
You can either pipe a programs output to <code>go-sendxmpp</code>, write in your terminal (put <code>^D</code> in a new line to finish) or send the input from a file (<code>-m</code> or <code>--message</code>). <br />
The account data is expected at <code>~/.sendxmpprc</code> if no other configuration file location is specified with <code>-f</code> or <code>--file</code>.</p>
<h2 id="OPTIONS">OPTIONS</h2>
<ul>
<li><p><code>-c</code>, <code>--chatroom</code>=[<var>value</var>]:
Send message to a chatroom.</p></li>
<li><p><code>-d</code>, <code>--debug</code>: <br />
Show debugging info.</p></li>
<li><p><code>-f</code>, <code>--file</code>=[<var>value</var>]:
Set configuration file. (Default: ~/.sendxmpprc)</p></li>
<li><p><code>--help</code>:
Show help.</p></li>
<li><p><code>-i</code>, <code>--interactive</code>:
Interactive mode (for use with e.g. `tail -f).</p></li>
<li><p><code>-j</code>, <code>--jserver</code>=[<var>value</var>]:
XMPP server address.</p></li>
<li><p><code>-m</code>, <code>--message</code>=[<var>value</var>]:
Set file including the message.</p></li>
<li><p><code>-p</code>, <code>--password</code>=[<var>value</var>]:
Password for XMPP account.</p></li>
<li><p><code>-r</code>, <code>--resource</code>=[<var>value</var>]:
Set resource. When sending to a chatroom this is used as
'alias'. (Default: go-sendxmpp)</p></li>
<li><p><code>-t</code>, <code>--tls</code>: <br />
Use TLS.</p></li>
<li><p><code>-u</code>, <code>--username</code>=[<var>value</var>]:
Username for XMPP account.</p></li>
<li><p><code>-x</code>, <code>--start-tls</code>:
Use StartTLS.</p></li>
</ul>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Martin Dosch.</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
<p>Report bugs at https://salsa.debian.org/mdosch-guest/go-sendxmpp/issues</p>
<h2 id="COPYRIGHT">COPYRIGHT</h2>
<p>Copyright (c) 2018 Martin Dosch
License: MIT License</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p><a class="man-ref" href="go-sendxmpp.5.html">go-sendxmpp<span class="s">(5)</span></a>, <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'>February 2019</li>
<li class='tr'>go-sendxmpp(1)</li>
</ol>
</div>
</body>
</html>

69
docs/go-sendxmpp.1.ronn Normal file
View File

@ -0,0 +1,69 @@
go-sendxmpp(1) -- A little tool to send messages to an XMPP contact or MUC.
====
## SYNOPSIS
go-sendxmpp` [-cdtx] [-f value] [--help] [-j value] [-p value] [-r value] [-u value] [parameters ...]
## DESCRIPTION
A little tool to send messages to an XMPP contact or MUC inspired by (but not as powerful as) `sendxmpp`.
You can either pipe a programs output to `go-sendxmpp`, write in your terminal (put `^D` in a new line to finish) or send the input from a file (`-m` or `--message`).
The account data is expected at `~/.sendxmpprc` if no other configuration file location is specified with `-f` or `--file`.
## OPTIONS
* `-c`, `--chatroom`=[<value>]:
Send message to a chatroom.
* `-d`, `--debug`:
Show debugging info.
* `-f`, `--file`=[<value>]:
Set configuration file. (Default: ~/.sendxmpprc)
* `--help`:
Show help.
* `-i`, `--interactive`:
Interactive mode (for use with e.g. `tail -f).
* `-j`, `--jserver`=[<value>]:
XMPP server address.
* `-m`, `--message`=[<value>]:
Set file including the message.
* `-p`, `--password`=[<value>]:
Password for XMPP account.
* `-r`, `--resource`=[<value>]:
Set resource. When sending to a chatroom this is used as
'alias'. (Default: go-sendxmpp)
* `-t`, `--tls`:
Use TLS.
* `-u`, `--username`=[<value>]:
Username for XMPP account.
* `-x`, `--start-tls`:
Use StartTLS.
## AUTHOR
Written by Martin Dosch.
## REPORTING BUGS
Report bugs at https://salsa.debian.org/mdosch-guest/go-sendxmpp/issues
## COPYRIGHT
Copyright (c) 2018 Martin Dosch
License: MIT License
## SEE ALSO
go-sendxmpp(5), sendxmpp(1)

34
docs/go-sendxmpp.5 Normal file
View File

@ -0,0 +1,34 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GO\-SENDXMPP" "5" "February 2019" "" "go-sendxmpp"
.
.SH "NAME"
\fBgo\-sendxmpp\fR \- A little tool to send messages to an XMPP contact or MUC\.
.
.SH "LOCATION"
The account data is expected at ~/\.sendxmpprc if no other configuration file location is specified with \-f or \-\-file\. The configuration file is expected to be in the following format:
.
.SH "FORMAT"
username: [\fIyour_username\fR]
.
.br
jserver: [\fIjabber_server\fR]
.
.br
port: [\fIjabber_port\fR]
.
.br
password: [\fIyour_jabber_password\fR]
.
.SH "AUTHOR"
Written by Martin Dosch\.
.
.SH "REPORTING BUGS"
Report bugs at https://salsa\.debian\.org/mdosch\-guest/go\-sendxmpp/issues
.
.SH "COPYRIGHT"
Copyright (c) 2018 Martin Dosch License: MIT License
.
.SH "SEE ALSO"
go\-sendxmpp(1), sendxmpp(1)

113
docs/go-sendxmpp.5.html Normal file
View File

@ -0,0 +1,113 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<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>
<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>
<li class='tc'>go-sendxmpp</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 ~/.sendxmpprc if no other configuration file location is specified with -f or --file. The configuration file is expected to be in the following format:</p>
<h2 id="FORMAT">FORMAT</h2>
<p>username: [<var>your_username</var>] <br />
jserver: [<var>jabber_server</var>] <br />
port: [<var>jabber_port</var>] <br />
password: [<var>your_jabber_password</var>]</p>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Martin Dosch.</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
<p>Report bugs at https://salsa.debian.org/mdosch-guest/go-sendxmpp/issues</p>
<h2 id="COPYRIGHT">COPYRIGHT</h2>
<p>Copyright (c) 2018 Martin Dosch
License: MIT License</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p><a class="man-ref" href="go-sendxmpp.1.html">go-sendxmpp<span class="s">(1)</span></a>, <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'>February 2019</li>
<li class='tr'>go-sendxmpp(5)</li>
</ol>
</div>
</body>
</html>

31
docs/go-sendxmpp.5.ronn Normal file
View File

@ -0,0 +1,31 @@
go-sendxmpp(5) -- A little tool to send messages to an XMPP contact or MUC.
====
## LOCATION
The account data is expected at ~/.sendxmpprc if no other configuration file location is specified with -f or --file. The configuration file is expected to be in the following format:
## FORMAT
username: [<your_username>]
jserver: [<jabber_server>]
port: [<jabber_port>]
password: [<your_jabber_password>]
## AUTHOR
Written by Martin Dosch.
## REPORTING BUGS
Report bugs at https://salsa.debian.org/mdosch-guest/go-sendxmpp/issues
## COPYRIGHT
Copyright (c) 2018 Martin Dosch
License: MIT License
## SEE ALSO
go-sendxmpp(1), sendxmpp(1)