Man page: fix incorrect name of user conf file in barriers.1
The leading dot was lost in documentation in previous change while moving file to another directory. The usage of leading dot in non-home folder is not a common practice, but this is the current behavior, and this commit just update man page to match the code. Also the man pages has a not that they are auto-generated by help2man. I used help2man to update them, but it's output has some problems (wrong formatting of copyrights). So in addition to the only important change (naming fix) there is some more changes: * Formatting manually added to the list of config files. * New option --screen-change-script auto-added by help2man * Man files themselves and doc/UpdateManpages.txt now mention that some manual work is needed after help2man
This commit is contained in:
parent
1246ec36fd
commit
e2d460b779
|
@ -1,5 +1,10 @@
|
||||||
To recreate the barrierc manpage use a command like:
|
To recreate the generated part of barrierc manpage use a command like:
|
||||||
help2man -N --output=barrierc.1 --name='Barrier Keyboard/Mouse Client' /path/to/barrierc
|
help2man -N --output=barrierc.1 --name='Barrier Keyboard/Mouse Client' /path/to/barrierc
|
||||||
|
|
||||||
And for barriers:
|
And for barriers:
|
||||||
help2man -N --output=barriers.1 --name='Barrier Keyboard/Mouse Server' /path/to/barriers
|
help2man -N --output=barriers.1 --name='Barrier Keyboard/Mouse Server' /path/to/barriers
|
||||||
|
|
||||||
|
After that manually fixup:
|
||||||
|
* replace your home directory with $HOME in barriers.1
|
||||||
|
* revert formatting of FILES and COPYRIGHT sections to match formatting of existing version.
|
||||||
|
* add note referencing this file for instructions to the first line.
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
|
.\" See UpdateManpages.txt about modification of this file. Most of it was generated by help2man 1.47.8.
|
||||||
.TH BARRIERC "1" "May 2018" "barrierc 2.1.0-snapshot" "User Commands"
|
.TH BARRIERC "1" "November 2019" "barrierc 2.3.2-snapshot" "User Commands"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
barrierc \- Barrier Keyboard/Mouse Client
|
barrierc \- Barrier Keyboard/Mouse Client
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
|
.\" See UpdateManpages.txt about modification of this file. Most of it was generated by help2man 1.47.8.
|
||||||
.TH BARRIERS "1" "May 2018" "barriers 2.1.0-snapshot" "User Commands"
|
.TH BARRIERS "1" "November 2019" "barriers 2.3.2-snapshot" "User Commands"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
barriers \- Barrier Keyboard/Mouse Server
|
barriers \- Barrier Keyboard/Mouse Server
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
@ -47,6 +47,10 @@ connect to the X server at <display>
|
||||||
\fB\-\-no\-xinitthreads\fR
|
\fB\-\-no\-xinitthreads\fR
|
||||||
do not call XInitThreads()
|
do not call XInitThreads()
|
||||||
.TP
|
.TP
|
||||||
|
\fB\-\-screen\-change\-script\fR <path>
|
||||||
|
full path to script to run on screen change
|
||||||
|
first argument is the new screen name
|
||||||
|
.TP
|
||||||
\fB\-f\fR, \fB\-\-no\-daemon\fR
|
\fB\-f\fR, \fB\-\-no\-daemon\fR
|
||||||
run in the foreground.
|
run in the foreground.
|
||||||
.TP
|
.TP
|
||||||
|
@ -66,12 +70,13 @@ hostname must be the address or hostname of an interface on the system.
|
||||||
Placing brackets around an IPv6 address is required when also specifying
|
Placing brackets around an IPv6 address is required when also specifying
|
||||||
a port number and optional otherwise. The default is to listen on all
|
a port number and optional otherwise. The default is to listen on all
|
||||||
interfaces using port number 24800.
|
interfaces using port number 24800.
|
||||||
.PP
|
.SH FILES
|
||||||
If no configuration file pathname is provided then the first of the
|
If no configuration file pathname is provided then the first of the
|
||||||
following to load successfully sets the configuration:
|
following to load successfully sets the configuration:
|
||||||
.IP
|
.IP
|
||||||
$HOME/.local/share/barrier/barrier.conf
|
.I $HOME/.local/share/barrier/.barrier.conf
|
||||||
\fI\,/etc/barrier.conf\/\fP
|
.br
|
||||||
|
.I /etc/barrier.conf
|
||||||
.SH COPYRIGHT
|
.SH COPYRIGHT
|
||||||
Copyright \(co 2018 Debauchee Open Source Group
|
Copyright \(co 2018 Debauchee Open Source Group
|
||||||
.br
|
.br
|
||||||
|
|
Loading…
Reference in New Issue