summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNick White <git@njw.me.uk>2010-05-19 17:15:41 +0100
committerNick White <git@njw.me.uk>2010-05-19 17:15:41 +0100
commite91ec0d87aa31cb465fe8cf934d405ad56342eba (patch)
tree1709e437c0d8f144bec479975a777c6ae8580eba /doc
parent6cf58b46037cf04915fa507813ab7419db2e45ec (diff)
Switched to simpler build system, and fixed bugs
Now there's a proper build system in place, which is actually simple enough to understand. I also fixed plenty of warnings about the code (reminding me how badly I knew C when I wrote this). Hinduism today aren't indexing their new issues using the index file I was sourcing any more, so I don't expect to fix any more bugs or improve this much.
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/RELEASING45
-rw-r--r--doc/getht.man163
3 files changed, 0 insertions, 210 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
deleted file mode 100644
index 5ab40eb..0000000
--- a/doc/Makefile.am
+++ /dev/null
@@ -1,2 +0,0 @@
-man1_MANS = getht.man
-##doc_DATA = *.txt
diff --git a/doc/RELEASING b/doc/RELEASING
deleted file mode 100644
index 6260e96..0000000
--- a/doc/RELEASING
+++ /dev/null
@@ -1,45 +0,0 @@
-== PROCEDURE FOR MAKING A NEW RELEASE ==
-
-- Version Number -
-1. Set version number in build system
- configure.ac
-2. Tag current commit in git
- git-tag -s vX.X
- git-push --tags
-
-- Source Tarball -
-1. Create a clean tarball, and sign & checksum it
- ./prepare-release.sh
-2. Upload tarball & related files
- scp getht-*.tar.bz2* <user>@dl.sv.nongnu.org:/releases/getht/
-
-- Webpages -
-1. Get downloads webpage
- wget http://download.savannah.gnu.org/releases/getht/
-2. Add new version information
-3. Upload updated webpage
- scp index.html <user>@dl.sv.nongnu.org:/releases/getht/
-4. Take screenshot of new version
-5. Upload new screenshot
- cvs commit
-
-- Infrastructure -
-1. Add to new version option to bug tracker
- https://savannah.nongnu.org/bugs/admin/field_values.php?group_id=9005&list_value=1&field=release_id
-
-- Announcement -
-1. Post news to mailing list
- getht-general@nongnu
-2. Post news to Savannah
- https://savannah.nongnu.org/news/submit.php?group=getht
-3. Post new version to the following directories:
- Freshmeat: http://freshmeat.net/add-release/64475/
- IceWalkers: http://www.icewalkers.com/submit.php?ID=3035
- SourceWell: http://sourcewell.berlios.de/updapp.php?id=3655
-
-- Clean up -
-1. Delete local copy of release files
- rm index.html getht-*.tar.bz2*
-
-- Packaging -
-1. Update packages maintained
diff --git a/doc/getht.man b/doc/getht.man
deleted file mode 100644
index 4c4b5a7..0000000
--- a/doc/getht.man
+++ /dev/null
@@ -1,163 +0,0 @@
-.\" Copyright 2007,2008 Nick White
-.\"
-.\" This file is part of GetHT
-.\"
-.\" This is free documentation; 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 3 of the License, or
-.\" (at your option) any later version.
-.\"
-.\" The GNU General Public License's references to "object code"
-.\" and "executables" are to be interpreted as the output of any
-.\" document formatting or typesetting system, including
-.\" intermediate and printed output.
-.\"
-.\" This manual is distributed in the hope that it will be useful,
-.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-.\" GNU General Public License for more details.
-.\"
-.\" You should have received a copy of the GNU General Public License
-.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
-.TH GETHT 1
-.SH NAME
-.B GetHT
-\- The Free Hinduism Today Digital Edition Downloader
-.SH SYNOPSIS
-.TP 5
-\fBgetht
-\fI[-ualmofVvh] [-d issno] [-n medno] [-t tocfile] [-m medtocfile]\fR
-
-.SH DESCRIPTION
-.PP
-.I GetHT
-is a program which downloads pdf files from Hinduism
-Today. It has good proxy support, and is small, fast,
-and simple.
-
-.I GetHT
-is not endorsed by or affiliated with Hinduism Today.
-
-.SH OPTIONS
-.TP
-.B \-u, \-\-update
-Update the Hinduism Today contents files.
-.TP
-.B \-a, \-\-download-all
-Download all issues of Hinduism Today.
-.TP
-.B \-d, \-\-download-issue issno
-Download the issue numbered issno (use \fI-l\fR to find
-issue numbers).
-.TP
-.B \-f, \-\-force
-Force getht to download files, even if they have
-already been downloaded. This is useful if a download
-has been corrupted or interrupted.
-.TP
-.B \-l, \-\-list-issues
-List the issues of Hinduism Today, with issue numbers,
-sorted by date.
-.TP
-.B \-t, \-\-tocfile tocfile
-Use a different contents file, as specified by tocfile.
-.TP
-.B \-h, \-\-help
-Print a brief usage message.
-.TP
-.B \-v, \-\-verbose
-Make the output from \fI-l\fR and \fI-m\fR more verbose.
-May be used twice to make output yet more verbose.
-.TP
-.B \-V, \-\-version
-Display the version number.
-
-.SH CONFIGURATION FILE
-All of the settings for GetHT are stored in the
-configuration file, which normally resides in
-\fB~/.getht/config.ini\fR.
-
-The format of this file is very simple:
-\fB<option> = <setting>\fR
-with commented lines starting with a #
-
-The following options may be set.
-.TP
-.B savepath
-Stores the path in which all issues will be saved
-The default setting is \fB~/hinduism_today/\fR
-.TP
-.B startup_check
-Whether to automatically check for new issues each
-time the GetHT is executed. \fB1\fR = yes, \fB0\fR = no
-The default setting is \fB0\fR
-.TP
-.B toc_uri
-A uri to the xml file containing the table of contents
-for the publication.
-Default: \fBhttp://www.hinduismtoday.com/digital/htde_toc.xml\fR
-.TP
-.B proxy_type
-The type of proxy (if any) through which GetHT is to
-pass. GetHT currently supports the following options:
-\fBhttp\fR, \fBsocks4\fR, and \fBsocks5\fR.
-To not use any proxy, simply leave out this line.
-.TP
-.B proxy_address
-The uri of the proxy to connect through.
-.TP
-.B proxy_port
-The port of the proxy to connect to.
-.TP
-.B proxy_auth
-The method of authentication (if any) with the proxy.
-GetHT currently supports the following options:
-\fBbadic\fR, \fBdigest\fR, and \fBntlm\fR.
-If you don't need proxy authentication, leave out this
-line.
-.TP
-.B proxy_user
-The username with which to connect to the proxy server.
-.TP
-.B proxy_pass
-The password with which to connect to to proxy server.
-
-.SH FILES
-.TP
-.B ~/getht/config.ini
-configuration file.
-
-.SH BUGS
-.I GetHT
-is very new, so there will undoubtedly be some bugs
-around, or parts of the program which don't work as
-expected.
-
-If you encounter problems, there are several ways to
-get help:
-.TP
-.B Mailing List
-.I http://lists.nongnu.org/mailman/listinfo/getht-general
-.TP
-.B Bug Tracker
-.I http://savannah.nongnu.org/bugs/?func=additem&group=getht
-
-.SH LICENSE
-Copyright 2008 Nick White
-
-This program 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 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-.SH AUTHOR
-GetHT is at present primarily the work of Nick White, see the AUTHORS
-file for full credits and contact details.