1------------------------------------------------------------------------------
2
3	        Copyright (c) 2000-2006 All rights reserved
4	        Alberto Reggiori <areggiori@webweaving.org>
5		Dirk-Willem van Gulik <dirkx@webweaving.org>
6
7	           RDFStore - Perl API for RDF Storage
8
9		             Version 0.50
10
11------------------------------------------------------------------------------
12
13DESCRIPTION
14-----------
15
16RDFStore is a perl extension to manage RDF [1] data and information directly inside
17the perl environment.
18
19PREREQUISITES
20-------------
21
22To run RDFStore you need Perl and the following modules properly installed:
23
24    URI (which requires MIME::Base64)
25    DBI
26    XML::Parser (which requires expat)
27
28The package also need a BerkeleyDB installation, which generally comes with your default OS distribution and the
29build script should be able to identify and use. Differently you can download, compile and install a redent version
30of the BerkeleyDB software from the SleepyCat Web site http://www.sleepycat.com/ .
31
32INSTALLATION
33------------
34
35Try first the following steps:
36
37perl Makefile.PL
38make
39make test
40make install
41
42If it does not work, do not disperate and try the following two alternatives - generally
43compilation errors are due to mis-configuartion of the BerkleyDB parameters (include files, libraries
44and library name).
45
46a) Manual configuration
47-----------------------
48
491) Edit the configuration file in this directory named 'arch_conf.in' and change the settings to point to your
50   local BDB installation (or the one you want to compile in)
512) Run the 'perl Makefile.PL -v' command
523) Check that the compile paramters you inserted are actually seen by the system
534) Run the usal make sequence of commands as above
54
55b) Interactive configuration
56----------------------------
57
581) Run the 'perl Makefile.PL -i -v' command
59
60   Then you will get prompted to interactively insert the BDB parameters yourself, without requiring to edit the
61   above file by hand. Some basic checking is done on the values you insert.
622) Check that the compile paramters you inserted are actually seen by the system
633) Run the usal make sequence of commands as above
64
65Build the DBMS TCP/IP deamon
66----------------------------
67
68To build and install (optional) DBMS support:
69
70cd dbms
71make
72make test
73make install
74
75(by default the dbmsd get installed under the /RDFStore branch)
76
77Note that the DBMS configuration file dbms/arch.conf is autogenerated by the standard installation procedure above.
78If you decide to skip that and change directory directly to the dbms/ directory you might want to edit by hand the
79file dbms/arch.conf with your editor and changes the settings (read the comments in the makefile itself for help).
80
81Examples
82--------
83
84First have a look to utils/ directory which contains to very basic and useful programs:
85
86utils/rdf.pl
87
88	You can use it to parse, store and serialize your RDF data (see -h option about how to use it)
89
90utils/rdfquery.pl
91
92	You can use it to run general RDQL/Squish queries, either on existing databases (e.g. created with rdf.pl) or
93        query public URLs containing RDF/XML. It is also possible to run "remote" RDQL queries on a remote DBMS server
94	with a syntax simalr to the following:
95
96		SELECT
97			?title, ?link
98		FROM
99			<rdfstore://rss_database@myserver.mydomain.org:1234>
100		WHERE
101        		(?item, <rdf:type>, <rss:item>),
102        		(?item, <rss::title>, ?title),
103        		(?item, <rss::link>, ?link)
104		USING
105        		rdf for <http://www.w3.org/1999/02/22-rdf-syntax-ns#>,
106        		rss for <http://purl.org/rss/1.0/>
107
108utils/rdfdump.pl
109
110	Allows to dump the content of a given RDFStore as RDF/XML or N-Triples syntax. The output by default is sent to
111	the STDOUT - the total number of statements is also printed if the '-v' option is specified.
112
113		rdfdump.pl -syntax RDF/XML -storename test -dbms_host localhost
114
115	to dump the content of the 'test' database on the local dbmsd host (generally put under /RDFStore/dbms/te - to create
116	a new database see rdf.pl utility above)
117
118For more API specific examples look at the t/*.t perl scripts coming with the distribution and the samples/ directory.
119
120SEEK HELP
121---------
122
123Email <areggiori@webweaving.org> or <dirkx@webweaving.org> or emial/subscribe to rdfstore mailing list on yahoo groups
124rdfstore@yahoogroups.com and archived at http://groups.yahoo.com/group/rdfstore
125
126REFERENCES
127----------
128
129[1] http://www.w3.org/RDF
130[2] http://www.w3.org/TR/rdf-primer/
131[3] http://www.w3.org/TR/rdf-mt/
132[4] http://www.w3.org/TR/rdf-syntax-grammar/
133[5] http://www.w3.org/TR/rdf-schema/
134[6] http://www.w3.org/TR/rdf-testcases/
135[7] http://www.w3.org/TR/1999/REC-rdf-syntax-19990222/ (obsolete)
136[8] http://robustai.net/sailor/grammar/Quads.html
137
138That's all folks!
139
140$Id: INSTALL,v 1.8 2006/06/19 10:10:21 areggiori Exp $
141