.\" You can view this file with:
.\" nroff -man [file]
.\" $Author: johntabularasa $
.\" $Id: gutenfetch_list_servers.3,v 1.1 2004/07/11 22:32:17 johntabularasa Exp $
.\"
.TH GUTENFETCH_LIST_SERVERS 3 "11 July 2004" "libgutenfetch 1.1"

.SH NAME
gutenfetch_list_servers \-\- List all available project gutenberg servers.

.SH SYNOPSIS
.B #include <gutenfetch.h>

.I gutenfetch_server_t **
.br
.B gutenfetch_list_servers(
.I gutenfetch_continent_t
);
.HP
typedef enum {
.br
NORTH_AMERICA,
.br
SOUTH_AMERICA,
.br
EUROPE,
.br
AFRICA,
.br
ASIA,
.br
AUSTRALASIA_OCEANIA,
.br
NUM_OF_CONTINENTS,
.br
ALL_CONTINENTS,
.br
UNKNOWN_CONTINENT
.P
} \fIgutenfetch_continent_t\fP;

.HP
typedef struct {
.br
char *host;
.br
char *name;
.br
char *area;
.br
gutenfetch_continent_t continent;
.P
} \fIgutenfetch_server_t\fP;

.SH DESCRIPTION
This function takes as a parameter a continent, one of \fINORTH_AMERICA\fP,
\fISOUTH_AMERICA\fP, \fIEUROPE\fP, \fIAFRICA\fP, \fIASIA\fP, \fIAUSTRALASIA_OCEANIA\fP or \fIALL_CONTINENTS\fP.  It then returns a NULL-terminated array of
\fBgutenfetch_server_t *\fP which match the supplied continent parameter.
This array must be freed when no longer in use by calling
\fIgutenfetch_free_servers()\fP.

.SH SEE ALSO
.B libgutenfetch (3),
.B gutenfetch_get_active_server (3),
.B gutenfetch_get_aussie_server (3),
.B gutenfetch_set_active_server (3),
.B gutenfetch_set_active_server_full (3),
.B gutenfetch_new_server (3),
.B gutenfetch_duplicate_server (3),
.B gutenfetch_free_server (3),
.B gutenfetch_free_servers (3)

.SH COPYRIGHT
libgutenfetch is Copyright (C) 2004 Russell Francis.

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 2 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, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

.SH BUGS
Probably, if you find them please take the time to let me know about
them by filling out a bug report at the following URL.
.TP
.B http://www.sourceforge.net/tracker/?group_id=104733&func=browse

.SH AUTHORS
Russell Francis <johntabularasa@users.sf.net>