[doc,manpage] name manpages versioned

if WITH_BINARY_VERSIONING is activated also version the manpages to
match the binary names
This commit is contained in:
Armin Novak
2023-12-21 19:29:58 +01:00
committed by akallabeth
parent b1cb6b3efc
commit 7d641a67b9
17 changed files with 107 additions and 69 deletions

View File

@@ -41,8 +41,10 @@ add_executable(${MODULE_NAME} ${${MODULE_PREFIX}_SRCS})
set(${MODULE_PREFIX}_LIBS winpr)
set(MANPAGE_NAME "${MODULE_NAME}")
if (WITH_BINARY_VERSIONING)
set_target_properties(${MODULE_NAME} PROPERTIES OUTPUT_NAME "${MODULE_NAME}${WINPR_API_VERSION}${CMAKE_EXECUTABLE_SUFFIX}")
set(MANPAGE_NAME "${MODULE_NAME}${WINPR_API_VERSION}")
endif()
target_link_libraries(${MODULE_NAME} ${${MODULE_PREFIX}_LIBS})
@@ -53,5 +55,5 @@ if (WITH_DEBUG_SYMBOLS AND MSVC)
endif()
set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "WinPR/Tools")
configure_file(winpr-hash.1.in ${CMAKE_CURRENT_BINARY_DIR}/winpr-hash.1)
install_freerdp_man(${CMAKE_CURRENT_BINARY_DIR}/winpr-hash.1 1)
configure_file(winpr-hash.1.in ${CMAKE_CURRENT_BINARY_DIR}/${MANPAGE_NAME}.1)
install_freerdp_man(${CMAKE_CURRENT_BINARY_DIR}/${MANPAGE_NAME}.1 1)

View File

@@ -1,15 +1,15 @@
.TH winpr-hash 1 2017-01-11 "@WINPR_VERSION_FULL@" "FreeRDP"
.TH @MANPAGE_NAME@ 1 2017-01-11 "@WINPR_VERSION_FULL@" "FreeRDP"
.SH NAME
winpr-hash \- NTLM hashing tool
@MANPAGE_NAME@ \- NTLM hashing tool
.SH SYNOPSIS
.B winpr-hash
.B @MANPAGE_NAME@
\fB-u\fP username
\fB-p\fP password
[\fB-d\fP domain]
[\fB-f\fP { \fIdefault\fP | sam }]
[\fB-v\fP { \fI1\fP | 2 }]
.SH DESCRIPTION
.B winpr-hash
.B @MANPAGE_NAME@
is a small utility that can be used to create a NTLM hash from a username and password pair. The created hash can be outputed as plain hash or in SAM format.
.SH OPTIONS
.IP "-u username"
@@ -28,7 +28,7 @@ user:domain::hash:::
Version allows it to specify the NTLM version to use. The default is to use version 1. In case
version 2 is used a domain needs to be specified.
.SH EXAMPLES
winpr-hash -u \fIuser\fP -p \fIpassword\fP -d \fIdomain\fP -f \fIsam\fP -v \fI2\fP
@MANPAGE_NAME@ -u \fIuser\fP -p \fIpassword\fP -d \fIdomain\fP -f \fIsam\fP -v \fI2\fP
Create a version \fI2\fP NTLM hash for \fIuser\fP with \fIdomain\fP and \fIpassword\fP and output it in \fIsam\fP format.
.SH EXIT STATUS

View File

@@ -44,8 +44,13 @@ set(${MODULE_PREFIX}_LIBS winpr-tools)
target_link_libraries(${MODULE_NAME} ${${MODULE_PREFIX}_LIBS} winpr)
set(MANPAGE_NAME ${MODULE_NAME})
if (WITH_BINARY_VERSIONING)
set_target_properties(${MODULE_NAME} PROPERTIES OUTPUT_NAME "${MODULE_NAME}${WINPR_API_VERSION}${CMAKE_EXECUTABLE_SUFFIX}")
set_target_properties(${MODULE_NAME}
PROPERTIES
OUTPUT_NAME "${MODULE_NAME}${WINPR_API_VERSION}${CMAKE_EXECUTABLE_SUFFIX}"
)
set(MANPAGE_NAME ${MODULE_NAME}${WINPR_API_VERSION})
endif()
set_property(TARGET ${MODULE_NAME} PROPERTY FOLDER "WinPR/Tools")
@@ -54,5 +59,5 @@ if (WITH_DEBUG_SYMBOLS AND MSVC)
install(FILES ${CMAKE_PDB_BINARY_DIR}/${MODULE_NAME}.pdb DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT symbols)
endif()
configure_file(winpr-makecert.1.in ${CMAKE_CURRENT_BINARY_DIR}/winpr-makecert.1)
install_freerdp_man(${CMAKE_CURRENT_BINARY_DIR}/winpr-makecert.1 1)
configure_file(winpr-makecert.1.in ${CMAKE_CURRENT_BINARY_DIR}/${MANPAGE_NAME}.1)
install_freerdp_man(${CMAKE_CURRENT_BINARY_DIR}/${MANPAGE_NAME}.1 1)

View File

@@ -2,11 +2,11 @@
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH winpr\-makecert 1 2017-01-11 "@WINPR_VERSION_FULL@" "FreeRDP"
.TH @MANPAGE_NAME@ 1 2017-01-11 "@WINPR_VERSION_FULL@" "FreeRDP"
.SH NAME
winpr\-makecert \- A tool to create X.509 certificates.
@MANPAGE_NAME@ \- A tool to create X.509 certificates.
.SH SYNOPSIS
.B winpr\-makecert
.B @MANPAGE_NAME@
[\fB-rdp\fP]
[\fB-silent\fP]
[\fB-live\fP]
@@ -21,15 +21,15 @@ winpr\-makecert \- A tool to create X.509 certificates.
[\fB-path\fP outputpath]
[outputname]
.SH DESCRIPTION
.B winpr-makecert
.B @MANPAGE_NAME@
is a tool for generating X.509 certificates modeled after the Windows command
MakeCert. winpr-makecert aims to be command line compatible with MakeCert
MakeCert. @MANPAGE_NAME@ aims to be command line compatible with MakeCert
however not all options are supported or implemented yet.
Unimplemented features are not described here. They are marked as "Unsupported"
in winpr-makecerts help.
in @MANPAGE_NAME@s help.
In contrast to it's Windows counterpart winpr\-makecert does, unless the
In contrast to it's Windows counterpart @MANPAGE_NAME@ does, unless the
\fB\-live\fP option is given, always creates and save a certificate.
If \fIoutputname\fP isn't set it is tried to determine the host name of the
computer the command is run on.
@@ -88,14 +88,14 @@ A directory where the certificate should be created in.
The base name of the created file(s). A suffix, the format specific suffix is
appended to this name.
.SH EXAMPLES
winpr-makecert -rdp
@MANPAGE_NAME@ -rdp
Creates a certificate with the default properties, saved to a file in the
current working directory in crt format named like the host. If the host is
named freerdp the created files are called freerdp.key and freerdp.crt.
winpr-makecert -len 4096 -a sha384 -path /tmp -# 22 -m 144 -y 1 -format crt mycert
@MANPAGE_NAME@ -len 4096 -a sha384 -path /tmp -# 22 -m 144 -y 1 -format crt mycert
The command above creates the file /tmp/mycert.pem containing a key and a
certificate with a length of 4096. It will use sha384 as hash algorithm.