Add note about zsh completions.

singlequotes
Martin Dosch 1 year ago
parent 61e928379a
commit 995a149967
No known key found for this signature in database
GPG Key ID: 52A57CFCE13D657D

@ -160,3 +160,15 @@ Send file changes to two groupchats (`-c`) using a configuration file.
```bash
tail -f example.log | ./go-sendxmpp -cif ./sendxmpp chat1@conference.example.com chat2@conference.example.com
```
### shell completion
#### zsh
There are no shell completions yet (contributions welcome) but for zsh it is possible to automatically create completions from `--help` which might work *good enough*.
Just place the following in your `~/.zshrc` or `~/.zshrc.local`:
``` bash
compdef _gnu_generic go-sendxmpp
```

@ -1,6 +1,6 @@
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GO\-SENDXMPP" "1" "February 2023" ""
.TH "GO\-SENDXMPP" "1" "March 2023" ""
.SH "NAME"
\fBgo\-sendxmpp\fR \- A tool to send messages to an XMPP contact or MUC\.
.SH "SYNOPSIS"
@ -97,6 +97,13 @@ Username for XMPP account (JID)\.
.TP
\fB\-\-version\fR
Show version information\.
.SH "SHELL COMPLETIONS"
.SS "ZSH"
There are no shell completions yet (contributions welcome) but for zsh it is possible to autom atically create completions from \fB\-\-help\fR which might work good enough\.
.P
Just place the following in your \fB~/\.zshrc\fR or \fB~/\.zshrc\.local\fR:
.P
\fBcompdef _gnu_generic go\-sendxmpp\fR
.SH "CHAT"
Feel free to join \fIhttps://join\.jabber\.network/#go\-sendxmpp@chat\.mdosch\.de?join\fR\.
.SH "AUTHOR"

@ -57,6 +57,7 @@
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#OPTIONS">OPTIONS</a>
<a href="#SHELL-COMPLETIONS">SHELL COMPLETIONS</a>
<a href="#CHAT">CHAT</a>
<a href="#AUTHOR">AUTHOR</a>
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
@ -195,6 +196,19 @@ To send raw XML to a MUC you have to specify the MUC via <code>-c</code> and go-
<dd>Show version information.</dd>
</dl>
<h2 id="SHELL-COMPLETIONS">SHELL COMPLETIONS</h2>
<h3 id="ZSH">ZSH</h3>
<p>There are no shell completions yet (contributions welcome) but for zsh it is possible to autom
atically create completions from <code>--help</code> which might work good enough.</p>
<p>Just place the following in your <code>~/.zshrc</code> or <code>~/.zshrc.local</code>:</p>
<p><code>
compdef _gnu_generic go-sendxmpp
</code></p>
<h2 id="CHAT">CHAT</h2>
<p>Feel free to join <a href="https://join.jabber.network/#go-sendxmpp@chat.mdosch.de?join" data-bare-link="true">https://join.jabber.network/#go-sendxmpp@chat.mdosch.de?join</a>.</p>
@ -218,7 +232,7 @@ License: BSD 2-clause License</p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>February 2023</li>
<li class='tc'>March 2023</li>
<li class='tr'>go-sendxmpp(1)</li>
</ol>

@ -119,6 +119,19 @@ Username for XMPP account (JID).
* `--version`:
Show version information.
## SHELL COMPLETIONS
### ZSH
There are no shell completions yet (contributions welcome) but for zsh it is possible to autom
atically create completions from `--help` which might work good enough.
Just place the following in your `~/.zshrc` or `~/.zshrc.local`:
```
compdef _gnu_generic go-sendxmpp
```
## CHAT
Feel free to join [https://join.jabber.network/#go-sendxmpp@chat.mdosch.de?join](https://join.jabber.network/#go-sendxmpp@chat.mdosch.de?join).

Loading…
Cancel
Save