[rkward-cvs] SF.net SVN: rkward:[3594] trunk/rkward

tfry at users.sourceforge.net tfry at users.sourceforge.net
Mon May 23 08:55:12 UTC 2011 

Revision: 3594
          http://rkward.svn.sourceforge.net/rkward/?rev=3594&view=rev
Author:   tfry
Date:     2011-05-23 08:55:12 +0000 (Mon, 23 May 2011)

Log Message:
-----------
Supply man page in the rkward release, instead of the debian packaging.

Modified Paths:
--------------
    trunk/rkward/ChangeLog
    trunk/rkward/debian/changelog
    trunk/rkward/debian/rules
    trunk/rkward/doc/rkward/CMakeLists.txt

Added Paths:
-----------
    trunk/rkward/doc/rkward/man-rkward.1.docbook

Removed Paths:
-------------
    trunk/rkward/debian/rkward.1

Modified: trunk/rkward/ChangeLog
===================================================================
--- trunk/rkward/ChangeLog	2011-05-22 22:25:12 UTC (rev 3593)
+++ trunk/rkward/ChangeLog	2011-05-23 08:55:12 UTC (rev 3594)
@@ -1,4 +1,5 @@
 --- Version 0.5.6 - May-XX-2011
+- Add simple man page for command line options
 - Fixed: Potential crash when creating plots from a tcl/tk based GUI
 - Fix compilation on FreeBSD
 - Replace the R console's "Copy selection cleaned" action with "Copy commands, only", which will omit any non-command regions in the copy

Modified: trunk/rkward/debian/changelog
===================================================================
--- trunk/rkward/debian/changelog	2011-05-22 22:25:12 UTC (rev 3593)
+++ trunk/rkward/debian/changelog	2011-05-23 08:55:12 UTC (rev 3594)
@@ -4,7 +4,7 @@
   * remove empty directory removal rkwardtests/inst. Now fixed upstream.
   * remove man page links to rkward.bin and rkward.rbackend. These
     auxilliary binaries are no longer installed in the system path.
-  * no longer document removed command line option "--disable-stack-check"
+  * remove debian man page. Man page is now supplied upstream.
   * bump standards version to 3.9.2 (no changes needed)
 
  -- Thomas Friedrichsmeier <tfry at users.sourceforge.net>  Tue, 20 Mar 2011 15:30:00 +0200

Deleted: trunk/rkward/debian/rkward.1
===================================================================
--- trunk/rkward/debian/rkward.1	2011-05-22 22:25:12 UTC (rev 3593)
+++ trunk/rkward/debian/rkward.1	2011-05-23 08:55:12 UTC (rev 3594)
@@ -1,56 +0,0 @@
-.\"                                      Hey, EMACS: -*- nroff -*-
-.\" First parameter, NAME, should be all caps
-.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
-.\" other parameters are allowed: see man(7), man(1)
-.TH RKWARD 1 "14-09-2010"
-.\" Please adjust this date whenever revising the manpage.
-.\"
-.\" Some roff macros, for reference:
-.\" .nh        disable hyphenation
-.\" .hy        enable hyphenation
-.\" .ad l      left justify
-.\" .ad b      justify to both left and right margins
-.\" .nf        disable filling
-.\" .fi        enable filling
-.\" .br        insert line break
-.\" .sp <n>    insert n+1 empty lines
-.\" for manpage-specific macros, see man(7)
-.SH NAME
-rkward \(hy A KDE frontend to R
-.SH SYNOPSIS
-.B rkward
-.RI [ options ] " [file]"
-.SH DESCRIPTION
-This manual page documents briefly the
-.B rkward
-command.
-.PP
-.SH OPTIONS
-A summary of options is included below.
-For a complete description, invoke rkward \-\-help or refer to http://rkward.sourceforge.net .
-.TP
-.B \-\-help
-Show summary of options.
-.TP
-.B \-v, \-\-version
-Show version of program.
-.TP
-.B \-\-evaluate <Rcode>
-The given R code is evaluated after RKWard has started, and after any specified workspace is loaded. Mostly useful for automated testing.
-.TP
-.B \-\-debug-level <level>
-Verbosity of debug output. 0-5, where 0 is no output, 5 is all output including function trace information. Default it 2
-.TP
-.B \-\-debug-flags <flags>
-Allows to configure, which sections of code to debug. Flags are given as a binary number. Refer to the source files for documentation, as this really is an internal option
-.TP
-.B \-\-debugger <command>
-Run RKWard through the specified debugger command. To add command line options to the debugger command, enclose them in single quotes ('') together with the command. NOTE: To use the \-\-debugger option, it must be specified as the first option on the command line.
-.SH SEE ALSO
-.BR R (1),
-.br
-.SH AUTHOR
-RKWard was written by Thomas Friedrichsmeier and the RKWard team. See http://rkward.sourceforge.net .
-.PP
-This manual page was written by Thomas Friedrichsmeier <tfry at users.sourceforge.net>,
-for the Debian project (but may be used by others).

Modified: trunk/rkward/debian/rules
===================================================================
--- trunk/rkward/debian/rules	2011-05-22 22:25:12 UTC (rev 3593)
+++ trunk/rkward/debian/rules	2011-05-23 08:55:12 UTC (rev 3594)
@@ -114,7 +114,7 @@
 	dh_installdocs
 	dh_installexamples
 	dh_installmenu
-	dh_installman debian/rkward.1
+	dh_installman $(CURDIR)/build/doc/rkward/rkward.1
 	dh_link
 	dh_strip
 	# do not compress KDE HTML help

Modified: trunk/rkward/doc/rkward/CMakeLists.txt
===================================================================
--- trunk/rkward/doc/rkward/CMakeLists.txt	2011-05-22 22:25:12 UTC (rev 3593)
+++ trunk/rkward/doc/rkward/CMakeLists.txt	2011-05-23 08:55:12 UTC (rev 3594)
@@ -1,4 +1,5 @@
 KDE4_CREATE_HANDBOOK (index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+KDE4_CREATE_MANPAGE (man-rkward.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR})
 
 ADD_CUSTOM_TARGET (webdocs
 	COMMAND meinproc4 --stylesheet ${DATA_INSTALL_DIR}/ksgmltools2/customization/kde-web.xsl ${CMAKE_CURRENT_SOURCE_DIR}/writing_plugins_introduction.docbook

Added: trunk/rkward/doc/rkward/man-rkward.1.docbook
===================================================================
--- trunk/rkward/doc/rkward/man-rkward.1.docbook	                        (rev 0)
+++ trunk/rkward/doc/rkward/man-rkward.1.docbook	2011-05-23 08:55:12 UTC (rev 3594)
@@ -0,0 +1,82 @@
+<?xml version="1.0" ?>
+<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+<!ENTITY % English "INCLUDE">
+<!ENTITY rkward '<application>RKWard</application>'>
+<!ENTITY R '<application>R</application>'>
+]>
+
+<refentry lang="&language;">
+<refentryinfo>
+<firstname>Thomas</firstname>
+<surname>Friedrichsmeier</surname>
+<affiliation>
+<address><email>rkward-devel at lists.sourceforge.net</email></address>
+</affiliation>
+<date>2011-05-23</date>
+</refentryinfo>
+
+<refmeta>
+<refentrytitle><command>rkward</command></refentrytitle>
+<manvolnum>1</manvolnum>
+</refmeta>
+
+<refnamediv>
+<refname><command>rkward</command></refname>
+<refpurpose>A &kde; frontend to R</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>rkward</command>
+<arg choice="opt"><replaceable>workspace_file</replaceable></arg>
+<group choice="opt"><option>--evaluate</option> <replaceable> Rcode</replaceable></group>
+<group choice="opt"><option>--debug-level</option> <replaceable> level</replaceable></group>
+<group choice="opt"><option>--debug-flags</option> <replaceable> flags</replaceable></group>
+<group choice="opt"><option>--debugger</option> <replaceable> debugger_command</replaceable></group>
+<arg choice="opt">KDE Generic Options</arg>
+<arg choice="opt">Qt Generic Options</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+<title>Description</title>
+<para>&rkward; is the a &kde;-based GUI and IDE for the &R; scripting language for statistical computing.</para> 
+<para>For more information, please refer to <ulink url="http://rkward.sf.net/">the &rkward; website</ulink>, and the documentation provided inside &rkward;.</para>
+</refsect1>
+
+<refsect1>
+<title>Options</title>
+
+<variablelist>
+<varlistentry>
+<term><option>--evaluate</option> <replaceable>Rcode</replaceable></term>
+<listitem><para>The given &R; code is evaluated after &rkward; has started, and after any specified workspace is loaded. Mostly useful for automated testing.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>--debug-level</option> <replaceable>level</replaceable></term>
+<listitem><para>Verbosity of debug output. 0-5, where 0 is no output, 5 is all output including function trace information. Default it 2.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>--debug-flags</option> <replaceable>flags</replaceable></term>
+<listitem><para>Allows to configure, which sections of code to debug. Flags are given as a binary number. Refer to the source files for documentation, as this really is an internal option.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>--debugger</option> <replaceable>command</replaceable></term>
+<listitem><para>Run &rkward; through the specified debugger command. To add command line options to the debugger command, enclose them in single quotes ('') together with the command. <emphasis>NOTE:</emphasis> To use the \-\-debugger option, it must be specified as the first option on the command line. Only the frontend process will be debugged, using this option.</para></listitem>
+</varlistentry>
+</variablelist>
+
+</refsect1>
+
+<refsect1>
+<title>See Also</title>
+<para><citerefentry><refentrytitle>R</refentrytitle>
+<manvolnum>1</manvolnum></citerefentry></para>
+</refsect1>
+
+<refsect1>
+<title>Authors</title>
+<para>&rkward; was written by Thomas Friedrichsmeier and the &rkward; team. See <ulink url="http://rkward.sf.net/">the &rkward; website</ulink>.</para>
+</refsect1>
+
+</refentry>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

More information about the rkward-tracker mailing list