From 9c0e3e3300ea7b575241fb489de31f2bf842091c Mon Sep 17 00:00:00 2001 From: Bernhard Miklautz Date: Mon, 16 Jan 2017 11:09:26 +0100 Subject: [PATCH] wlfreerdp: add initial man page --- client/.gitignore | 1 + client/Wayland/CMakeLists.txt | 1 + client/Wayland/wlfreerdp.1.in | 38 +++++++++++++++++++++++++++++++++++ 3 files changed, 40 insertions(+) create mode 100644 client/Wayland/wlfreerdp.1.in diff --git a/client/.gitignore b/client/.gitignore index 9ad5b74c0..574a1de7b 100644 --- a/client/.gitignore +++ b/client/.gitignore @@ -10,3 +10,4 @@ !/Wayland !/CMakeLists.txt !*.in +Wayland/wlfreerdp.1 diff --git a/client/Wayland/CMakeLists.txt b/client/Wayland/CMakeLists.txt index 1b81d2e97..6a39a2f76 100644 --- a/client/Wayland/CMakeLists.txt +++ b/client/Wayland/CMakeLists.txt @@ -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) diff --git a/client/Wayland/wlfreerdp.1.in b/client/Wayland/wlfreerdp.1.in new file mode 100644 index 000000000..d576a096a --- /dev/null +++ b/client/Wayland/wlfreerdp.1.in @@ -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:[: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[: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