gtg team mailing list archive

[Bertrand Rousseau <bertrand.rousseau@xxxxxxxxx>]

Bertrand Rousseau has proposed merging lp:~bertrand-rousseau/gtg/bugfix-897425-man-pages into lp:gtg.

Requested reviews:
  Gtg developers (gtg)

For more details, see:
https://code.launchpad.net/~bertrand-rousseau/gtg/bugfix-897425-man-pages/+merge/119878

Update man pages, add a new man page for gtcli. Fix for bug #897425: Wite manpage for gtcli and update other manpages as well
-- 
https://code.launchpad.net/~bertrand-rousseau/gtg/bugfix-897425-man-pages/+merge/119878
Your team Gtg developers is requested to review the proposed merge of lp:~bertrand-rousseau/gtg/bugfix-897425-man-pages into lp:gtg.

=== modified file 'CHANGELOG'
--- CHANGELOG	2012-08-15 15:27:04 +0000
+++ CHANGELOG	2012-08-16 09:57:26 +0000
@@ -48,7 +48,11 @@
     * Fix for bug #1027844: Fuzzy date shouldn't become start date
     * Save backups into backup/ folder, creates backups of tags.xml closes #993920
     * Search filter is deleted on empty search if tag_pane is closed, by Stefan Handschuh, closes #996236
+<<<<<<< TREE
     * Pickle files for synchronization services are backuped to prevent loosing files, closes #1036554
+=======
+    * Fix for bug #897425: Write manpage for gtcli and update other manpages as well
+>>>>>>> MERGE-SOURCE
 
 2012-02-13 Getting Things GNOME! 0.2.9
     * Big refractorization of code, now using liblarch

=== added file 'doc/gtcli.1'
--- doc/gtcli.1	1970-01-01 00:00:00 +0000
+++ doc/gtcli.1	2012-08-16 09:57:26 +0000
@@ -0,0 +1,58 @@
+.TH gtgcli 1 2012-08-16 "gtgcli"
+.SH NAME
+gtcli \-  Command-line interface for Getting Things GNOME!
+.SH SYNOPSIS
+.B gtgcli [options] COMMAND [command options]
+.SH DESCRIPTION
+gtgcli provides a handy command-line interface to GTG. It allows to list and
+modify your task directly from the command line. It also allows to interact
+with GTG using shell scripts.
+.SH OPTIONS
+.TP
+\fB-h, --help\fB
+Prints some information about gtg's usage and options.
+.SH COMMAND OPTIONS
+.TP
+\fBnew\fB
+Creates a new task.
+.TP
+\fBshow <tid>\fB
+Display task with <tid> task ID.
+.TP
+\fBedit <tid>\fB
+Opens the GUI editor for the task with <tid> task ID.
+.TP
+\fBdelete <tid>\fB
+Removes task with <tid> task ID.
+.TP
+\fBlist [all|today|<filter>|<tag>]\fB
+List tasks corresponding to the given attributes.
+.TP
+\fBsearch <expression>\fB
+Search tasks corresponding to <expression>. Read the documentation from GTG's
+help to know more about the search query syntax.
+.TP
+\fBcount [all|today|<filter>|<tag>]\fB
+Outputs the task count for all the task corresponding to the given attributes.
+.TP
+\fBsummary [all|today|<filter>|<tag]\fB
+Report how many tasks starting/due each day.
+.TP
+\fBpostpone <tid> <date>\fB
+Updates the start date of the task with <tid> task id to <date>.
+.TP
+\fBclose <tid>\fB
+Sets state of task identified by <tid> to done.
+.TP
+\fBbrowser [hide|show]\fB
+Hides or shows the task browser window.
+.SH "SEE ALSO"
+gtg (1)
+.SH BUGS
+Please report any bug you may experience to the \fBGTG\fP Developers, that can
+be reached at \fRhttps://edge.launchpad.net/gtg\fP
+.SH COPYRIGHT
+This manual page is Copyright 2012 Bertrand Rousseau
+<bertrand.rousseau@xxxxxxxxx>. Permission is granted to copy, distribute
+and/or modify this document under the terms of the GNU General Public License,
+Version 3 or any later version published by the Free Software Foundation.

=== modified file 'doc/gtg.1'
--- doc/gtg.1	2012-05-23 08:55:31 +0000
+++ doc/gtg.1	2012-08-16 09:57:26 +0000
@@ -1,36 +1,52 @@
-.TH gtg 1 2009-03-21 "gtg"
+.TH gtg 1 2012-08-16 "gtg"
 .SH NAME
-gtg \-  Getting Things Gnome!, an organizer for the GNOME desktop
+gtg \-  Getting Things GNOME!, a personal tasks and TODO-list items organizer
+for the GNOME desktop environment
 .SH SYNOPSIS
-.B gtg [-d]
+.B gtg [options]
 .SH DESCRIPTION
-Getting Things GNOME! is an organizer for the GNOME desktop environment.
-GTG focuses on usability and ease of use. Its main objective is to
-provide a simple and yet flexible organization tool for life and work.
+Getting Things GNOME! is a personal tasks and TODO-list items organizer for the
+GNOME desktop environment inspired by the Getting Things Done (GTD)
+methodology. GTG is designed with flexibility, adaptability, and ease of use
+in mind so it can be used as more than just GTD software.
+.PP
+GTG is intended to help you track everything you need to do and need to know,
+from small tasks to large projects.
 .PP
 GTG uses a very handy system for creating and editing tasks. The task editor
 can automatically recognize metadata such as tags and subtasks through the use
 of a very simple syntax.
 .SH OPTIONS
 .TP
-\fB-b\fB
+\fB-b, --boot-test\fB
 Boot-up only.  Causes gtg to exit immediately after completing the first
 iteration of the main loop.  Useful for boot performance testing work.
 .TP
-\fB-c\fB
+\fB-c, --no-crash-handler\fB
 Disable crash handler.  Causes the Apport automatic crash reporting
 utility to not be invoked when gtg crashes; instead it will print out a
 normal python backtrace.  This can be useful for debugging crash bugs,
 or if the crash handler is misbehaving.
 .TP
-\fB-d\fB
+\fB-d, --debug\fB
 Debug mode.  Prints extra information to the console which may be useful
 for understanding and reporting bugs.
 .TP
-\fB-v\fB
+\fB-h, --help\fB
+Prints some information about gtg's usage and options.
+.TP
+\fB-l, --local-liblarch\fB
+Use local liblarch. Look for the liblarch python library in ../liblarch.
+This is mainly useful for testing purpose.
+.TP
+\fB-t TITLE, --title=TITLE\fB
+Set the window's title to TITLE.
+.TP
+\fB-v, --version\fB
 Prints version and exits.
 .SH COPYRIGHT
-This manual page is Copyright 2009 Luca Falavigna <dktrkranz@xxxxxxxxxx>.
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU General Public License, Version 3 or any later
-version published by the Free Software Foundation.
+This manual page is Copyright 2009, 2012 Luca Falavigna <dktrkranz@xxxxxxxxxx>
+and Bertrand Rousseau <bertrand.rousseau@xxxxxxxxx>. Permission is granted
+to copy, distribute and/or modify this document under the terms of the GNU
+General Public License, Version 3 or any later version published by the Free
+Software Foundation.

=== modified file 'setup.py'
--- setup.py	2012-07-23 12:26:06 +0000
+++ setup.py	2012-08-16 09:57:26 +0000
@@ -88,7 +88,7 @@
     # misc
     data_files.append(('share/applications', ['gtg.desktop']))
     data_files.append(('share/dbus-1/services', ['org.gnome.GTG.service']))
-    data_files.append(('share/man/man1', ['doc/gtg.1', 'doc/gtg_new_task.1']))
+    data_files.append(('share/man/man1', ['doc/gtg.1', 'doc/gtcli.1', 'doc/gtg_new_task.1']))
 
     # bash completion
     data_files.append(('share/gtg/', ['gtcli_bash_completion']))