Document more accurately --debug option on Windows
authorRicardo Mones <ricardo@mones.org>
Fri, 5 Jun 2015 17:12:02 +0000 (19:12 +0200)
committerRicardo Mones <ricardo@mones.org>
Fri, 5 Jun 2015 17:12:02 +0000 (19:12 +0200)
Also add specific log file location, update copyright year
and manpage date, and fix all those unescaped hyphens.

doc/man/claws-mail.1

index 2792098..8b6bbba 100644 (file)
@@ -1,11 +1,11 @@
-.TH "CLAWS MAIL" "1" "January 13, 2014" "The Claws Mail team" "User Manuals"
+.TH "CLAWS MAIL" "1" "June  4, 2015" "The Claws Mail team" "User Manuals"
 
 .SH "NAME"
 .LP 
 Claws Mail \- a GTK+ based fast email and news client
 
 .SH "SYNOPSIS"
-.B claws-mail
+.B claws\-mail
 .RI [ options ]
 
 .SH "DESCRIPTION"
@@ -194,9 +194,6 @@ User\-defined address book custom attributes
 $HOME/.claws\-mail/claws.log
 Claws Mail logfile
 .TP 
-$HOME/.claws\-mail/claws-win32.log
-Claws Mail output file (Windows only)
-.TP 
 $HOME/.claws\-mail/clawsrc
 Main configuration file
 .TP 
@@ -241,6 +238,17 @@ User\-specified tag list
 .TP 
 $HOME/.claws\-mail/toolbar*.xml
 User\-defined custom toolbars
+.TP
+.B "Windows only"
+.LP
+.TP
+%TEMP%\\claws\-win32.log
+Claws Mail output file when \-\-debug is enabled. If %TEMP% is not set it
+defaults to windows directory (usually C:\\Windows) or C:\\ if windows
+directory is not available.
+.TP
+%APPDATA%\\Claws\-mail\\claws.log
+Claws Mail log file
 
 .SH "EXAMPLES"
 .LP 
@@ -326,7 +334,9 @@ display the help message and exit
 exit Claws Mail
 .TP 
 \fB\-\-debug\fR
-for debug mode
+for debug mode (on Windows systems output is written to a file instead
+of standard error output, see \fBWindows only\fR on \fBFILES\fR
+section)
 .TP 
 \fB\-\-toggle-debug\fR
 toggle debug mode of a running Claws Mail instance
@@ -359,16 +369,16 @@ GPG plugin preferences (this is usually set by the agent when launched,
 otherwise it likely means the GPG agent is not running)
 .TP
 \fBG_BROKEN_FILENAMES\fR
-assumes that filenames are in the locale encoding rather than in UTF-8
+assumes that filenames are in the locale encoding rather than in UTF\-8
 .TP
 \fBHOME\fR
 full path of the user's home directory
 .TP
 \fBLC_ALL\fR, \fBLC_CTYPE\fR, \fBLANG\fR
-locale to use for non-win32 systems (the first one not empty is used)
+locale to use for non\-windows systems (the first one not empty is used)
 .TP
 \fBPILOT_CHARSET\fR
-if defined overrides default J-Pilot charset (CP1252)
+if defined overrides default J\-Pilot charset (CP1252)
 .TP
 \fBPOSIXLY_CORRECT\fR
 if defined regular expressions matching follows POSIX standards
@@ -395,30 +405,30 @@ used to initialize default "user_id" preference in newly created accounts
 .TP
 You can search for existing bugs and report new ones on Claws Mail bugzilla:
 .br
-<http://www.thewildbeast.co.uk/claws-mail/bugzilla/>
+<http://www.thewildbeast.co.uk/claws\-mail/bugzilla/>
 
 .SH "COPYRIGHT"
 .LP
 .TP
-1999-2014 Hiroyuki Yamamoto and the Claws Mail team
+1999\-2015 Hiroyuki Yamamoto and the Claws Mail team
 .LP
 Portions are also Copyright:
 .br
-(C) 2007-2009 g10 Code GmbH
+(C) 2007\-2009 g10 Code GmbH
 .br
-(C) 1999-2005 Nullsoft, Inc.
+(C) 1999\-2005 Nullsoft, Inc.
 .br
-(C) 1991-1993, 1996-2000, 2001 Free Software Foundation, Inc.
+(C) 1991\-1993, 1996\-2000, 2001 Free Software Foundation, Inc.
 .br
 (C) 2001 Thomas Link, Hiroyuki Yamamoto
 .br
-(C) 1995-1997 Peter Mattis and Spencer Kimball
+(C) 1995\-1997 Peter Mattis and Spencer Kimball
 .br
-(C) 1995-1997 Peter Mattis, Spencer Kimball, Josh MacDonald
+(C) 1995\-1997 Peter Mattis, Spencer Kimball, Josh MacDonald
 .br
-(C) 1997-1998 Jay Painter <jpaint@serv.net><jpaint@gimp.org>
+(C) 1997\-1998 Jay Painter <jpaint@serv.net><jpaint@gimp.org>
 .br
-(C) 1999-2003 Michael Natterer <mitch@gimp.org>
+(C) 1999\-2003 Michael Natterer <mitch@gimp.org>
 .br
 (C) 2000 Evan Martin
 .br
@@ -426,19 +436,19 @@ Portions are also Copyright:
 .br
 (C) 2005, 2006, 2007, 2009 GNOME Foundation
 .br
-(C) 2004-2006 Christian Hammond
+(C) 2004\-2006 Christian Hammond
 .br
-(C) 2003-2004 Pawel Salek
+(C) 2003\-2004 Pawel Salek
 .br
-(C) 2001, 2002 - DINH Viet Hoa
+(C) 2001, 2002 \- DINH Viet Hoa
 .br
-(C) 1999-2000, Gael Roualland <gael.roualland@iname.com>
+(C) 1999\-2000, Gael Roualland <gael.roualland@iname.com>
 .br
-(C) 1998-2002 Sendmail, Inc.
+(C) 1998\-2002 Sendmail, Inc.
 .br
-(C) 2007-2008 Juha Kautto (juha at xfce.org)
+(C) 2007\-2008 Juha Kautto (juha at xfce.org)
 .br
-(C) 1994-2002 World Wide Web Consortium
+(C) 1994\-2002 World Wide Web Consortium
 .br
 (C) 1999 Graham Davison
 .br
@@ -446,7 +456,7 @@ Portions are also Copyright:
 .br
 (C) 2000, Eric Busboom, http://www.softwarestudio.org
 .br
-(C) 2002-2007 Randall Hand <yerase@yerot.com>
+(C) 2002\-2007 Randall Hand <yerase@yerot.com>
 .br
 (C) 2001 by Werner Koch <dd9jn@gnu.org>
 .br
@@ -456,9 +466,9 @@ Portions are also Copyright:
 .br
 (C) 2002  Red Hat, Inc.; Copyright 1998, 2001 Tim Janik
 .br
-(C) 2008-2009  Christian Hammond, David Trowbridge
+(C) 2008\-2009  Christian Hammond, David Trowbridge
 .br
-(C) 2003-2005  Lars Lindner <lars.lindner@gmx.net>
+(C) 2003\-2005  Lars Lindner <lars.lindner@gmx.net>
 .br
 (C) 2004,2005  Nathan J. Conrad <t98502@users.sourceforge.net>
 .br