diff --git a/doc/functions.sgm b/doc/functions.sgm index 6093c33..b65f8c0 100644 --- a/doc/functions.sgm +++ b/doc/functions.sgm @@ -14,8 +14,9 @@ The area function returns the area of a spherical object in square radians. Supported data types are: - scircle, spolygon (if the polygon - is convex), sbox, and smoc. + scircle, spolygon, sbox, + smoc. The polygon should be convex, otherwise the + behaviour is undefined. Area of a spherical circle as a multiple of &pg_pgr; @@ -25,6 +26,12 @@ + + + + + Area of a Multi-Order Coverage (MOC) object + SELECT area(smoc '0/1-3');]]> diff --git a/doc/install.sgm b/doc/install.sgm index f1c4b54..ded78fa 100644 --- a/doc/install.sgm +++ b/doc/install.sgm @@ -1,123 +1,100 @@ Installation - - - Download - - - pgSphere is not part of the PostgreSQL software. - You can download it from the pgSphere homepage - https://github.com/postgrespro/pgsphere - - + + Download - - - Installation - - - You will need PostgreSQL - 9.1 or above. We assume that you have - PostgreSQL already compiled and - installed. Please note: Depending on your system configuration mostly you have to be logged in as the system - superuser. - - - There are two ways to compile pgSphere. - The first is to copy the sources into the contribution directory of - PostgreSQL's source tree - (POSTGRESQL_SRC/src/contrib). - Then, change into POSTGRESQL_SRC/src/contrib. - If the sources are not yet installed and the directory - pg_sphere does not exist, take the - gzipped pgSphere sources ( e. g., - pg_sphere_xxx.tgz ) and run: - - - tar -xzf path/to/pg_sphere_xxx.tgz]]> - - - Now, change into the pg_sphere - directory and run : - - + + &pgsphere; is not the part of the &postgresql; software. You can download + the latest release from the + &pgsphere; Releases page. + The source code can also be downloaded by cloning the repository with the + appropriate release tag. The master branch is intended for development + use and may contain the code in a transitional state. It is not recommended + for use in production. + + + + + Install + + It is assumed that &postgresql; is already installed. Depending on the + system configuration, superuser (root) access rights may be required to + complete the installation. + + + + The installation script uses &pg_config; utility. Make sure that the + environment variable PATH includes path to &pg_config; utility. The path + to &pg_config; can be also specified in make command: + + make PG_CONFIG=/path/to/pgconfig ...]]> + + + + Unpack the downloaded archive and enter the directory: + + tar -xzf path/to/pgsphere-X.X.X.tgz]]> + cd pgsphere-X.X.X]]> + + + + Compile the code. By default, &pgsphere; is compiled with &healpix; support. + + make]]> - - - and to install pgSphere : - - + + or compile without &healpix; support: + + make USE_HEALPIX=0]]> + + + + Run regression tests optionally. If &pgsphere; was compiled without &healpix; + support, USE_HEALPIX=0 should be specified in make command line. + + + make test]]> + + + + Install &pgsphere; files to the installation directories. The installation + directories are defined by &pg_config; utility. Superuser (root) access + rights may be required. If &pgsphere; was compiled without &healpix; support, + USE_HEALPIX=0 should be added after make. + + make install]]> - - - The second way does not require the PostgreSQL sources but - the configuration tool pg_config. - - - First unpack the pgSphere sources: - - - tar -xzf path_to_pg_sphere_xxx.tgz]]> - - - Now, change into the pg_sphere - directory and run: - - - make USE_PGXS=1 PG_CONFIG=/path/to/pg_config]]> - - - To install pgSphere you have to run : - - - make USE_PGXS=1 PG_CONFIG=/path/to/pg_config install]]> - - - To check the installation change into the pg_sphere source - directory again and run: - - - make installcheck]]> - - - The check status will be displayed. Please note, the check gives different results with - different PostgreSQL-versions. Currently, the check should - run without errors with PostgreSQL-version 8.4. Otherwise check - the file regression.diff. - + + + + + + Configure Extension + + + We assume you have already created a database userdb, + where userdb is the name of any database. Assume that + the name of &postgresql;'s superuser is postgres. + + + psql -U postgres -c 'CREATE EXTENSION pg_sphere' userdb]]> + - + + It may be necessary to give more psql options, like port + or host name, depending on your system configuration. Please, take a look at + the psql user manual for details. The psql user manual for the latest + &postgresql; version can be found at + + &postgresql; site + . + - - - Creating a database with <application>pgSphere</application> - - - We assume you have already created a database - datab, where datab - is the name of any database. - Presupposing the name of your - PostgreSQL's superuser is - postgres, type: - - - psql -U postgres -c 'CREATE EXTENSION pg_sphere' datab]]> - - - Depending on your system, it may be necessary to give more - psql options like port or host name. - Please have a look at the - PostgreSQL documentation for more - details. - - - To get the version of installed pgSphere software, simply - call: - - + To get the version of installed &pgsphere; software: + SELECT pg_sphere_version();]]> - - + + diff --git a/doc/pg_sphere.xml b/doc/pg_sphere.xml index 1ca32a7..62cd79d 100644 --- a/doc/pg_sphere.xml +++ b/doc/pg_sphere.xml @@ -11,8 +11,6 @@ - - @@ -28,6 +26,11 @@ &ohgr;"> &OHgr;"> &pgr;"> +HEALPix"> +pgSphere"> +PostgreSQL"> +pg_config"> + ]>