Git commit 16f3dea35cab0050d02f3f401b70a6843f36e122 by Burkhard Lück. Committed on 05/06/2016 at 17:53. Pushed by lueck into branch 'master'.
update cervisia man page to 16.08 add docbook manpage remove current man page, outdated and untranslatable adapt doc/CMakeLists.txt REVIEW:128107 M +0 -9 CMakeLists.txt D +0 -217 cervisia.1.cmake M +1 -0 doc/CMakeLists.txt A +102 -0 doc/man-cervisia.1.docbook http://commits.kde.org/cervisia/16f3dea35cab0050d02f3f401b70a6843f36e122 diff --git a/CMakeLists.txt b/CMakeLists.txt index ace2432..abcd3e2 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -28,8 +28,6 @@ add_subdirectory( pics ) set(_KDECONFDIR_ ${CONFIG_INSTALL_DIR}) set(_KDEHTMLDIR_ ${HTML_INSTALL_DIR}) -configure_file(cervisia.1.cmake ${CMAKE_CURRENT_BINARY_DIR}/cervisia.1 @ONLY) - ########### next target ############### set(libcervisia_SRCS @@ -134,7 +132,6 @@ install(FILES org.kde.cervisiapart5.desktop DESTINATION ${SERVICES_INSTALL_DIR} install(FILES cervisiapart.kcfg DESTINATION ${KCFG_INSTALL_DIR} ) install(FILES cervisiaui.rc DESTINATION ${KXMLGUI_INSTALL_DIR}/cervisiapart ) install(FILES cervisiashellui.rc cervisia.notifyrc DESTINATION ${KXMLGUI_INSTALL_DIR}/cervisia ) -install(FILES ${CMAKE_CURRENT_BINARY_DIR}/cervisia.1 DESTINATION ${MAN_INSTALL_DIR}/man1) ecm_install_icons(ICONS 16-apps-cervisia.png @@ -145,10 +142,4 @@ ecm_install_icons(ICONS THEME hicolor ) - - -#cervisia.1.in: cervisia.pod -# pod2man --center "Cervisia" --release "${CERVISIA_VERSION}" \ -# cervisia.pod > cervisia.1.in - feature_summary(WHAT ALL FATAL_ON_MISSING_REQUIRED_PACKAGES) diff --git a/cervisia.1.cmake b/cervisia.1.cmake deleted file mode 100644 index 161f556..0000000 --- a/cervisia.1.cmake +++ /dev/null @@ -1,217 +0,0 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 -.\" -.\" Standard preamble: -.\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Vb \" Begin verbatim text -.ft CW -.nf -.ne \\$1 -.. -.de Ve \" End verbatim text -.ft R -.fi -.. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' -.ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" -. ds C` "" -. ds C' "" -'br\} -.el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' -'br\} -.\" -.\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index -.\" entries marked with X<> in POD. Of course, you'll have to process the -.\" output yourself in some meaningful fashion. -.if \nF \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" -.. -. nr % 0 -. rr F -.\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C -.\" ======================================================================== -.\" -.IX Title "CERVISIA 1" -.TH CERVISIA 1 "2007-04-29" "2.4.0" "Cervisia" -.SH "NAME" -Cervisia \- Graphical CVS frontend -.SH "SYNOPSIS" -.IX Header "SYNOPSIS" -\&\fBcervisia\fR - [\ \fB\-\-display\fR\ \fIdisplay\fR\ ] - [\ \fB\-\-caption\fR\ \fIcaption\fR\ ] - [\ \fB\-\-icon\fR\ \fIicon\fR\ ] - [\ \fB\-\-miniicon\fR\ \fIminiicon\fR\ ] - [\ \fB\-\-config\fR\ \fIfilename\fR\ ] - [\ \fB\-\-dcopserver\fR\ \fIserver\fR\ ] - [\ \fB\-\-nocrashhandler\fR\ ] - [\ \fB\-\-waitforwm\fR\ ] - [\ \fB\-\-style\fR\ \fIstyle\fR\ ] - [\ \fB\-\-geometry\fR\ \fIgeometry\fR\ ] - [\ \fB\-\-resolve\fR\ \fIfilename\fR\ ] - [\ \fB\-\-log\fR\ \fIfilename\fR\ ] - [\ \fB\-\-annotate\fR\ \fIfilename\fR\ ] - [\ \fIdirectory\fR\ ] -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -Cervisia is a graphical user interface for the Concurrent Versions -System. It is based on the \s-1KDE\s0 libraries and therefore shares -their Look'n'Feel, configuration and help system. -.SH "OPTIONS" -.IX Header "OPTIONS" -Cervisia accepts the following options: -.IP "\fIdirectory\fR" 4 -.IX Item "directory" -Tells Cervisia to open the sandbox in \fIdirectory\fR at startup -.IP "\fB\-\-resolve\fR \fIfilename\fR" 4 -.IX Item "--resolve filename" -Shows a resolve dialog for the given file -.IP "\fB\-\-log\fR \fIfilename\fR" 4 -.IX Item "--log filename" -Shows a log dialog for the given file -.IP "\fB\-\-annotate\fR \fIfilename\fR" 4 -.IX Item "--annotate filename" -Shows a annotation dialog for the given file -.IP "\fB\-\-caption\fR \fIcaption\fR" 4 -.IX Item "--caption caption" -Sets the caption, i. e. what is shown in the title bar -.IP "\fB\-\-icon\fR \fIicon\fR" 4 -.IX Item "--icon icon" -Sets the program's icon (used by window managers and panels) -.IP "\fB\-\-miniicon\fR \fIminiicon\fR" 4 -.IX Item "--miniicon miniicon" -Sets the program's mini icon (used by window managers and panels) -.IP "\fB\-\-config\fR \fIfilename\fR" 4 -.IX Item "--config filename" -Uses the given file for the configuration -.IP "\fB\-\-dcopserver\fR \fIserver\fR" 4 -.IX Item "--dcopserver server" -Sets the dcopserver the program should use -.IP "\fB\-\-nocrashhandler\fR" 4 -.IX Item "--nocrashhandler" -Disables the crash handler. Use this to get core dumps -.IP "\fB\-\-waitforwm\fR" 4 -.IX Item "--waitforwm" -Waits for a \s-1WM_NET\s0 compatible windowmanager -.IP "\fB\-\-style\fR \fIstyle\fR" 4 -.IX Item "--style style" -Sets the application \s-1GUI\s0 style -.IP "\fB\-\-geometry\fR \fIgeometry\fR" 4 -.IX Item "--geometry geometry" -Sets the geometry of the main window -.SH "FILES" -.IX Header "FILES" -\&\fI_KDECONFDIR_/cervisiarc\fR \- global configuration file -.Sp -\&\fI$HOME/.kde/share/config/cervisiarc\fR \- user-specific configuration file -.SH "SEE ALSO" -.IX Header "SEE ALSO" -\&\fI_KDEHTMLDIR_/en/cervisia/index.html\fR -.Sp -\&\fIcvs\fR\|(1) -.Sp -\&\fIhttp://cervisia.kde.org/\fR -.SH "AUTHOR" -.IX Header "AUTHOR" -Cervisia was originally developed by Bernd Gehrmann and is now maintained by -Christian Loose <[email protected]>. -.SH "REPORTING BUGS" -.IX Header "REPORTING BUGS" -Report bugs at http://bugs.kde.org. diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 3433f17..28657ad 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,2 +1,3 @@ ########### install files ############### kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR cervisia) +kdoctools_create_manpage (man-cervisia.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR}) diff --git a/doc/man-cervisia.1.docbook b/doc/man-cervisia.1.docbook new file mode 100644 index 0000000..3592623 --- /dev/null +++ b/doc/man-cervisia.1.docbook @@ -0,0 +1,102 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>Cervisia User's Manual</title> +<author><personname> +<firstname>Burkhard</firstname> +<surname>Lück</surname> +</personname> +<email>[email protected]</email></author> + +<date>2016-06-05</date> +<releaseinfo>3.11.0 (Applications 16.08)</releaseinfo> + +</refentryinfo> + +<refmeta> +<refentrytitle><command>cervisia</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>cervisia</command></refname> +<refpurpose>A CVS frontend by KDE</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>kaffeine</command> +<arg choice="opt"><option>--resolve <replaceable>file</replaceable></option></arg> +<arg choice="opt"><option>--log <replaceable>file</replaceable></option></arg> +<arg choice="opt"><option>--annotate <replaceable>file</replaceable></option></arg> +<arg choice="opt"><option><replaceable>directory</replaceable></option></arg> +</cmdsynopsis> +</refsynopsisdiv> + + +<refsect1> +<title>Description</title> +<para> +Cervisia is a user friendly version control system front-end. The aim is to support +CVS and other version control system programs in a unified interface, featuring conflict +resolution, difference and history viewers, status for the working copy files, and +support for most version control function</para> +</refsect1> + +<refsect1> +<title>Options</title> + +<variablelist> +<varlistentry> +<term><option>--resolve</option></term> +<listitem><para>Show resolve dialog for the given file.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--log</option></term> +<listitem><para>Show log dialog for the given file.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--annotate</option> <replaceable>file</replaceable></term> +<listitem><para>Show annotation dialog for the given file.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option><replaceable>directory</replaceable></option></term> +<listitem><para>The sandbox to be loaded.</para> +</listitem> +</varlistentry> + +</variablelist> +</refsect1> + +<refsect1> +<title>See Also</title> +<simplelist> +<member>More detailed user documentation is available from <ulink +url="help:/cervisia ">help:/cervisia</ulink> +(either enter this &URL; into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/cervisia</parameter></userinput>).</member> +<member>kf5options(1)</member> +<!--<member>qt5options(1)</member> only for application with a GUI FIXME use if we have an updated man page qt5options--> +<member>cvs(1)</member> +<member>There is also further information available at the +<ulink url="https://www.kde.org/applications/development/cervisia/";>Cervisia Page</ulink></member> +</simplelist> +</refsect1> + +<refsect1> +<title>Authors</title> +<para>To list the authors of Cervisia use <userinput><command>cervisia</command> <option>--author</option></userinput> in a terminal.</para> +</refsect1> + +</refentry> _______________________________________________ kde-doc-english mailing list [email protected] https://mail.kde.org/mailman/listinfo/kde-doc-english
