wlfreerdp: add initial man page

This commit is contained in:
Bernhard Miklautz 2017-01-16 11:09:26 +01:00
parent 38e0bce772
commit 9c0e3e3300
3 changed files with 40 additions and 0 deletions

1
client/.gitignore vendored
View File

@ -10,3 +10,4 @@
!/Wayland
!/CMakeLists.txt
!*.in
Wayland/wlfreerdp.1

View File

@ -39,3 +39,4 @@ target_link_libraries(${MODULE_NAME} ${${MODULE_PREFIX}_LIBS})
install(TARGETS ${MODULE_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT client)
set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "Client/Wayland")
configure_file(wlfreerdp.1.in ${CMAKE_CURRENT_BINARY_DIR}/wlfreerdp.1)

View File

@ -0,0 +1,38 @@
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac))
.TH wlfreerdp 1 2017-01-12 "@FREERDP_VERSION_FULL@" "FreeRDP"
.SH NAME
wlfreerdp \- FreeRDP wayland client
.SH SYNOPSIS
.B wlfreerdp
[file]
[\fIdefault_client_options\fP]
[\fB/v\fP:<server>[:port]]
[\fB/version\fP]
[\fB/help\fP]
.SH DESCRIPTION
.B wlfreerdp
is a wayland Remote Desktop Protocol (RDP) client which is part of the FreeRDP project. A RDP server is built-in to many editions of Windows. Alternative servers included xrdp and VRDP (VirtualBox).
.SH OPTIONS
The wayland client also supports a lot of the \fIdefault client options\fP which are not described here. For details on those see the xfreerdp(1) man page.
.IP \fB/v:\fP\fI<server>[:port]\fP
The server hostname or IP, and optionally the port, to connect to.
.IP /version
Print the version and exit.
.IP /help
Print the help and exit.
.SH EXIT STATUS
.TP
.B 0
Successful program execution.
.TP
.B not 0
On failure.
.SH SEE ALSO
xfreerdp(1) wlog(7)
.SH AUTHOR
FreeRDP <team@freerdp.com>