rayelliott
/
barrier
mirror of https://github.com/debauchee/barrier.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
barrier/doc/UpdateManpages.txt

11 lines
520 B
Plaintext
Raw Normal View History

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
2019-11-21 18:13:45 +00:00
To recreate the generated part of barrierc manpage use a command like:
update manpages and --help output. fixes #23
2018-03-13 20:55:07 +00:00
help2man -N --output=barrierc.1 --name='Barrier Keyboard/Mouse Client' /path/to/barrierc
And for barriers:
help2man -N --output=barriers.1 --name='Barrier Keyboard/Mouse Server' /path/to/barriers
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
2019-11-21 18:13:45 +00:00
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.