Add a manpage for the csync commandline client.

This commit is contained in:
Andreas Schneider 2008-07-02 19:02:27 +02:00
Родитель f54b36fe7a
Коммит 67efe90536
3 изменённых файлов: 131 добавлений и 0 удалений

Просмотреть файл

@ -0,0 +1,56 @@
# - macro_asciidoc2man(inputfile outputfile)
#
# Create a manpage with asciidoc.
# Example: macro_asciidoc2man(foo.txt foo.1)
#
# Copyright (c) 2006, Andreas Schneider, <mail@cynapses.org>
#
# Redistribution and use is allowed according to the terms of the BSD license.
# For details see the accompanying COPYING-CMAKE-SCRIPTS file.
macro(MACRO_ASCIIDOC2MAN _a2m_input _a2m_output)
find_program(A2X
NAMES
a2x
)
#message("+++ A2X: ${A2X}")
if (A2X)
#message("+++ ${A2X} --doctype=manpage --format=manpage --destination-dir=${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/${_a2m_input}")
execute_process(
COMMAND
${A2X} --doctype=manpage --format=manpage --destination-dir=${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/${_a2m_input}
INPUT_FILE
${CMAKE_CURRENT_SOURCE_DIR}/${_a2m_input}
OUTPUT_FILE
${CMAKE_CURRENT_BINARY_DIR}/${_a2m_output}
RESULT_VARIABLE
A2M_MAN_GENERATED
ERROR_QUIET
)
#message("+++ A2M_MAN_GENERATED: ${A2M_MAN_GENERATED}")
if (A2M_MAN_GENERATED EQUAL 0)
find_file(A2M_MAN_FILE
NAME
${_a2m_output}
PATHS
${CMAKE_CURRENT_BINARY_DIR}
NO_DEFAULT_PATH
)
if (A2M_MAN_FILE)
get_filename_component(A2M_MAN_CATEGORY ${A2M_MAN_FILE} EXT)
string(SUBSTRING ${A2M_MAN_CATEGORY} 1 1 A2M_MAN_CATEGORY)
install(
FILES
${A2M_MAN_FILE}
DESTINATION
${MAN_INSTALL_DIR}/man${A2M_MAN_CATEGORY}
)
endif (A2M_MAN_FILE)
endif (A2M_MAN_GENERATED EQUAL 0)
endif (A2X)
endmacro(MACRO_ASCIIDOC2MAN _a2m_input _a2m_file)

Просмотреть файл

@ -19,3 +19,6 @@ include("${CMAKE_MODULE_PATH}/UseDoxygen.cmake" OPTIONAL)
# endforeach(_html_FILE ${html_FILES})
#endif (DOXYGEN_FOUND)
include(UseAsciidoc)
macro_asciidoc2man(csync.txt csync.1)

72
doc/csync.txt Normal file
Просмотреть файл

@ -0,0 +1,72 @@
csync(1)
========
NAME
----
csync - A commandline frontent for csync a user level bidirectional file
synchronizer.
SYNOPSIS
--------
*csync* ['OPTION'...] 'SOURCE' 'DESTINATION'
DESCRIPTION
-----------
foobar
OPTIONS
-------
*--create-journal*::
Run update detection and write the journal
(TESTING ONLY!)
*-d, --disable-journal*::
Disable the usage and creation of a journal.
*--exclude-file='<file>'*::
Add an additional exclude file
*-r, --reconcile*::
Run update detection and reconcilation
*-u, --update*::
Run only the update detection
*-?, --help*::
Print the help list
*-V, --version*::
Print program version
EXIT STATUS
-----------
*0*::
Success
*1*::
Failure (syntax or usage error; configuration error;
unexpected error).
BUGS
----
Please report bugs at https://dev.csync.org/.
SEE ALSO
--------
*libcsync*(7)
AUTHORS
-------
Andreas Schneider <mail@cynapses.org>
COPYING
-------
Copyright \(c) 2006-2008 Andreas Schneider. Free use of this software is
granted under the terms of the GNU General Public License (GPL).