<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre, #msg p { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }
#msg ul { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[800] trunk/alexandria: Added man page for the alexandria command,
including information</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd>800</dd>
<dt>Author</dt> <dd>cathalmagus</dd>
<dt>Date</dt> <dd>2007-12-01 01:23:18 -0500 (Sat, 01 Dec 2007)</dd>
</dl>
<h3>Log Message</h3>
<pre>Added man page for the alexandria command, including information
regarding description, options, files, environment variables, bugs,
authors and copyright and license.
Should also include GConf settings (see the Tomboy man page for example).
(Running 'man 7 man' gives a very good introduction to writing man
pages directly in nroff/groff format.)
Also modified the Rakefile so that the man page is installed by 'rake
install' and is included in the generated deb file.
--This line, and those below, will be ignored--
M Rakefile
M tasks.rb
A doc/alexandria.1</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkalexandriaRakefile">trunk/alexandria/Rakefile</a></li>
<li><a href="#trunkalexandriatasksrb">trunk/alexandria/tasks.rb</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkalexandriadocalexandria1">trunk/alexandria/doc/alexandria.1</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkalexandriaRakefile"></a>
<div class="modfile"><h4>Modified: trunk/alexandria/Rakefile (799 => 800)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/alexandria/Rakefile 2007-11-26 18:21:30 UTC (rev 799)
+++ trunk/alexandria/Rakefile 2007-12-01 06:23:18 UTC (rev 800)
</span><span class="lines">@@ -38,7 +38,7 @@
</span><span class="cx"> 'ChangeLog',
</span><span class="cx"> 'TODO']
</span><span class="cx"> b.rdoc.main = 'doc/README'
</span><del>-
</del><ins>+ b.doc.man_files = ['doc/alexandria.1']
</ins><span class="cx"> b.debinstall.staging_dir = 'debian/tmp'
</span><span class="cx"> end
</span><span class="cx">
</span></span></pre></div>
<a id="trunkalexandriadocalexandria1"></a>
<div class="addfile"><h4>Added: trunk/alexandria/doc/alexandria.1 (0 => 800)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/alexandria/doc/alexandria.1 (rev 0)
+++ trunk/alexandria/doc/alexandria.1 2007-12-01 06:23:18 UTC (rev 800)
</span><span class="lines">@@ -0,0 +1,120 @@
</span><ins>+.de URL
+\\$2 \(laURL: \\$1 \(ra\\$3
+..
+.if \n[.g] .mso www.tmac
+.TH ALEXANDRIA 1 "December 1, 2007" gnome "GNOME User's Manuals"
+.SH NAME
+alexandria \- a book collection manager
+
+.SH SYNOPSIS
+.B alexandria
+.I "[OPTIONS]"
+
+.SH DESCRIPTION
+.I Alexandria
+is a GNOME desktop application for managing book collections. It has a
+simple user interface which makes it easy to enter the details of your
+library, generally using Internet sources to find catalogue
+information for your books. It also enables you to create filtered
+views of your book collection based on details such as author,
+publisher etc.
+.LP
+When launched without any options the
+.I Alexandria
+main window opens and presents a view of your libraries, or if run
+for the first time creates a new library ready for you to add books
+either manually or with the help of providers of book information on
+the Internet.
+
+.SH OPTIONS
+.B \-\-debug
+ Print verbose debug information describing the operation of the
+ program. Useful for determining behaviour when a problem is
+ encountered. This also sets the logger level to DEBUG.
+.LP
+.B \-\-version
+ Show program version information and exit.
+.LP
+.B \-\-help
+ Show summary of options and exit. This also shows a great many
+ predefined options common to all GTK programs which are not
+ defined in this manual page.
+
+.SH FILES
+.B $HOME/.alexandria
+ The per-user configuration of
+.I Alexandria
+ is stored in this directory. Each the books in each library are
+ stored in a sub-directory with the library's name e.g. `My
+ Library'. Book files are stored in YAML format (a text-based data
+ format). They are named after the book's ISBN
+ e.g. 9780755322800.yaml The cover images are also named after with
+ book's ISBN, with the file extension .cover, although they are
+ usually JPEG format files. If a book has no ISBN, it's ID will be
+ a number generated from the book title.
+.LP
+.B $HOME/.alexandria/.smart_libraries
+ Smart Libraries are a filtered view of your book collection, and
+ are saved as YAML format files in this directory.
+
+.SH ENVIRONMENT
+.B LOGLEVEL
+ Setting this environment variable affects the level at which
+ messages will be logged. The log levels are cumulative, setting
+ the level to log information messages means it will also include
+ all warnings and error messages. Possible values are:
+.RS
+.LP
+.B FATAL
+Only log messages for fatal errors.
+.LP
+.B ERROR
+Log messages for all errors.
+.LP
+.B WARN
+Log warnings and errors.
+.LP
+.B INFO
+Also include information messages.
+.LP
+.B DEBUG
+Log everything, including debug messages.
+.RE
+.LP
+ The default level is
+.B WARN
+
+.SH BUGS
+Please report any bugs you find on the
+.URL "http://rubyforge.org/tracker/?group_id=205" "Tracker" " at RubyForge."
+Please check for any similar reports before reporting a new bug.
+.LP
+You can also discuss any problems you encounter with the
+.I Alexandria
+developers and other users by joining the
+.URL "http://rubyforge.org/mailman/listinfo/alexandria-list" "alexandria-list" " mailing list."
+
+.SH WEB SITE
+News, details of the development team and further documentation may be
+found on the
+.URL "http://alexandria.rubyforge.org/" "Alexandria web site" "."
+
+.SH AUTHOR
+Alexandria was originally written by Laurent Sansonetti. The current
+maintainer is Joseph Method <tristil@gmail.com>. For a full list of
+contributors, see the file AUTHORS in Alexandria's documentation.
+.LP
+This manual page was written by Cathal Mc Ginley
+<cathal.alexandria@gnostai.org>.
+
+.SH COPYRIGHT
+Copyright (C) 2004-2006 Laurent Sansonetti
+.LP
+Copyright (C) 2007 Alexandria Contributors
+
+.SH LICENSE
+.I Alexandria
+is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation; either version 2 of the
+License, or (at your option) any later version.
</ins></span></pre></div>
<a id="trunkalexandriatasksrb"></a>
<div class="modfile"><h4>Modified: trunk/alexandria/tasks.rb (799 => 800)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/alexandria/tasks.rb 2007-11-26 18:21:30 UTC (rev 799)
+++ trunk/alexandria/tasks.rb 2007-12-01 06:23:18 UTC (rev 800)
</span><span class="lines">@@ -75,6 +75,7 @@
</span><span class="cx"> attr_accessor :debinstall
</span><span class="cx"> attr_accessor :omf
</span><span class="cx"> attr_accessor :gettext
</span><ins>+ attr_accessor :doc
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx"> def initialize(name, version)
</span><span class="lines">@@ -88,6 +89,7 @@
</span><span class="cx"> @debinstall = DebianInstallConfig.new(self)
</span><span class="cx"> @omf = OMFConfig.new(self)
</span><span class="cx"> @gettext = GettextConfig.new(self)
</span><ins>+ @doc = DocConfig.new(self)
</ins><span class="cx">
</span><span class="cx"> yield self if block_given?
</span><span class="cx"> define_tasks
</span><span class="lines">@@ -303,6 +305,7 @@
</span><span class="cx"> default_groups.push(*icon_installation)
</span><span class="cx"> default_groups.push(*desktop_installation)
</span><span class="cx"> default_groups.push(*locale_installation)
</span><ins>+ default_groups.push(*manpage_installation)
</ins><span class="cx"> default_groups
</span><span class="cx"> end
</span><span class="cx">
</span><span class="lines">@@ -335,6 +338,11 @@
</span><span class="cx"> [['data', build.gettext.mo_files, sharedir, 0644]]
</span><span class="cx"> end
</span><span class="cx">
</span><ins>+ def manpage_installation
+ man_dir = File.join(File.join(sharedir, 'man'), 'man1')
+ [['doc', build.doc.man_files, man_dir, 0644]]
+ end
+
</ins><span class="cx"> def bindir
</span><span class="cx"> File.join(@prefix, 'bin')
</span><span class="cx"> end
</span><span class="lines">@@ -539,6 +547,13 @@
</span><span class="cx"> task :clobber => [:clobber_gettext]
</span><span class="cx"> end
</span><span class="cx">
</span><ins>+ class DocConfig < BuildConfig
+ attr_accessor :man_files
+ def initialize(build)
+ super(build)
+ end
+ end
+
</ins><span class="cx"> class GettextConfig < BuildConfig
</span><span class="cx"> attr_accessor :po_dir, :po_files_glob
</span><span class="cx"> attr_accessor :mo_dir, :mo_files_regex
</span></span></pre>
</div>
</div>
</body>
</html>