From 16256985bfc6173ae532729cfab0d7df814eb0c1 Mon Sep 17 00:00:00 2001
From: Martin Dosch <martin@mdosch.de>
Date: Thu, 1 Oct 2020 19:18:45 +0200
Subject: [PATCH] Rework config manpage.

---
 man/go-sendxmpp.5      |  6 ++++--
 man/go-sendxmpp.5.html | 10 +++++++---
 man/go-sendxmpp.5.ronn |  7 +++++--
 3 files changed, 16 insertions(+), 7 deletions(-)

diff --git a/man/go-sendxmpp.5 b/man/go-sendxmpp.5
index 9dbb079..1d44332 100644
--- a/man/go-sendxmpp.5
+++ b/man/go-sendxmpp.5
@@ -4,7 +4,7 @@
 .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 ~/\.config/go\-sendxmpp/sendxmpprc (preferred) or ~/\.sendxmpprc (for compatibility with the original perl sendxmpp) if no other configuration file location is specified with \-f or \-\-file\. \fBjserver\fR and \fBport\fR might not be necessary depending on the used server\. The configuration file is expected to be in the following format:
+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 specified with \-f or \-\-file\. The configuration file is expected to be in the following format:
 .SH "FORMAT"
 username: [\fIyour_jid\fR]
 .br
@@ -15,7 +15,9 @@ port: [\fIjabber_port\fR]
 password: [\fIyour_jabber_password\fR]
 .br
 eval_password: [\fIcommand_to_unlock_your_password\fR]
-.P
+.SH "REQUIRED SETTINGS"
+If all necessary settings are supplied as command line arguments no config file is needed at all\. Setting \fBjserver\fR and \fBport\fR might not be necessary depending on the used server\.
+.br
 You should either use a password manager and the setting \fBeval_password\fR (recommended) or add your password in plaintext to the config file with the setting \fBpassword\fR\.
 .SH "AUTHOR"
 Written by Martin Dosch\.
diff --git a/man/go-sendxmpp.5.html b/man/go-sendxmpp.5.html
index ccd703d..3be657a 100644
--- a/man/go-sendxmpp.5.html
+++ b/man/go-sendxmpp.5.html
@@ -56,6 +56,7 @@
     <a href="#NAME">NAME</a>
     <a href="#LOCATION">LOCATION</a>
     <a href="#FORMAT">FORMAT</a>
+    <a href="#REQUIRED-SETTINGS">REQUIRED SETTINGS</a>
     <a href="#AUTHOR">AUTHOR</a>
     <a href="#REPORTING-BUGS">REPORTING BUGS</a>
     <a href="#COPYRIGHT">COPYRIGHT</a>
@@ -78,8 +79,7 @@
 
 <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
-specified with -f or --file. <code>jserver</code> and <code>port</code> might not be necessary depending on the used
-server. The configuration file is expected to be in the following format:</p>
+specified with -f or --file. The configuration file is expected to be in the following format:</p>
 
 <h2 id="FORMAT">FORMAT</h2>
 
@@ -89,7 +89,11 @@ port: [<var>jabber_port</var>]  <br>
 password: [<var>your_jabber_password</var>]  <br>
 eval_password: [<var>command_to_unlock_your_password</var>]</p>
 
-<p>You should either use a password manager and the setting <code>eval_password</code> (recommended) or add
+<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> (recommended) or add
 your password in plaintext to the config file with the setting <code>password</code>.</p>
 
 <h2 id="AUTHOR">AUTHOR</h2>
diff --git a/man/go-sendxmpp.5.ronn b/man/go-sendxmpp.5.ronn
index 8444ca2..bb14360 100644
--- a/man/go-sendxmpp.5.ronn
+++ b/man/go-sendxmpp.5.ronn
@@ -5,8 +5,7 @@ go-sendxmpp(5) -- A little tool to send messages to an XMPP contact or MUC.
 
 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
-specified with -f or --file. `jserver` and `port` might not be necessary depending on the used
-server. The configuration file is expected to be in the following format:
+specified with -f or --file. The configuration file is expected to be in the following format:
 
 ## FORMAT
 
@@ -16,6 +15,10 @@ port: [<jabber_port>]
 password: [<your_jabber_password>]    
 eval_password: [<command_to_unlock_your_password>]
 
+## REQUIRED SETTINGS
+
+If all necessary settings are supplied as command line arguments no config file is needed at all.
+Setting `jserver` and `port` might not be necessary depending on the used server.    
 You should either use a password manager and the setting `eval_password` (recommended) or add
 your password in plaintext to the config file with the setting `password`.