'\" t
.\"     Title: expireGititCache
.\"    Author: Giovanni Mascellani <gio@debian.org>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 09/04/2020
.\"    Manual: Gitit User Manual
.\"    Source: expireGititCache
.\"  Language: English
.\"
.TH "EXPIREGITITCACHE" "1" "09/04/2020" "expireGititCache" "Gitit User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
expireGititCache \- requests cache expiration for gitit pages
.SH "SYNOPSIS"
.HP \w'\fBexpireGititCache\fR\ 'u
\fBexpireGititCache\fR \fIgititUrl\fR \fIpage1\fR [\fIpage2\fR\ \fI\&.\&.\&.\fR]
.SH "DESCRIPTION"
.PP
\fBexpireGititCache\fR
requests to a
\fBgitit\fR\-powered wiki to expire the cache for specified pages\&. For example, is
\fIgititUrl\fR
is set to "http://localhost:5001" and
\fIpage1\fR
is "Main page\&.page", then
\fBexpireGititCache\fR
execute a POST request to the URL "http://localhost:5001/_expire/Front page"\&.
.SH "RETURNS"
.PP
\fBexpireGititCache\fR\*(Aqs return status is:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB0\fR
if the pages\*(Aq caches were successfully expired or if pages weren\*(Aqt cached in the first place);
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB1\fR
if fewer than two arguments were supplied;
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB3\fR
if the wiki engine responded with something different from 200 OK to the request;
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB5\fR
if
\fIgititUrl\fR
could not be parsed\&.
.RE
.sp
.SH "AUTHOR"
.PP
\fBGiovanni Mascellani\fR <\&gio@debian\&.org\&>
.RS 4
Wrote this manpage for the Debian system\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 Giovanni Mascellani
.br
.PP
This manual page was written for the Debian system (and may be used by others)\&.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or (at your option) any later version published by the Free Software Foundation\&.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in
/usr/share/common\-licenses/GPL\&.
.sp