Fix issues in wlog man page
authorBernhard Miklautz <bernhard.miklautz@thincast.com>
Thu, 1 Dec 2016 10:10:58 +0000 (11:10 +0100)
committerBernhard Miklautz <bernhard.miklautz@thincast.com>
Thu, 1 Dec 2016 14:36:31 +0000 (15:36 +0100)
* fix spelling errors
* move man page from section 1 to section 7
* fix the man page header to match the actual section
* adapt the packages for wlog.7

Fixes #3632

client/X11/xfreerdp-envvar.1.xml
packaging/deb/freerdp-nightly/freerdp-nightly.install
packaging/rpm/freerdp-nightly.spec
winpr/CMakeLists.txt
winpr/wlog.7 [moved from winpr/wlog.1 with 91% similarity]

index b51653a..955adf5 100644 (file)
@@ -6,10 +6,10 @@
                        <term>wlog environment variable</term>
                        <listitem>
                                <para>xfreerdp uses wLog as its log facility, you can refer to the
-                               corresponding man page (wlog(1)) for more informations. Arguments passed
+                               corresponding man page (wlog(7)) for more informations. Arguments passed
                                via the <replaceable>/log-level</replaceable> or <replaceable>/log-filters</replaceable>
                                have precedence over the environment variables.</para>
                        </listitem>
                </varlistentry>
        </variablelist>
-</refsect1>
\ No newline at end of file
+</refsect1>
index 76f6eb5..b12d909 100644 (file)
@@ -1,4 +1,4 @@
 opt/freerdp-nightly/lib/*.so.*
 opt/freerdp-nightly/bin
 opt/freerdp-nightly/share/man/man1/xfreerdp.1*
-opt/freerdp-nightly/share/man/man1/wlog.1*
+opt/freerdp-nightly/share/man/man7/wlog.7*
index f509c7f..2101971 100644 (file)
@@ -135,10 +135,11 @@ export NO_BRP_CHECK_RPATH true
 %dir %{INSTALL_PREFIX}/share/
 %dir %{INSTALL_PREFIX}/share/man/
 %dir %{INSTALL_PREFIX}/share/man/man1
+%dir %{INSTALL_PREFIX}/share/man/man7
 %{INSTALL_PREFIX}/%{_lib}/*.so.*
 %{INSTALL_PREFIX}/bin/
 %{INSTALL_PREFIX}/share/man/man1/xfreerdp.1*
-%{INSTALL_PREFIX}/share/man/man1/wlog.1*
+%{INSTALL_PREFIX}/share/man/man7/wlog.7*
 
 %files devel
 %defattr(-,root,root)
index 2715d52..f8965e4 100644 (file)
@@ -176,9 +176,9 @@ endif()
 
 if(WITH_MANPAGES)
        if(OPENBSD)
-           install(FILES wlog.1 DESTINATION man/man1)
+           install(FILES wlog.7 DESTINATION man/man7)
        else()
-           install(FILES wlog.1 DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/man/man1)
+           install(FILES wlog.7 DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/man/man7)
        endif()
 endif(WITH_MANPAGES)
 
similarity index 91%
rename from winpr/wlog.1
rename to winpr/wlog.7
index d4cbf68..f1b9dde 100644 (file)
@@ -1,8 +1,8 @@
 .\" Written by David Fort (contact@hardening-consulting.com)
 .\" Process this file with
-.\" groff -man -Tascii foo.1
+.\" groff -man -Tascii wlog.7
 .\"
-.TH wLog 13 "June 2016" Version "1.0"
+.TH wLog 7 "June 2016" Version "2.0"
 .SH NAME
 wLog \- WinPR logging facility
 
@@ -48,12 +48,12 @@ This appender outputs messages to journald.
 The WLog are complementary, the higher level always includes the lower ones.
 The level list below is top down. Top the highest level.
 
-.IP TRACE 
+.IP TRACE
 print everything including packets dumps
-.IP DEBUG 
+.IP DEBUG
 debug messages
 .IP INFO
-general informations
+general information
 .IP WARN
 warnings
 .IP ERROR
@@ -104,23 +104,23 @@ WLOG_PREFIX="pid=%pid:tid=%tid:fn=%fn -" xfreerdp /v:xxx
 .SH ENVIRONMENT
 .IP WLOG_APPENDER
 The kind of appender, the accepted values are: CONSOLE, FILE, BINARY, SYSLOG, JOURNALD or UDP
-  
+
 .IP WLOG_PREFIX
 configure the prefix used for outputting the message (see Format for more details and examples)
 
 .IP WLOG_LEVEL
-the level to output messages for 
+the level to output messages for
 
 .IP WLOG_FILTER
 sets a filter for WLog messages. Only the filtered messages are
-printed. The format of the filter is a serie of \<logger name\>:\<level\> separated by
+printed. The format of the filter is a series of \<logger name\>:\<level\> separated by
 comas
 
 example: WLOG_FILTER=core.channel:DEBUG,dummy:TRACE
 will display debug messages for the core.channel logger and trace level for the dummy logger
 
 .IP WLOG_FILEAPPENDER_OUTPUT_FILE_PATH
-When using the file appender it may contains the output log file's path 
+When using the file appender it may contains the output log file's path
 
 .IP WLOG_FILEAPPENDER_OUTPUT_FILE_NAME
 When using the file appender it may contains the output log file's name
@@ -130,13 +130,13 @@ When using the systemd journal appender, this variable contains the id used with
 the journal (by default the executable's name)
 
 .IP WLOG_UDP_TARGET
-target to use for the UDP appender in the format 
+target to use for the UDP appender in the format
 .B host:port
 
 .SH BUGS
 Please report any bugs using the bug reporting form on the
 .B FreeRDP
-web site 
+web site
 
 .SH "SEE ALSO"
 Additional information and the latest version is available