diff --git a/man/go-sendxmpp.1 b/man/go-sendxmpp.1 index ffb5dc9..19e2b5c 100644 --- a/man/go-sendxmpp.1 +++ b/man/go-sendxmpp.1 @@ -108,6 +108,13 @@ Show version information\. A SOCKS5 proxy can be used by setting the environment variable \fBHTTP_PROXY\fR\. This feature is considered experimental and there is no guarantee that there won't be any connections not using the proxy although it didn't happen during testing\. .P \fBHTTP_PROXY="socks5://127\.0\.0\.1:9050" go\-sendxmpp \-\-http\-upload file\.txt user@example\.org\fR +.SH "TIPS" +.SS "USAGE BY ROOT" +In general it's a good advice to only perform commands as root when it is strictly necessary\. To be able to send the output from commands, that need to be performed as root, with go\-sendxmpp without invoking go\-sendxmpp by root sudo can be used\. +.P +In this example there is a user \fBsendxmpp\fR with a go\-sendxmpp config in it's \fB$HOME\fR: +.P +\fB# command\-that\-requires\-root|sudo \-H \-u sendxmpp go\-sendxmpp me@example\.org\fR .SH "SHELL COMPLETIONS" .SS "ZSH" There are no shell completions yet (contributions welcome) but for zsh it is possible to automatically create completions from \fB\-\-help\fR which might work good enough\. diff --git a/man/go-sendxmpp.1.html b/man/go-sendxmpp.1.html index 0e87c49..0979911 100644 --- a/man/go-sendxmpp.1.html +++ b/man/go-sendxmpp.1.html @@ -58,6 +58,7 @@ DESCRIPTION OPTIONS ENVIRONMENT VARIABLES + TIPS SHELL COMPLETIONS CHAT AUTHOR @@ -219,6 +220,20 @@ testing.

HTTP_PROXY="socks5://127.0.0.1:9050" go-sendxmpp --http-upload file.txt user@example.org

+

TIPS

+ +

USAGE BY ROOT

+ +

In general it's a good advice to only perform commands as root when it is strictly necessary. To be able to send +the output from commands, that need to be performed as root, with go-sendxmpp without invoking go-sendxmpp by +root sudo can be used.

+ +

In this example there is a user sendxmpp with a go-sendxmpp config in it's $HOME:

+ +

+# command-that-requires-root|sudo -H -u sendxmpp go-sendxmpp me@example.org +

+

SHELL COMPLETIONS

ZSH

diff --git a/man/go-sendxmpp.1.ronn b/man/go-sendxmpp.1.ronn index bfd53bb..20e0dee 100644 --- a/man/go-sendxmpp.1.ronn +++ b/man/go-sendxmpp.1.ronn @@ -144,6 +144,21 @@ testing. HTTP_PROXY="socks5://127.0.0.1:9050" go-sendxmpp --http-upload file.txt user@example.org ``` +## TIPS + +### USAGE BY ROOT + +In general it's a good advice to only perform commands as root when it is strictly necessary. To be able to send +the output from commands, that need to be performed as root, with go-sendxmpp without invoking go-sendxmpp by +root sudo can be used. + +In this example there is a user **sendxmpp** with a go-sendxmpp config in it's `$HOME`: + +``` +# command-that-requires-root|sudo -H -u sendxmpp go-sendxmpp me@example.org +``` + + ## SHELL COMPLETIONS ### ZSH