Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

This check-in constitutes the release of version 0.2

- freesitemgr
   - more intelligent recovery from node failures
   - added '-C' option to suit crontab placement


git-svn-id: file:///home/toad/git-migration/temprepository/trunk/apps/pyFreenet@9219 67a373e5-eb02-0410-a15c-ee090a768436
  • Loading branch information...
commit 1a502cd74dcc272a23c1a72eebfe79b741007193 1 parent 40c6c4e
David McNab authored
View
4 AUTHORS
@@ -1,5 +1,5 @@
-The PyFCP modules and scripts were written
-by David McNab (aum) in May, 2006.
+The PyFCP applications and library were written
+by David McNab (aum) in May-June, 2006.
Contact the author at:
david@freenet.org.nz
View
12 BUGS
@@ -1,5 +1,13 @@
Bugs:
- - no support for persistent operations
- - probably heaps of other bugs
+ - no major bugs known at this stage
+ - minor bug where freesitemgr sometimes barfs with an exception when
+ it exits (but this should not adversely affect freesitemgr's functionality)
+
+If you find a bug, please post it to the Freenet bug tracker at:
+
+ https://bugs.freenetproject.org/bug_report_page.php
+
+but first please be sure to target the 'pyFreenet' project, by selecting
+'pyFreenet' in the combobox on the top-right of the page.
View
8 CHANGELOG
@@ -1,6 +1,12 @@
Revision history for PyFCP
+- Version 0.2
+
+ - added another layer of recovery to freesitemgr, to re-submit
+ jobs the node forgets about (ie, losts from its queue)
+ - added '-C' option to freesitemgr, to suit its use in crontab entries
+
- Version 0.1.8
- another rework of freesitemgr:
@@ -13,7 +19,7 @@ Revision history for PyFCP
- Version 0.1.7
- rewrote most of freesitemgr:
- - now uses directory ~/.freesites/
+ - now uses directory ~/.freesitemgr/
- keeps track of all inserts
- if interrupted, or if node dies, will resume where
it left off
View
8 CREDITS
@@ -0,0 +1,8 @@
+Profuse thanks are due to the following people:
+
+ - e1ven (e2ven) for support, patience, and torture-testing freesitemgr
+ with large freesites
+
+ - nextgens for encouraging me to get freesitemgr using the freenet
+ node global queue
+
View
4 INSTALL
@@ -3,12 +3,14 @@ INSTALL file for PyFCP
System requirements:
This package requires:
+
- Python2.3 or later
- access to a freenet FCP port, on same or other machine
+
- third party module 'SSLCrypto' (source included here) (optional)
- OpenSSL libraries and headers (optional)
-Installation:
+Installation: (if not wanting freedisk crypto, skip to step 4)
1) Ensure libopenssl and libopenssl-dev are installed
View
28 README
@@ -1,22 +1,26 @@
README file for PyFCP
-PyFCP is a Python client library for Freenet FCP that aims
-to be easy to use, yet flexible enough to accomodate a wide range
-of programming mind-sets.
+Now at version 0.2!
-This PyFCP release includes:
+PyFCP is a suite of command-line freenet applications, as well as a powerful
+Python library, for freenet 0.7.
- - python package 'fcp', containing:
- - 'node' - core FCP node interface
- - 'sitemgr' - freesite management class
- - 'xmlrpc' - freenet XML-RPC server
+This PyFCP release includes:
- - various command-line client apps, which will get installed as
+ - command-line freenet client applications, which will get installed as
executable commands in your PATH, including:
+
- freesitemgr - a simple yet flexible freesite management utility
- fcpget - a single key fetcher
- fcpput - a single key inserter
- fcpgenkey - a keypair generator
+ - fcpinvertkey - generate new SSK/USK keypairs
+ - fcpredirect - insert a redirect from one 'key' to another 'key'.
+
+ - an XML-RPC server for freenet access, which can be run standalone, or
+ easily integrated into an existing website
+
+ - python package 'fcp', containing classes for interacting with freenet.
To get good API documentation, run:
@@ -27,12 +31,8 @@ end up with a command 'freesitemgr' on your PATH.
'freesitemgr' is a console-based freesite insertion utility
which keeps your freesite configs and status in a single
-config file (~/.freesites, unless you specify otherwise).
+config file (~/.freesitemgr, unless you specify otherwise).
Invoke 'freesitemgr -h' (or if on windows, 'freesitemgr.py -h')
and read the options.
-To generate good html docs for the python API, run the command:
-
- epydoc -n "PyFCP API Manual" -o html fcp
-
View
19 manpages/freesitemgr.1
@@ -52,6 +52,18 @@ please do not set this to 0, 1 or 2.
\fB\-l\fR, \fB\-\-logfile=\fIlogfile\fR
location of logfile (default stdout)
+.TP
+
+\fB\-C\fR, \fB\-\-cron\fR
+Set options suitable for use of freesitemgr in your crontab.
+This will cause freesitemgr to output dated headers and set
+one verbosity level.
+
+For example, to run freesitemgr at 4am each day,
+you could put in your crontab:
+
+\fB0 4 * * * freesitemgr \-C update >> ~/freesitemgr.log\fR
+
.LP
@@ -68,9 +80,9 @@ interactively.
Add a new freesite interactively
.TP
-\fBlist \fIsitename\fP
+\fBlist \fIsitename [sitename...]\fP
display a summary of all freesites, or a
-detailed report of one site if <name> given
+detailed report of one or more site(s) if \fIsitename\fR given
.TP
\fBremove \fIsitename\fP [\fIsitename\fR...]
@@ -92,7 +104,8 @@ freesites will be updated. Otherwise, all freesites will be updated.
.TP
\fBcancel \fIsitename\fR [\fIsitename\fR...]
-Cancel the insertion of site \fIsitename\fR. Removes its entries
+Cancel the insertion of one or more
+site(s) \fIsitename\fR. Removes its entries
from the freenet node global queue, and reset its control file
back to an idle state.
View
20 manpages/freesitemgr.1.html
@@ -67,6 +67,17 @@
<DT><DD>
<B>-l</B>, <B>--logfile=</B><I>logfile</I>
location of logfile (default stdout)
+<DT><DD>
+<B>-C</B>, <B>--cron</B>
+Set options suitable for use of freesitemgr in your crontab.
+This will cause freesitemgr to output dated headers and set
+one verbosity level.
+<P>
+For example, to run freesitemgr at 4am each day,
+you could put in your crontab:
+<P>
+<B>0 4 * * * freesitemgr -C update &gt;&gt; ~/freesitemgr.log</B>
+<P>
<P>
</DL>
<P>
@@ -86,9 +97,9 @@
<B>add</B>
Add a new freesite interactively
<DT><DD>
-<B>list </B><I>sitename</I>
+<B>list </B><I>sitename [sitename...]</I>
display a summary of all freesites, or a
-detailed report of one site if &lt;name&gt; given
+detailed report of one or more site(s) if <I>sitename</I> given
<DT><DD>
<B>remove </B><I>sitename</I> [<I>sitename</I>...]
remove given freesite
@@ -107,7 +118,8 @@
freesites will be updated. Otherwise, all freesites will be updated.
<DT><DD>
<B>cancel </B><I>sitename</I> [<I>sitename</I>...]
-Cancel the insertion of site <I>sitename</I>. Removes its entries
+Cancel the insertion of one or more
+site(s) <I>sitename</I>. Removes its entries
from the freenet node global queue, and reset its control file
back to an idle state.
<P>
@@ -180,6 +192,6 @@
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
-Time: 02:09:06 GMT, June 14, 2006
+Time: 00:18:33 GMT, June 16, 2006
</BODY>
</HTML>
Please sign in to comment.
Something went wrong with that request. Please try again.