Skip to content

Commit

Permalink
Add an environment variables section to the man
Browse files Browse the repository at this point in the history
  • Loading branch information
hardening committed Jun 21, 2016
1 parent 0905cc2 commit 1fdcae9
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 5 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ compile_commands.json
docs/api
client/X11/xfreerdp.1
client/X11/xfreerdp.1.xml
client/X11/xfreerdp-channels.1.xml
client/X11/xfreerdp-examples.1.xml

# Mac OS X
.DS_Store
Expand Down
2 changes: 1 addition & 1 deletion client/X11/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
*.xml
xfreerdp-argument.1.xml
generate_argument_docbook
7 changes: 5 additions & 2 deletions client/X11/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -93,16 +93,19 @@ if(WITH_MANPAGES)

add_custom_command(OUTPUT xfreerdp.1
COMMAND generate_argument_docbook
COMMAND ${CMAKE_COMMAND} -E copy
COMMAND ${CMAKE_COMMAND} -E copy
${CMAKE_CURRENT_SOURCE_DIR}/xfreerdp-channels.1.xml ${CMAKE_CURRENT_BINARY_DIR}
COMMAND ${CMAKE_COMMAND} -E copy
COMMAND ${CMAKE_COMMAND} -E copy
${CMAKE_CURRENT_SOURCE_DIR}/xfreerdp-examples.1.xml ${CMAKE_CURRENT_BINARY_DIR}
COMMAND ${CMAKE_COMMAND} -E copy
${CMAKE_CURRENT_SOURCE_DIR}/xfreerdp-envvar.1.xml ${CMAKE_CURRENT_BINARY_DIR}
COMMAND ${XSLTPROC_EXECUTABLE} ${DOCBOOKXSL_DIR}/manpages/docbook.xsl xfreerdp.1.xml
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
DEPENDS
${CMAKE_CURRENT_BINARY_DIR}/xfreerdp.1.xml
${CMAKE_CURRENT_SOURCE_DIR}/xfreerdp-examples.1.xml
${CMAKE_CURRENT_SOURCE_DIR}/xfreerdp-channels.1.xml
${CMAKE_CURRENT_SOURCE_DIR}/xfreerdp-envvar.1.xml
generate_argument_docbook)

add_custom_target(xfreerdp.manpage ALL
Expand Down
15 changes: 15 additions & 0 deletions client/X11/xfreerdp-envvar.1.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<refsect1>
<title>Environment variables</title>

<variablelist>
<varlistentry>
<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
via the <replaceable>/log-level</replaceable> or <replaceable>/log-filters</replaceable>
have precedence over the environment variables.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
3 changes: 3 additions & 0 deletions client/X11/xfreerdp.1.xml.in
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY syntax SYSTEM "xfreerdp-argument.1.xml">
<!ENTITY channels SYSTEM "xfreerdp-channels.1.xml">
<!ENTITY envvar SYSTEM "xfreerdp-envvar.1.xml">
<!ENTITY examples SYSTEM "xfreerdp-examples.1.xml">
]
>
Expand Down Expand Up @@ -49,6 +50,8 @@ PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

&channels;

&envvar;

&examples;

<refsect1>
Expand Down

0 comments on commit 1fdcae9

Please sign in to comment.