OSGeo4W

https://trac.osgeo.org/osgeo4w/wiki/
Admin
OSGeo4W is a binary distribution of a broad set of open source geospatial software for Windows...
Tokens:93,657
Snippets:1,442
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### OSGeo4W Session Example

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-apt/AptFromScratch

Demonstrates a typical session including setup, package installation, and listing installed packages.

```batch
D:\>set osgeo4w_root=d:\test-osgeo4w   
D:\>apt setup   
`Root dir not found, creating d:/test-osgeo4w`   
`creating d:/test-osgeo4w/etc/setup/`   
`creating d:/test-osgeo4w/etc/setup//installed.db`   
`getting d:/test-osgeo4w/etc/setup//setup.ini`   
`...100%`   

D:\>apt install shell   
`to install:`   
`    shell msvcrt`   
`Fetching http://download.osgeo.org/osgeo4w/./release/shell/shell-1.0.0-5.tar.bz2`   

`...100%  d:/test-osgeo4w/var/cache/setup/http%3a%2f%2fdownload.osgeo.org%2fosgeo4w/./release/shell/shell-1.0.0-5.tar.bz2`   

`a01e6dcdc9e2d2c49424585aa3e1b44f  shell-1.0.0-5.tar.bz2 - remote`   
`a01e6dcdc9e2d2c49424585aa3e1b44f  shell-1.0.0-5.tar.bz2 - local`   

`Fetching http://download.osgeo.org/osgeo4w/./release/msvcrt/msvcrt-1.0.1-2.tar.bz2`   
`...100%  d:/test-osgeo4w/var/cache/setup/http%3a%2f%2fdownload.osgeo.org%2fosgeo4w/./release/msvcrt/msvcrt-1.0.1-2.tar.bz2`   

`195c192b98b7333e2d3f9e04717c2eb5  msvcrt-1.0.1-2.tar.bz2 - remote`   
`195c192b98b7333e2d3f9e04717c2eb5  msvcrt-1.0.1-2.tar.bz2 - local`   
`installing shell 1.0.0-5`   

`>mkdir "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\OSGeo4W"`   
`>xxmklink "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\OSGeo4W\OSGeo4W.lnk" "d:\test-osgeo4w\OSGeo4W.bat" " " \ "OSGeo for Windows command shell" 1 "d:\test-osgeo4w\OSGeo4W.ico`   
`>xxmklink "C:\ProgramData\Desktop\OSGeo4W.lnk" "d:\test-osgeo4w\OSGeo4W.bat" " " \ "OSGeo for Windows command shell" 1 "d:\test-osgeo4w\OSGeo4W.ico`   
`Post_install complete, return code 0`   
`installing msvcrt 1.0.1-2`   

`>"d:\test-osgeo4w\bin\vcredist_x86.exe" /q`   
`>del "d:\test-osgeo4w\bin\vcredist_x86.exe"`   
`>textreplace -std -t bin/o4w_env.bat`   
`Post_install complete, return code 0`   

D:\>apt list   
`msvcrt              1.0.1-2`   
`shell               1.0.0-5`
```

--------------------------------

### Initial apt Setup

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-apt

Commands to initialize the apt tool and install the shell environment upon first use.

```bash
apt setup
apt install shell
```

--------------------------------

### Checkout Setup Files

Source: https://trac.osgeo.org/osgeo4w/wiki/InstallerTranslation

Use Subversion to download the setup source code.

```bash
svn co https://svn.osgeo.org/osgeo4w/trunk/setup/ setup --username yourname
```

--------------------------------

### Package setup.hint Example

Source: https://trac.osgeo.org/osgeo4w/wiki/PackagingInstructions

Example of a setup.hint file containing package metadata and dependencies.

```text
sdesc: "The Libgeotiff library, commandline tools and supporting tables."
ldesc: "The Libgeotiff library, commandline tools and supporting tables.
Used for manipulating GeoTIFF files."
maintainer: FrankWarmerdam
category: Libs Commands
requires: msvcrt libtiff
```

--------------------------------

### Complex Postinstall Shortcut Configuration

Source: https://trac.osgeo.org/osgeo4w/wiki/PackagingInstructions

A comprehensive example from qgis-dev showing environment setup, folder creation, and multiple shortcut types using bgspawn to prevent command line windows.

```batch
call "%OSGEO4W_ROOT%\bin\o4w_env.bat"

if not defined OSGEO4W_DESKTOP for /F "tokens=* USEBACKQ" %%F IN (`getspecialfolder Desktop`) do set OSGEO4W_DESKTOP=%%F
for /F "tokens=* USEBACKQ" %%F IN (`getspecialfolder Documents`) do set DOCUMENTS=%%F

call "%OSGEO4W_ROOT%\bin\qgis-dev.bat" --postinstall
echo on

if not %OSGEO4W_MENU_LINKS%==0 if not exist "%OSGEO4W_STARTMENU%" mkdir "%OSGEO4W_STARTMENU%"
if not %OSGEO4W_DESKTOP_LINKS%==0 if not exist "%OSGEO4W_DESKTOP%" mkdir "%OSGEO4W_DESKTOP%"

if not %OSGEO4W_MENU_LINKS%==0 xxmklink "%OSGEO4W_STARTMENU%\QGIS Desktop 3.21.0 (Nightly).lnk" "%OSGEO4W_ROOT%\bin\qgis-dev-bin.exe" "" "%DOCUMENTS%"
if not %OSGEO4W_DESKTOP_LINKS%==0 xxmklink "%OSGEO4W_DESKTOP%\QGIS Desktop 3.21.0 (Nightly).lnk" "%OSGEO4W_ROOT%\bin\qgis-dev-bin.exe" "" "%DOCUMENTS%"

if not %OSGEO4W_MENU_LINKS%==0 xxmklink "%OSGEO4W_STARTMENU%\Qt Designer with QGIS 3.21.0 custom widgets (Nightly).lnk" "%OSGEO4W_ROOT%\bin\bgspawn.exe" "\"%OSGEO4W_ROOT%\bin\qgis-dev-designer.bat\"" "%DOCUMENTS%" "" 1 "%OSGEO4W_ROOT%\apps\qgis-dev\icons\QGIS.ico"
if not %OSGEO4W_DESKTOP_LINKS%==0 xxmklink "%OSGEO4W_DESKTOP%\Qt Designer with QGIS 3.21.0 custom widgets (Nightly).lnk" "%OSGEO4W_ROOT%\bin\bgspawn.exe" "\"%OSGEO4W_ROOT%\bin\qgis-dev-designer.bat\"" "%DOCUMENTS%" "" 1 "%OSGEO4W_ROOT%\apps\qgis-dev\icons\QGIS.ico"
```

--------------------------------

### OSGeo4W Setup Command Line Options

Source: https://trac.osgeo.org/osgeo4w/wiki/CommandLine

A comprehensive list of available command line flags for configuring the OSGeo4W installer.

```text
 -A --advanced                     Advanced install (default)
 -a --arch                         architecture to install (x86_64 or x86)
 -k --autoaccept                   Accept all licenses
 -C --categories                   Specify entire categories to install
 -o --delete-orphans               remove orphaned packages
 -T --desktop                      Enable creation of desktop shortcuts
 -b --disable-buggy-antivirus      Disable known or suspected buggy anti virus
                                   software packages during execution.
 -D --download                     Download from internet
 -E --express                      Express install (as opposed to Advanced)
 -h --help                         print help
    --lang                         language to show ui in
 -L --local-install                Install from local directory
 -l --local-package-dir            Local package directory
 -m --menu-name                    Menu name
 -d --no-desktop                   Disable creation of desktop shortcuts
                                   (default)
 -r --no-replaceonreboot           Disable replacing in-use files on next
                                   reboot.
 -n --no-shortcuts                 Disable creation of desktop and start menu
                                   shortcuts
 -N --no-startmenu                 Disable creation of start menu shortcuts
 -O --only-site                    Ignore all sites except for -s
 -M --package-manager              Semi-attended chooser-only mode
 -P --packages                     Specify packages to install
 -p --proxy                        HTTP/FTP proxy (host:port)
 -q --quiet-mode                   Unattended setup mode
 -c --remove-categories            Specify categories to uninstall
 -x --remove-packages              Specify packages to uninstall
 -R --root                         Root installation directory
 -S --safe                         Safe Mode (Skip some admin actions)
 -s --site                         Download site
 -t --test                         Use setup_test.ini
 -g --upgrade-also                 also upgrade installed packages
    --user-agent                   User agent string for HTTP requests
```

--------------------------------

### Starting tracd with Basic authentication

Source: https://trac.osgeo.org/osgeo4w/wiki/TracStandalone

Example command to launch tracd using Basic authentication with an htpasswd file.

```bash
 $ tracd -p 8080 --basic-auth="project,/fullpath/environmentname/.htpasswd,realmname" /path/to/project
```

```bash
 $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project
```

--------------------------------

### Install Trac as a Windows Service using cygrunsrv

Source: https://trac.osgeo.org/osgeo4w/wiki/TracStandalone

Uses the Cygwin cygrunsrv utility to install and start the tracd service.

```bash
$ cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects'
$ net start tracd
```

--------------------------------

### Initialize Python 2.7 environment variables and installation

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-python/Python27

Sets version variables and initiates the installation of Python 2.7 from the official MSI installer.

```batch
set vv=27
set ver=2.7.2
set ver-pkg=%ver%-1

:: install py27 from standard 32bit msi installer to Current User[*]
wget http://www.python.org/ftp/python/%ver%/python-%ver%.msi
start python-%ver%.msi

pushd d:\o4w-packages\python
mkdir python-core python-wrapper python-help
```

--------------------------------

### Build and Run OSGeo4W Installer for Testing

Source: https://trac.osgeo.org/osgeo4w/wiki/GSoc2013Doc

Configure, build, and execute the installer using a specific testing mirror.

```bash
         cd setup   # go to setup directory which you must download of svn server with all sources.
 
         # this will produce configure file with a testing mirror (there are other mirrors for x64) 
         ./bootstrap.sh  --enable-mirror=http://download.osgeo.org/osgeo4w/testing_license

          make # this will produce the osgeo4w-setup-x86.exe installer for x86 machine 

         ./osgeo4w-setup-x86.exe --arch=x86
```

--------------------------------

### Index Package File Example

Source: https://trac.osgeo.org/osgeo4w/wiki/PackagingInstructions

Example content for a .pkg.html file to be displayed on the OSGeo4W index page.

```html
   <pre><h3>Foobar Application</h3>
   <blockquote><p><a href="/foobar/">Foobar demo</a></p></pre>
```

--------------------------------

### List and Install Additional Packages

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-apt/AptFromScratch

Displays available packages and installs specific software like GDAL.

```batch
>apt available

 Packages available to install (* = already installed)

agg-devel                       mapscript-dev-python
apache                          mapscript-java
apache-manual                   mapscript-python
...snipped >140 package names...
libxdr                          xerces-c
libxml2                         xerces-c-devel
mapfish_framework               zlib

>apt install gdal
...snip...

>gdalinfo --version
GDAL 1.8.0, released 2011/01/12
```

--------------------------------

### Create Start Menu Shortcuts with xxmklink

Source: https://trac.osgeo.org/osgeo4w/wiki/PackagingInstructions

Creates a folder and a shortcut in the Start Menu using the xxmklink utility.

```batch
  if not %OSGEO4W_MENU_LINKS%==0 (
    mkdir "%OSGEO4W_STARTMENU%"
    mkdir "%OSGEO4W_STARTMENU%\Apache"
    xxmklink "%OSGEO4W_STARTMENU%\Apache\OSGEO4W-Apache-Install.lnk" 
      %OSGEO4W_ROOT%\Apache\bin\httpd.exe " -k install -n \"Apache OSGEO4W Web Server\""
  )
```

--------------------------------

### Build OSGeo4W Setup

Source: https://trac.osgeo.org/osgeo4w/wiki/SetupDevelopment

Commands to initialize the build environment and compile the executable.

```bash
cd setup
./bootstrap.sh  # This will automatically rebuild configure file
                # If you want to enable a mirror, you should add --enable-mirror option, see README file please 
make # this should produce a osgeo4w-setup-x86.exe executable in the setup directory, that is approximately 9 MB in size
make clean # if necessary
```

--------------------------------

### Access Denied Error Message

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-apache

Example of the error message encountered when attempting to install the service without administrative privileges.

```text
>apache-install.bat
Installing the Apache OSGeo4W Web Server service
(OS 5)Access is denied.  : Failed to open the WinNT service manager
The service name is invalid.

More help is available by typing NET HELPMSG 2185.
```

--------------------------------

### dllupdate.exe Post-Install Script Example

Source: https://trac.osgeo.org/osgeo4w/wiki/dllupdate

Example usage within a post-install script to update OpenSSL DLLs.

```batch
dllupdate -q -oite -copy %OSGEO4W_ROOT%\bin\libeay23.dll
dllupdate -q -oite -copy %OSGEO4W_ROOT%\bin\ssleay23.dll
```

--------------------------------

### Install Apache Service

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-apache

Execute this command in the OSGeo4W shell to install the Apache web server as a Windows service.

```batch
apache-install.bat
```

--------------------------------

### Build and Run OSGeo4W Setup

Source: https://trac.osgeo.org/osgeo4w/wiki/GSoc2013Tests

Commands to bootstrap, build, and execute the setup.exe with a custom mirror for testing.

```bash
  cd setup
  ./bootstrap.sh  --enable-mirror=http://download.osgeo.org/osgeo4w/testing_license # this will produce configure file with a mirror 
   make # this will produce a setup.exe executable in the setup directory
  ./osgeo4w-setup-x86.exe --arch=x86  #this will connect to remote server to get packages from [http://download.osgeo.org/osgeo4w/testing_license/] testing licenses
```

--------------------------------

### Display Help Options

Source: https://trac.osgeo.org/osgeo4w/wiki/CommandLine

Command to display the available help options for the OSGeo4W setup executable.

```bash
> osgeo4w-setup.exe -h
```

--------------------------------

### Build Release Version

Source: https://trac.osgeo.org/osgeo4w/wiki/SetupDevelopment

Automated command to build a release-ready version of the setup executable.

```bash
make release
```

--------------------------------

### Apache Service Installation Output

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-apache

Expected console output after successfully running the Apache installation script.

```text
Installing the Apache OSGeo4W Web Server service
The Apache OSGeo4W Web Server service is successfully installed.
Testing httpd.conf....
Errors reported here must be corrected before the service can be started.
The Apache OSGeo4W Web Server service is starting.
The Apache OSGeo4W Web Server service was started successfully.
```

--------------------------------

### Default Permission Settings

Source: https://trac.osgeo.org/osgeo4w/wiki/TracFineGrainedPermissions

Example of default permission assignments.

```text
john           WIKI_VIEW
jack           WIKI_VIEW
```

--------------------------------

### Verify SVN Installation

Source: https://trac.osgeo.org/osgeo4w/wiki/SetupDevelopment

Test that the Subversion client is correctly installed and accessible in the system PATH.

```bash
svn --help
```

--------------------------------

### Install Trac plugins via pip

Source: https://trac.osgeo.org/osgeo4w/wiki/TracPlugins

Install plugins from PyPI or source repositories using pip.

```bash
$ pip install TracTags
```

```bash
$ pip install TracTags==1.2
```

```bash
$ pip install svn+https://trac-hacks.org/svn/tagsplugin/trunk
```

```bash
$ pip install https://trac-hacks.org/browser/tagsplugin/trunk?format=zip
```

```bash
$ svn co https://trac-hacks.org/svn/tagsplugin/trunk tractags
$ pip install tractags
```

--------------------------------

### AuthzPolicy Rule Examples

Source: https://trac.osgeo.org/osgeo4w/wiki/TracFineGrainedPermissions

Example rules for controlling access to wiki pages.

```ini
[wiki:WikiStart@*]
* = WIKI_VIEW

[wiki:PrivatePage@*]
john = WIKI_VIEW
* = !WIKI_VIEW
```

--------------------------------

### [[MacroList]]

Source: https://trac.osgeo.org/osgeo4w/wiki/WikiMacros

Displays a list of all installed Wiki macros, including documentation if available.

```APIDOC
## [[MacroList]]

### Description
Display a list of all installed Wiki macros, including documentation if available.

### Parameters
- **macro_name** (string) - Optional - The name of a specific macro to render documentation for.
```

--------------------------------

### Install pip

Source: https://trac.osgeo.org/osgeo4w/wiki/ExternalPythonPackages

Execute the downloaded script using the OSGeo4W Python interpreter.

```bash
python get-pip.py
```

--------------------------------

### Example macro usage and output

Source: https://trac.osgeo.org/osgeo4w/wiki/WikiMacros

Demonstrates how different calling syntaxes affect the content and args parameters in the macro.

```text
{{{#!HelloWorld style="polite" -silent verbose
<Hello World!>
}}}

{{{#!HelloWorld
<Hello World!>
}}}

[[HelloWorld(<Hello World!>)]]
```

```text
Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True}
Hello World, text = <Hello World!>, args = {}
Hello World, text = <Hello World!>, args = None
```

--------------------------------

### Common apt Operations

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-apt

Standard commands for managing package updates, installations, and listing available or installed software.

```bash
apt update                   (fetch up-to-date setup.ini)
apt install gdal gdal-python (install packages "gdal" and "gdal-python", and dependencies)
apt new                      (show possible upgrades)
apt list                     (show installed packages)
apt available                (show installation candidates)
apt remove xxx yyy           (uninstall packages xxx and yyy)
```

--------------------------------

### Configure Default Subscriptions

Source: https://trac.osgeo.org/osgeo4w/wiki/TracNotification

Example of setting up subscriber rules in the [notification-subscriber] section, including priority and adverb settings.

```ini
[notification-subscriber]
always_notify_owner = TicketOwnerSubscriber
always_notify_owner.distributor = email
always_notify_owner.priority = 100
always_notify_owner.adverb = always
always_notify_owner.format = text/plain

always_notify_previous_updater = TicketPreviousUpdatersSubscriber

never_notify_updater = TicketUpdaterSubscriber
never_notify_updater.adverb = never
never_notify_updater.priority = 0

notify_cc_html = CarbonCopySubscriber
notify_cc_html.format = text/html

```

--------------------------------

### Display Macro Documentation

Source: https://trac.osgeo.org/osgeo4w/wiki/WikiFormatting

Retrieves documentation for installed macros by appending a question mark.

```text
[[MacroList?]]
```

--------------------------------

### Translate Installer Controls

Source: https://trac.osgeo.org/osgeo4w/wiki/InstallerTranslation

Update control labels while preserving interface accelerators.

```text
CONTROL "&Download Without Installing",

translated to:

CONTROL "インストールせずにダウンロード(&D)",
```

--------------------------------

### Match WikiStart Resource

Source: https://trac.osgeo.org/osgeo4w/wiki/TracFineGrainedPermissions

Examples of glob patterns to match the WikiStart page.

```ini
[wiki:*]
[wiki:WikiStart*]
[wiki:WikiStart@*]
[wiki:WikiStart]
```

--------------------------------

### Install Trac as a Windows Service using WINSERV

Source: https://trac.osgeo.org/osgeo4w/wiki/TracStandalone

Alternative installation method for Windows 7 users using the WINSERV utility.

```batch
"C:\path\to\winserv.exe" install tracd -displayname "tracd" -start auto "C:\path\to\python.exe" c:\path\to\python\scripts\tracd.exe <your tracd parameters>"
net start tracd
```

--------------------------------

### GDAL DLL Load Error Example

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-gdal-ecw

Example of the console error output when the required ECW libraries are missing.

```text
C:\warmerda>gdalinfo
ERROR 1: Can't load requested DLL: C:\osgeo4w\bin\gdalplugins\1.9\gdal_ECW_JP2ECW.dll
126: The specified module could not be found.

ERROR 1: Can't load requested DLL: C:\osgeo4w\bin\gdalplugins\1.9\gdal_ECW_JP2ECW.dll
126: The specified module could not be found.

Usage: gdalinfo [--help-general] [-mm] [-stats] [-hist] [-nogcp] [-nomd]
                [-norat] [-noct] [-checksum] [-mdd domain]* datasetname
```

--------------------------------

### List and uninstall plugins

Source: https://trac.osgeo.org/osgeo4w/wiki/TracPlugins

Manage installed packages using pip commands.

```bash
$ pip list
Package    Version
---------- -------
Jinja2     2.10.1
MarkupSafe 1.1.1
pip        19.2.2
setuptools 41.2.0
Trac       1.4
TracTags   0.10
wheel      0.33.6
```

```bash
$ pip uninstall TracTags
```

--------------------------------

### Apache Configuration with Variable Substitution

Source: https://trac.osgeo.org/osgeo4w/wiki/PackagingInstructions

Example of an Apache configuration file using the @osgeo4w@ variable for path portability.

```apache
  Alias /gmap/ "@osgeo4w@/apps/gmap/htdocs/"
  <Directory "@osgeo4w@/apps/gmap/htdocs/">
    AllowOverride None
    Options Indexes FollowSymLinks Multiviews 
    Order allow,deny
    Allow from all
  </Directory>
```

--------------------------------

### Apache Subversion configuration

Source: https://trac.osgeo.org/osgeo4w/wiki/TracFineGrainedPermissions

Example Apache directive for applying the access file to a Subversion repository.

```apache
<Location /repos>
  DAV svn
  SVNParentPath /usr/local/svn
```

--------------------------------

### Example of tracd Digest authentication

Source: https://trac.osgeo.org/osgeo4w/wiki/TracStandalone

A basic example of starting tracd with Digest authentication enabled.

```bash
 $ tracd -p 8080 \
   --auth="project1,/path/to/passwordfile,mycompany.com" /path/to/project1
```

--------------------------------

### Apache Configuration with Hardcoded Paths

Source: https://trac.osgeo.org/osgeo4w/wiki/PackagingInstructions

Example of an Apache configuration file containing hardcoded paths before variable substitution.

```apache
  Alias /gmap/ "C:/mypath/apps/gmap/htdocs/"
  <Directory "C:/mypath/apps/gmap/htdocs/">
    AllowOverride None
    Options Indexes FollowSymLinks Multiviews 
    Order allow,deny
    Allow from all
  </Directory>
```

--------------------------------

### Configure Trac service for automatic startup

Source: https://trac.osgeo.org/osgeo4w/wiki/TracStandalone

Sets the installed tracd service to start automatically upon Windows boot.

```batch
 sc config tracd start= auto
```

--------------------------------

### Manage Package Versions in setup.ini

Source: https://trac.osgeo.org/osgeo4w/wiki/PackagingInstructions

Identify and resolve versioning issues by listing package files or defining current and previous versions in setup.hint.

```text
  apache-2.2.8-1.tar.bz2 
  apache-2.2.8-2.tar.bz2 
  apache-2.2.8-3.tar.bz2  
  apache-2.2.14-1.tar.bz2
```

```text
  sdesc: "Apache Web Server"
  ldesc: "Apache Web Server"
  category: Web 
  requires: msvcrt php
  curr: 2.2.14-1
  prev: 2.2.8-3
```

--------------------------------

### Initialize and deploy Trac environment

Source: https://trac.osgeo.org/osgeo4w/wiki/TracInstall

Example workflow for creating a new environment, deploying resources to a web directory, and setting execution permissions.

```bash
$ mkdir -p /var/trac
$ trac-admin /var/trac/<project> initenv
$ trac-admin /var/trac/<project> deploy /var/www
$ ls /var/www
cgi-bin htdocs
$ chmod ugo+x /var/www/cgi-bin/*
```

--------------------------------

### Install mod_python on Fedora

Source: https://trac.osgeo.org/osgeo4w/wiki/TracModPython

Command to install mod_python using yum on Fedora systems.

```bash
yum install mod_python

```

--------------------------------

### Install mod_python on Debian

Source: https://trac.osgeo.org/osgeo4w/wiki/TracModPython

Command to install mod_python using apt-get on Debian systems.

```bash
apt-get install libapache2-mod-python libapache2-mod-python-doc

```

--------------------------------

### apt command syntax and options

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-apt/AptCommands

The general syntax for the apt command and a list of available commands and configuration options.

```text
   **apt [OPTION]... COMMAND [PACKAGE]...**

Commands:
---------
|     available -  show packages available to be installed
|     ball - print tarball name
|     download - download package
|     find - package containing file (from installed packages)
|     help - help COMMAND
|     install - download and install packages, including dependencies
|     list - installed packages
|     md5 - check md5 sum
|     missing - print missing dependencies
|     new - list available upgrades to currently installed packages
|     remove - uninstall packages
|     requires - print requires: for package
|     search - search package list
|     setup - skeleton installed packages environment
|     update - setup.ini
|     upgrade - all installed packages
|     url - print tarball url
|     version - print installed version

Options:
--------
|     -d,--download          : download only
|     -i,--ini=FILE          : use setup.ini [D:/o4w/etc/setup//setup.ini]
|     -m,--mirror=URL        : use mirror [!http://download.osgeo.org/osgeo4w] 
|     -r,--root=DIR          : set osgeo4w root [D:/o4w]
|     -t,--t=NAME            : set dist name (*curr*, test, prev)
|     -x,--no-deps           : ignore dependencies
|     -s,--start-menu=NAME   : set the start menu name (OSGeo4W)
```

--------------------------------

### Initialize and Configure OSGeo4W Environment

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-apt/AptFromScratch

Sets the root directory and initializes the environment using the apt utility.

```batch
SET OSGEO4W_ROOT=C:\Osgeo4W
apt setup
apt update
apt install shell
```

--------------------------------

### Install python-flup on Debian

Source: https://trac.osgeo.org/osgeo4w/wiki/TracFastCgi

Installs the required python-flup package to enable SCGI support for Trac.

```bash
sudo apt-get install python-flup
```

--------------------------------

### Generate Setup.ini File

Source: https://trac.osgeo.org/osgeo4w/wiki/GSoc2013Tests

Execute the regen.sh script to update the setup.ini file with new license entries.

```bash
   # go to main directory of testing version in "/osgeo/download/osgeo4w/testing_license/" directory, there is a script called regen.sh
   ./regen.sh   # it will run perl script genini
  
   # Now you can see the setup.ini file with license entry for each restrictive package   
```

--------------------------------

### Install Trac via pip

Source: https://trac.osgeo.org/osgeo4w/wiki/TracInstall

Install Trac from a local source directory or remote archive using pip.

```bash
$ pip install .
```

```bash
$ pip install https://download.edgewall.org/trac/Trac-latest-dev.tar.gz
```

```bash
$ pip install svn+https://svn.edgewall.org/repos/trac/branches/1.4-stable
```

```bash
$ pip install --find-links=https://trac.edgewall.org/wiki/TracDownload Trac
```

--------------------------------

### Create MSYS initialization script

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-msys

Set the system path and home directory for the MSYS environment.

```batch
PATH %PATH%;%OSGEO4W_ROOT%\apps\msys\bin
if not defined HOME set HOME=%USERPROFILE%
```

--------------------------------

### Add License File to Package Directory

Source: https://trac.osgeo.org/osgeo4w/wiki/GSoc2013Doc

Create a .txt file containing license terms within the specific package directory on the server.

```bash
    ssh someuser@download.osgeo.org   # log in into server 

    # For example, if gdal-ecw package has a non-open source license go there.

    cd /osgeo/download/osgeo4w/testing_license/release/gdal/gdal-ecw

    touch gdal-ecw-1.9.1-0.txt        # you need to create a .txt license file.

    echo "put all terms and conditions of the restrictive package" > gdal-ecw-1.9.1-0.txt  # Remember to save as .txt file and don't forget do format
```

--------------------------------

### Complex RST document example

Source: https://trac.osgeo.org/osgeo4w/wiki/WikiRestructuredText

A comprehensive example demonstrating headers, tables, and TracLinks within an RST block.

```rst
{{{#!rst
FooBar Header
=============
reStructuredText is **nice**. It has its own webpage_.

A table:

=====  =====  ======
   Inputs     Output
------------  ------
  A      B    A or B
=====  =====  ======
False  False  False
True   False  True
False  True   True
True   True   True
=====  =====  ======

RST TracLinks
-------------

See also ticket `#42`:trac:.

.. _webpage: http://docutils.sourceforge.net/rst.html
}}}
```

```rst
FooBar Header
=============
reStructuredText is **nice**. It has its own webpage_.

A table:

=====  =====  ======
   Inputs     Output
------------  ------
  A      B    A or B
=====  =====  ======
False  False  False
True   False  True
False  True   True
True   True   True
=====  =====  ======

RST TracLinks
-------------

See also ticket `#42`:trac:.

.. _webpage: http://docutils.sourceforge.net/rst.html
```

--------------------------------

### Install Trac optional dependencies

Source: https://trac.osgeo.org/osgeo4w/wiki/TracInstall

Install optional packages required for specific features like localization or documentation formatting.

```bash
$ pip install babel docutils pygments textile
```

```bash
$ pip install Trac[babel,rest,pygments,textile]
```

--------------------------------

### Create MSYS post-installation script

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-msys

Generate shortcuts for the MSYS shell and apply fstab text replacements.

```batch
mkdir "%OSGEO4W_STARTMENU%"
xxmklink "%OSGEO4W_STARTMENU%\MSYS Shell.lnk"       "%OSGEO4W_ROOT%\apps\msys\msys.bat" " " \ "Minimal SYStem" 7 "%OSGEO4W_ROOT%\apps\msys\msys.ico"

xxmklink "%ALLUSERSPROFILE%\Desktop\MSYS Shell.lnk" "%OSGEO4W_ROOT%\apps\msys\msys.bat" " " \ "Minimal SYStem" 7 "%OSGEO4W_ROOT%\apps\msys\msys.ico"

textreplace -std -t apps/msys/etc/fstab
```

--------------------------------

### Initialize Trac Environment with Repository Configuration

Source: https://trac.osgeo.org/osgeo4w/wiki/TracEnvironment

Use the initenv command with a configuration file to define repository settings during environment creation.

```bash
$ trac-admin $ENV initenv --config=config.ini
$ cat config.ini
[components]
tracopt.versioncontrol.* = enabled

[repositories]
.dir = /path/to/default/type/repos
repos1.type = git
repos1.dir = /path/to/git/repos
repos2.type = svn
repos2.dir = /path/to/svn/repos
```

--------------------------------

### Create Desktop Shortcut

Source: https://trac.osgeo.org/osgeo4w/wiki/PackagingInstructions

Creates a shortcut on the user's desktop.

```batch
  if not %OSGEO4W_DESKTOP_LINKS%==0 xxmklink "%OSGEO4W_DESKTOP%\OpenEV.lnk" "%OSGEO4W_ROOT%\bin\openev.bat" 
     " " \ "OSGeo4W OpenEV" 1 "%OSGEO4W_ROOT%\apps\openev\icon.ico"
```

--------------------------------

### Install Trac with Always-Unzip

Source: https://trac.osgeo.org/osgeo4w/wiki/TracModPython

Use this command to force the installation of Trac as a directory, resolving potential ImportError issues with zipped eggs in mod_python.

```bash
easy_install --always-unzip Trac-0.12b1.zip
```

--------------------------------

### Display Trac Admin Help

Source: https://trac.osgeo.org/osgeo4w/wiki/WikiMacros

Use these examples to display help documentation for specific trac-admin commands or all available commands.

```text
[[TracAdminHelp]]               # all commands
[[TracAdminHelp(wiki)]]         # all wiki commands
[[TracAdminHelp(wiki export)]]  # the "wiki export" command
[[TracAdminHelp(upgrade)]]      # the upgrade command
```

--------------------------------

### Perform an offline OSGeo4W installation via command line

Source: https://trac.osgeo.org/osgeo4w/wiki/FAQ

Use this command to install packages from a local directory on a machine without internet access. Ensure the paths are adjusted to match your local environment.

```batch
osgeo4w-setup.exe -q --local-install --root c:\OSGeo4w -l "c:\osgeoPackages\http:%3a%2f%2fdownload.osgeo.org%2fosgeo4\release"
```

--------------------------------

### [[SubscriberList]]

Source: https://trac.osgeo.org/osgeo4w/wiki/WikiMacros

Displays a list of installed notification subscribers.

```APIDOC
## [[SubscriberList]]

### Description
Display a list of all installed notification subscribers, including documentation if available.

### Parameters
- **subscriber_name** (string) - Optional - The name of a specific subscriber to display documentation for.
```

--------------------------------

### Add License File to Server

Source: https://trac.osgeo.org/osgeo4w/wiki/GSoc2013Tests

Commands to log into the server and create a license text file for a specific package.

```bash
    ssh someuser@download.osgeo.org   # log in into server 

    # if gdal-ecw package has non-open source license go there.

    cd /osgeo/download/osgeo4w/testing_license/release/gdal/gdal-ecw

    touch gdal-ecw-1.9.1-0.txt        # you need to create a .txt license file.

    echo "some terms of the restrictive package" > gdal-ecw-1.9.1-0.txt
```

--------------------------------

### Regenerate Setup.ini

Source: https://trac.osgeo.org/osgeo4w/wiki/GSoc2013Doc

Execute the regen.sh script to update the setup.ini file with new license entries.

```bash
   # go to main directory of testing version or official in this case,
   # we use "/osgeo/download/osgeo4w/testing_license/" path directory, there is a script called regen.sh

   ./regen.sh   # it will run perl genini script and create the new "setup.ini" file
  
   # Now you can see the setup.ini file with license entries for each restrictive package
```

--------------------------------

### Define Trac URL

Source: https://trac.osgeo.org/osgeo4w/wiki/TracFastCgi

The base URL for the Trac project installation.

```text
http://yourdomain.com/trac/
```

--------------------------------

### Start Trac standalone server for single project

Source: https://trac.osgeo.org/osgeo4w/wiki/TracInstall

Launches the standalone server directly to the project, bypassing the environment listing page.

```bash
$ tracd -s --port 8000 /path/to/myproject
```

--------------------------------

### Initialize a Trac Environment

Source: https://trac.osgeo.org/osgeo4w/wiki/TracEnvironment

Use the trac-admin command to create a new project environment at a specified path.

```bash
$ trac-admin /path/to/myproject initenv
```

--------------------------------

### Display QGIS plugin loading warnings

Source: https://trac.osgeo.org/osgeo4w/wiki/TicketQuery

Example of log output showing failed library loading for Grass 8.5 plugins.

```text
2026-06-25T15:41:51     WARNING    Failed to load D:/gis stick/gisstick3440326/osgeo4w/osgeo4w/apps/qgis-ltr/plugins/plugin_grass8.dll (Reason: Cannot load library D:\gis stick\gisstick3440326\osgeo4w\osgeo4w\apps\qgis-ltr\plugins\plugin_grass8.dll: Das angegebene Modul wurde nicht gefunden.)
2026-06-25T15:41:51     WARNING    Failed to load D:/gis stick/gisstick3440326/osgeo4w/osgeo4w/apps/qgis-ltr/plugins/provider_grass8.dll (Reason: Cannot load library D:\gis stick\gisstick3440326\osgeo4w\osgeo4w\apps\qgis-ltr\plugins\provider_grass8.dll: Das angegebene Modul wurde nicht gefunden.)
2026-06-25T15:41:51     WARNING    Failed to load D:/gis stick/gisstick3440326/osgeo4w/osgeo4w/apps/qgis-ltr/plugins/provider_grassraster8.dll (Reason: Cannot load library D:\gis stick\gisstick3440326\osgeo4w\osgeo4w\apps\qgis-ltr\plugins\provider_grassraster8.dll: Das angegebene Modul wurde nicht gefunden.
```

--------------------------------

### Environment Trac Configuration

Source: https://trac.osgeo.org/osgeo4w/wiki/TracStandalone

Example of an environment-specific trac.ini that inherits from a global configuration.

```ini
[inherit]
file = /srv/trac/conf/trac.ini
```

--------------------------------

### Configure ScriptAlias for fcgid

Source: https://trac.osgeo.org/osgeo4w/wiki/TracFastCgi

Example of a ScriptAlias directive pointing to the trac.fcgi script.

```apache
ScriptAlias / /srv/tracsite/cgi-bin/trac.fcgi/
```

--------------------------------

### Launch GRASS GIS with GUI

Source: https://trac.osgeo.org/osgeo4w/wiki/pkg-grass

Starts the GRASS GIS environment with the wxPython graphical user interface from the OSGeo4W shell.

```bash
grass84 -gui
```

--------------------------------

### Translate Installer Captions

Source: https://trac.osgeo.org/osgeo4w/wiki/InstallerTranslation

Replace English text in CAPTION objects with localized strings.

```text
CAPTION "OSGeo4W Setup - Choose Installation Type"

translated to:

CAPTION "OSGeo4Wセットアップ－インストールタイプの選択"
```

--------------------------------

### Start Trac standalone server

Source: https://trac.osgeo.org/osgeo4w/wiki/TracInstall

Launches the Trac standalone server on a specified port to serve the project environment.

```bash
$ tracd --port 8000 /path/to/myproject
```

--------------------------------

### Create server-wide links

Source: https://trac.osgeo.org/osgeo4w/wiki/TracLinks

Use the // prefix to link to locations on the same host, potentially outside the current project.

```text
[//register Register Here] or [[//register|Register Here]]
```

--------------------------------

### Unsupported group configuration

Source: https://trac.osgeo.org/osgeo4w/wiki/TracFineGrainedPermissions

Examples of group definitions that are not supported by the current permission policy.

```ini
[groups]
team1 = a, b, c
team2 = d, e, f
team3 = g, h, i
departmentA = team1, team2
```

```ini
[groups]
permission_level_1 = WIKI_VIEW, TICKET_VIEW
permission_level_2 = permission_level_1, WIKI_MODIFY, TICKET_MODIFY
[*]
@team1 = permission_level_1
@team2 = permission_level_2
@team3 = permission_level_2, TICKET_CREATE
```

--------------------------------

### Apache Alias Configuration

Source: https://trac.osgeo.org/osgeo4w/wiki/PackagingInstructions

Example of an Apache alias configuration file for a web application.

```apache
  Alias /foobar/ @osgeo4w@/apps/foobar/htdocs/
    AllowOverride None
    Options Indexes FollowSymLinks Multiviews
    Order allow,deny
    Allow from all  
```

--------------------------------

### Upgrade Trac documentation

Source: https://trac.osgeo.org/osgeo4w/wiki/TracUpgrade

Synchronizes the internal Trac documentation with the currently installed version of Trac.

```bash
$ trac-admin /path/to/projenv wiki upgrade
```

--------------------------------

### List all sessions

Source: https://trac.osgeo.org/osgeo4w/wiki/TracTickets

Display all sessions currently stored in the project environment.

```bash
trac-admin /path/to/projenv session list
```

--------------------------------

### Anchor Jump Link and Target

Source: https://trac.osgeo.org/osgeo4w/wiki/WikiFormatting

Example of creating a link that jumps to a specific anchor point.

```text
[#point2 jump to the second point]

...

Point2:  [=#point2] Jump here
```
Tokens:
Raw