Bugzilla – Attachment 5184 Details for
Bug 4877
Create and update the manual pages for the koha-* scripts.
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Proposed patch, updating the manual page for koha-create
0001-Update-man-page-for-koha-create.patch (text/plain), 7.30 KB, created by
Magnus Enger
on 2011-08-28 13:06:27 UTC
(
hide
)
Description:
Proposed patch, updating the manual page for koha-create
Filename:
MIME Type:
Creator:
Magnus Enger
Created:
2011-08-28 13:06:27 UTC
Size:
7.30 KB
patch
obsolete
>From 04734713f229e8799ae9693d485ef01d0390850f Mon Sep 17 00:00:00 2001 >From: Magnus Enger <magnus@enger.priv.no> >Date: Sun, 28 Aug 2011 15:02:09 +0200 >Subject: [PATCH] Update man page for koha-create > >--- > debian/scripts/koha-create.8 | 105 ++++++++++++++++++++++++++++++++++++++---- > 1 files changed, 96 insertions(+), 9 deletions(-) > >diff --git a/debian/scripts/koha-create.8 b/debian/scripts/koha-create.8 >index 618588f..65c8b2f 100644 >--- a/debian/scripts/koha-create.8 >+++ b/debian/scripts/koha-create.8 >@@ -12,12 +12,70 @@ > .\" > .\" You should have received a copy of the GNU General Public License > .\" along with this program. If not, see <http://www.gnu.org/licenses/>. >-.TH KOHA-CREATE 8 2010-05-03 Koha >+.\=========================================================== >+.TH KOHA-CREATE 8 "2011-08-28" "Koha" >+.\=========================================================== > .SH NAME >-koha-create \- create a new Koha instance >+koha-create \(em create a new Koha instance >+.\=========================================================== > .SH SYNOPSIS > .B koha-create >-.IR instance-name >+[ >+.B \-\^\-create-db|--request-db|--populate-db >+] >+[ >+.B \-\^\-marcflavor >+] >+[ >+.B \-\^\-zebralang >+] >+[ >+.B \-\^\-defaultsql >+] >+[ >+.B \-\^\-configfile >+] >+.IR instancename >+.\=========================================================== >+.SH OPTIONS >+.TP \w'\fB\-\^\-populate-db\fP'u+3n >+.B \-\^\-create-db >+Create a new datbase on localhost. If the database you want to use does >+not reside on localhost, you can use --request-db and --populate-db, see below. >+.\---------------------------------------------------------------------------------------------------------------------- >+.TP >+.B \-\^\-request-db >+This option will create a file called >+.IR instancename-db-request.txt >+in your current directory that contains information about >+how the database needs to be set up. >+.\---------------------------------------------------------------------------------------------------------------------- >+.TP >+.B \-\^\-populate-db >+When you have run koha-create with the --request-db option, and a database >+has been set up, you can finnish your installation by running koha-create >+with this option. >+.\---------------------------------------------------------------------------------------------------------------------- >+.TP >+.B \-\^\-configfile >+Path to an alternative config file. This file can hold the same variables as >+the default config file, see below for details. >+.\---------------------------------------------------------------------------------------------------------------------- >+.TP >+.B \-\^\-defaultsql >+Path to an SQL-file other than the one pointed to in the default or alternative >+config file. Corresponds to the DEFAULTSQL config file variable. >+.\---------------------------------------------------------------------------------------------------------------------- >+.TP >+.B \-\^\-marcflavor >+Specifies format of MARC records to be indexed by Zebra. Corresponds to the >+ZEBRA_MARC_FORMAT config file variable. >+.\---------------------------------------------------------------------------------------------------------------------- >+.TP >+.B \-\^\-zebralang >+Primary language for Zebra indexing. Corresponds to the ZEBRA_LANGUAGE >+config file variable. >+.\=========================================================== > .SH DESCRIPTION > .B koha-create > creates a new Koha instance. >@@ -25,20 +83,20 @@ It is meant for a site that provides Koha hosting, > and serves several sites from the same host. > .PP > The name of the instance is used as the domain name for Apache, >-and Unix user and group names, and MySQL username and table names >+Unix user and group names, and MySQL username and datbase names > are derived from it. > Unix user and group are named > .IR instance -koha. > MySQL username is > .RI koha_ instance , >-and table is >+and database is > .RI koha_ instance . > .PP > The Unix user has logins disabled. > The password for MySQL is generated randomly, and printed to the terminal. > .PP > The instance name is used as the domain name (ServerName) for Apache. >-The open catalog (OPAC), for library customers, is on port 80. >+The public catalog (OPAC), for library customers, is on port 80. > The librarian intranet interface is on port 8080. > .PP > After the Koha instance is created, it is ready to be used, >@@ -49,11 +107,13 @@ The variables are put into > .B /etc/koha/koha-site.conf . > The following variables are obeyed: > .PP >+.\---------------------------------------------------------------------------------------------------------------------- > .TP > .B DOMAIN > The domain to append to the instance name, for Apache ServerName. > Default is empty. > The value must begin with a period. >+.\---------------------------------------------------------------------------------------------------------------------- > .TP > .B INTRAPORT > The port for the intranet. >@@ -63,29 +123,55 @@ also define > .B INTRAPREFIX > or > .BR INTRASUFFIX . >+.\---------------------------------------------------------------------------------------------------------------------- > .TP > .B INTRAPREFIX > This is inserted before the instance name when forming Apache ServerName. > For subdomains, make sure it ends with a period. >+.\---------------------------------------------------------------------------------------------------------------------- > .TP > .B INTRASUFFIX > This is inserted after the instance name, > but before the domain name, > when forming Apache ServerName. >+.\---------------------------------------------------------------------------------------------------------------------- > .TP > .B DEFAULTSQL >-An SQL file (possibly compressed with gzip) that can be fed to >+An SQL file (compressed with gzip) that can be fed to > .BR mysql (1) > to initialize the database after it has been created. > Might be created using > .BR koha-dump-defaults (8). >+.\---------------------------------------------------------------------------------------------------------------------- >+.TP >+.B ZEBRA_MARC_FORMAT >+Specifies format of MARC records to be indexed by Zebra. Possible values are 'marc21', 'normarc' and 'unimarc'. >+.\---------------------------------------------------------------------------------------------------------------------- >+.TP >+.B ZEBRA_LANGUAGE >+Primary language for Zebra indexing. Possible values are 'en', 'fr' and 'nb'. >+.TP >+Order of precedence for config options, from lowest to highest: >+.RS >+.nf >+1. The defaults set in the code of koha-create >+2. /etc/koha/koha-sites.conf >+3. Config file specified with --configfile >+4. Individual command line options >+.fi >+.RE >+.\=========================================================== > .SH FILES > .TP > .B /etc/koha/koha-site.conf > Configuration variables are read from this file, if it exists. >+.\=========================================================== > .SH BUGS >-The program is a bit fragile. >-If something goes wrong, it does not clean up after itself. >+.TP >+The program is a bit fragile. If something goes wrong, it does not clean up after itself. >+.TP >+Bugs can be reported here: http://bugs.koha-community.org/bugzilla3/ >+.\=========================================================== > .SH EXAMPLE > To create a new Koha instance: > .PP >@@ -121,6 +207,7 @@ http://hslibrary-intra.example.com/ > .fi > .PP > Configuration changes only apply to instances created afterwards. >+.\=========================================================== > .SH "SEE ALSO" > .BR koha-remove (8). > .PP >-- >1.7.4.1 >
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 4877
:
5184
|
5196
|
5197
|
5205
|
5413
|
5433
|
5434
|
5435
|
5527
|
5920
|
6003