Difference between revisions of "man"
(quoting "program files (x86" for windows) |
(Some adjustments) |
||
(9 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | {{DISPLAYTITLE: | + | {{DISPLAYTITLE:Starting GeneWeb and its components}} |
{{languages|man}} | {{languages|man}} | ||
{{toc right}} | {{toc right}} | ||
+ | |||
+ | GeneWeb's distribution comes with standard tools for starting GeneWeb in a minimal configuration. | ||
+ | To start Geneweb: | ||
+ | * start '''gwd'''. | ||
+ | * start '''gwsetup'''. | ||
+ | * open the '''START.html''' page with your preferred browser. | ||
+ | |||
+ | In the tree below, the scripts have extension {{c|.bat}} for Windows, and {{c|.command}} for macOS. | ||
+ | {{arbre début}} | ||
+ | * | ||
+ | ** {{d}} gw | ||
+ | ** {{f}} CHANGES.txt: [[changelog]] | ||
+ | ** {{s}} geneweb: (macOS only) launch script for gwsetup, gwd and START.html page in a single command. | ||
+ | ** {{s}} gwd: minimal launch script for gwd | ||
+ | ** {{s}} gwsetup: minimal launch script for gwsetup | ||
+ | ** {{f}} LICENSE.txt | ||
+ | ** {{f}} LIZEZMOI.txt | ||
+ | ** {{f}} README.txt | ||
+ | ** {{branche finale}}{{f}} START.htm : a minimal start page (assumes that gwd and gwsetup have been started) | ||
+ | {{arbre fin}} | ||
+ | |||
+ | Alternatively, you may launch the execution of the various components of GeneWeb with command lines in a terminal window as described below. | ||
+ | |||
+ | == Command lines operation == | ||
Using GeneWeb with command lines assumes that you are familiar with the notions of files, folders and that you are not afraid of entering commands directly in a terminal window. If this was not the case, you should limit yourself to the use of [[gwsetup]] which provides a web based interface for most of the needed actions. | Using GeneWeb with command lines assumes that you are familiar with the notions of files, folders and that you are not afraid of entering commands directly in a terminal window. If this was not the case, you should limit yourself to the use of [[gwsetup]] which provides a web based interface for most of the needed actions. | ||
Line 13: | Line 37: | ||
In this window, type the command to position yourself in the folder where GeneWeb is installed (see GeneWeb installation) which could be: | In this window, type the command to position yourself in the folder where GeneWeb is installed (see GeneWeb installation) which could be: | ||
*under Unix or OSX: | *under Unix or OSX: | ||
− | cd /home/user/ | + | cd /home/user/gw-7.00-alpha-linux/gw/ |
*under Windows,: | *under Windows,: | ||
− | cd c:\"program files (x86)"\ | + | cd c:\"program files (x86)"\gw-7.00-alpha-win\gw |
{{c|./program -help}} will return the help documentation with a list of possible parameters. | {{c|./program -help}} will return the help documentation with a list of possible parameters. | ||
Line 30: | Line 54: | ||
===Utilities=== | ===Utilities=== | ||
− | * '''[[Consang|consang]]''': | + | * '''[[Consang|consang]]''': computes the consanguinity in a base and performs a base clean-up. |
− | * '''update_nldb''': create the index of the various auxiliary pages created in notes with the wiki syntax <nowiki>[[[linked_page/displayed text]]]</nowiki>. | + | * '''update_nldb''': create the index of the various auxiliary pages created in notes with the wiki syntax <nowiki>[[[linked_page/displayed text]]]</nowiki> (see [[wikitext#Internal_links|wikitext]]). A listing of these pages is obtained with the {{c|1=m=MISC_NOTES}} command. Usage: {{c|./update_nldb <base_name>}}. |
− | |||
− | |||
− | |||
{{manual}} | {{manual}} | ||
[[Category:Manual]] | [[Category:Manual]] |
Latest revision as of 19:30, 11 February 2017
Language: | English • français |
---|
GeneWeb's distribution comes with standard tools for starting GeneWeb in a minimal configuration. To start Geneweb:
- start gwd.
- start gwsetup.
- open the START.html page with your preferred browser.
In the tree below, the scripts have extension .bat
for Windows, and .command
for macOS.
-
- gw
- CHANGES.txt: changelog
- geneweb: (macOS only) launch script for gwsetup, gwd and START.html page in a single command.
- gwd: minimal launch script for gwd
- gwsetup: minimal launch script for gwsetup
- LICENSE.txt
- LIZEZMOI.txt
- README.txt
- START.htm : a minimal start page (assumes that gwd and gwsetup have been started)
Alternatively, you may launch the execution of the various components of GeneWeb with command lines in a terminal window as described below.
Command lines operation
Using GeneWeb with command lines assumes that you are familiar with the notions of files, folders and that you are not afraid of entering commands directly in a terminal window. If this was not the case, you should limit yourself to the use of gwsetup which provides a web based interface for most of the needed actions.
In order to configure and launch GeneWeb, you may use interactive commands in terminal window:
- with a xterm virtual console under Unix/Linux or a terminal window under OS X,
- with cmd.exe under Windows (various ways to start cmd.exe depending on Windows version).
In this window, type the command to position yourself in the folder where GeneWeb is installed (see GeneWeb installation) which could be:
- under Unix or OSX:
cd /home/user/gw-7.00-alpha-linux/gw/
- under Windows,:
cd c:\"program files (x86)"\gw-7.00-alpha-win\gw
./program -help
will return the help documentation with a list of possible parameters.
Main components
The following programs perform the following tasks:
- gwd: act as a HTTP server processing requests end returning results.
- gwc: read a GWformat file to create a GeneWeb base.
- ged2gwb: read a GED file to create a GeneWeb base
- gwu: outputs the content of a base in the GeneWeb format
- gwb2ged: outputs the content of a base in the GED format.
Utilities
- consang: computes the consanguinity in a base and performs a base clean-up.
- update_nldb: create the index of the various auxiliary pages created in notes with the wiki syntax [[[linked_page/displayed text]]] (see wikitext). A listing of these pages is obtained with the
m=MISC_NOTES
command. Usage:./update_nldb <base_name>
.
GeneWeb Manual
- Download and install GeneWeb program under GNU/Linux, Mac OS X, Microsoft Windows, FreeBSD; on Mac OS X, Linux or Windows using Docker; or in CGI mode behind a web server.
- Understand GeneWeb server, homonym, consanguinity.
Use and manage genealogical databases
- Import Gedcom
.ged
or GeneWeb.gw
files with gwsetup or in command-line. - Update datas (add/remove individuals and families), merge duplicates, type dates.
- Use wikitext syntax, macros, keyboard shortcuts.
- Clean, recover, rename, save, archive a database.
- Merge and split multiples databases.
Technical annex
- Personalize CSS, header and trailer, templates, lexicon and declension.
- Configuration file
.gwf
(for templm), wizard notes, passwords for friends/wizards and access restrictions to databases. - Add images in notes, further remarks for experts.