Documentation Update

- Added new 'task-faq' man page.
- Added references to the new man page in various places.

ChangeLog

@@ -42,6 +42,7 @@
    'calendar.calendar.overdue' and 'color.calendar.weekend'.
  + The coloring of due tasks in reports can now be enabled for all tasks, and not
     only the imminent ones, by setting the configuration variable due=0.
+ + Added a new 'task-faq' man page for common questions and answers.
  + Fixed bug #316 which caused the timesheet report to display an oddly sorted
    list.
  + Fixed bug #317 which colored tasks in the 'completed' report according to

Makefile.am

@@ -1,6 +1,6 @@
 SUBDIRS = src
 
-dist_man_MANS = doc/man/task.1 doc/man/taskrc.5 doc/man/task-tutorial.5
+dist_man_MANS = doc/man/task.1 doc/man/taskrc.5 doc/man/task-tutorial.5 doc/man/task-faq.5
 
 docdir = $(datadir)/doc/${PACKAGE}-${VERSION}
 doc_DATA = AUTHORS ChangeLog COPYING NEWS README

README

@@ -4,13 +4,12 @@ Thank you for taking a look at task!
 Task is a GTD, todo list, task management, command line utility with a multitude
 of features.  It is a portable, well supported, very active project, and it is
 Open Source.  Task has binary distributions, online documentation, demonstration
-movies, and you'll find all the details at the site:
+movies, and you'll find all the details at:
 
     http://taskwarrior.org
 
 At the site you'll find a wiki, discussion forums, downloads, news and more.
 
-
 Your contributions are especially welcome.  Whether it comes in the form of
 code patches, ideas, discussion, bug reports, encouragement or criticism, your
 input is needed.

doc/man/task-faq.5

@@ -0,0 +1,63 @@
+.TH task-faq 5 2010-01-03 "task 1.9.0" "User Manuals"
+
+.SH WELCOME
+Welcome to the task FAQ.  If you have would like to see a question answered
+here, please send us a note at <support@taskwarrior.org>.
+
+.TP
+.B Where does task store the data?
+By default, task creates a .taskrc file in your home directory and populates it
+with defaults.  Task also creates a .task directory in your home directory and
+puts data files there.
+
+.TP
+.B Can I edit that data?
+Of course you can.  It is a simple text file, and looks somewhat like the JSON
+format, and if you are careful not to break the format, there is no reason not
+to edit it.  But task provides a rich command set to do that manipulation for
+you, so it is probably best to leave those files alone.
+
+
+
+
+
+
+
+
+
+
+
+
+.SH "CREDITS & COPYRIGHTS"
+task was written by P. Beckingham <paul@beckingham.net>.
+.br
+Copyright (C) 2006 \- 2010 P. Beckingham
+
+This man page was originally written by P. Beckingham.
+
+task is distributed under the GNU General Public License.  See
+http://www.gnu.org/licenses/gpl-2.0.txt for more information.
+
+.SH SEE ALSO
+.BR task(1),
+.BR taskrc(5),
+.BR task-tutorial(5)
+
+For more information regarding task, the following may be referenced:
+
+.TP
+The official site at
+<http://taskwarrior.org>
+
+.TP
+The official code repository at
+<http://github.com/pbeckingham/task/>
+
+.TP
+You can contact the project by writing an email to
+<support@taskwarrior.org>
+
+.SH REPORTING BUGS
+.TP
+Bugs in task may be reported to the issue-tracker at
+<http://taskwarrior.org>

doc/man/task-tutorial.5

@@ -391,7 +391,8 @@ http://www.gnu.org/licenses/gpl-2.0.txt for more information.
 
 .SH SEE ALSO
 .BR task(1),
-.BR taskrc(5)
+.BR taskrc(5),
+.BR task-faq(5)
 
 For more information regarding task, the following may be referenced:
 

doc/man/task.1

@@ -457,7 +457,8 @@ http://www.gnu.org/licenses/gpl-2.0.txt for more information.
 
 .SH SEE ALSO
 .BR taskrc(5),
-.BR task-tutorial(5)
+.BR task-tutorial(5),
+.BR task-faq(5)
 
 For more information regarding task, the following may be referenced:
 

doc/man/taskrc.5

@@ -496,7 +496,8 @@ http://www.gnu.org/licenses/gpl-2.0.txt for more information.
 
 .SH SEE ALSO
 .BR task(1),
-.BR task-tutorial(5)
+.BR task-tutorial(5),
+.BR task-faq(5)
 
 For more information regarding task, the following may be referenced:
 

src/command.cpp

@@ -443,8 +443,8 @@ int handleVersion (std::string &outs)
   link.setColumnWidth (0, Table::flexible);
   link.setColumnJustification (0, Table::left);
   link.addCell (link.addRow (), 0,
-    "Documentation for task can be found using 'man task', 'man taskrc', or "
+    "Documentation for task can be found using 'man task', 'man taskrc', "
-    "'man task-tutorial' at http://taskwarrior.org");
+    "'man task-tutorial', 'man task-faq' or at http://taskwarrior.org");
 
   Color bold ("bold");
 

src/report.cpp

@@ -211,7 +211,7 @@ int shortUsage (std::string &outs)
   out << table.render ()
       << std::endl
       << "Documentation for task can be found using 'man task', 'man taskrc', "
-      << "or 'man task-tutorial' at http://taskwarrior.org"
+      << "'man task-tutorial', 'man task-faq' or at http://taskwarrior.org"
       << std::endl
       << std::endl;