Skip to content

Commit

Permalink
Adds simple manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
jp-bennett committed Aug 8, 2016
1 parent 55d185e commit 148bc4a
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,29 @@ SET_TARGET_PROPERTIES(fwknop-gui PROPERTIES POSITION_INDEPENDENT_CODE ON)

target_link_libraries(fwknop-gui ${wxWidgets_LIBRARIES} ${LIBFKO_LIBRARIES} ${CURL_LIBRARIES} ${LIBQRENCODE_LIBRARIES} ${GPGME_VANILLA_LIBRARIES})
if(IS_LINUX)
find_program(A2X_EXECUTABLE NAMES a2x a2x.py)
set(A2X_OPTS
-D ${CMAKE_BINARY_DIR}
-d manpage
-f manpage
)

set(MAN_NAMES fwknop-gui.8)
set(MAN_FILES)
foreach(m IN LISTS MAN_NAMES)
set(mf ${CMAKE_BINARY_DIR}/${m})
set(ms ${CMAKE_SOURCE_DIR}/${m}.asciidoc)
add_custom_command(OUTPUT ${mf}
COMMAND ${A2X_EXECUTABLE} ${A2X_OPTS} ${ms}
DEPENDS ${ms}
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
COMMENT "Building manpage ${mf}"
VERBATIM)
list(APPEND MAN_FILES ${mf})
endforeach()

add_custom_target(man ALL DEPENDS ${MAN_FILES})

install(FILES help.html DESTINATION share/fwknop-gui)
install(TARGETS fwknop-gui DESTINATION bin)
install(PROGRAMS fwknop-gui.desktop DESTINATION share/applications)
Expand Down
36 changes: 36 additions & 0 deletions fwknop-gui.8.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
:man source: Fwknop-gui Client
:man manual: Fwknop-gui Client

FWKNOP-GUI(8)
=============

NAME
----
fwknop-gui - Firewall Knock Operator Graphical User Interface


SYNOPSIS
--------
*fwknop-gui*

DESCRIPTION
-----------
*fwknop-gui* provides a graphical interface to send SPA packets.

Supports AES and GPG encrypted SPA packets.

BUGS
----
To report a bug, please visit https://github.com/jp-bennett/fwknop-gui

SEE ALSO
--------
fwknop(8), fwknopd(8)

More information on Single Packet Authorization can be found in the paper
``Single Packet Authorization with fwknop'' available at
'http://www.cipherdyne.org/fwknop/docs/SPA.html'.

AUTHORS
-------
The primary developer of *fwknop-gui* is Jonathan Bennett <jbennett@incomsystems.biz>.

0 comments on commit 148bc4a

Please sign in to comment.