File: module-tutorial-install.xml

package info (click to toggle)
gwyddion 2.62-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 51,952 kB
  • sloc: ansic: 398,486; python: 7,877; sh: 5,492; makefile: 4,723; xml: 3,883; cpp: 1,969; pascal: 418; perl: 154; ruby: 130
file content (55 lines) | stat: -rw-r--r-- 2,354 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="gwymodule-tutorial-install" revision="$Id: module-tutorial-install.xml 20682 2017-12-18 18:39:00Z yeti-dn $">
  <refmeta>
    <refentrytitle>Gwyddion Module Installation</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo>Gwyddion</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>Gwyddion Module Installation</refname>
    <refpurpose>
      Compilation, distribution and installation of <application>Gwyddion</application> modules
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Overview</title>
    <para>
      To be written. Meanwhile you can look at the
      <ulink url="http://gwyddion.net/apps/#sample-module">threshold-example</ulink>
      module how it copes with this issues.
    </para>
    <para>
      Some highlights: On Unix systems, <application>Gwyddion</application>
      installs a pkg-config file with meta-information about the particular
      installation, so you can use <command>pkg-config</command> to find
      compiler and linker options and module installation directories.  See
      pkg-config documentation for description of the standard options.  The
      directory to install modules to can be obtained with
      <command>pkg-config --variable gwymoduledir gwyddion</command>.
    </para>
    <!-- FIXME: WTF? -->
    <para>
      On Win32 systems, <application>Gwyddion</application> installs a
      registry entry
      <literal>HKLM\Software\Gwyddion Development\1.0\Path</literal>
      containing the base directory, where development libraries and header
      files were installed.
    </para>
    <!-- TODO: Installation to system vs. to home -->
    <para>
      A module is typically installed to a subdirectory of the module directory
      accodring to the type of the functions it provides.  However the division
      into subdirectories exists only to ease human orientation in the pile
      of modules, the module loader does not make any consequences from
      module location.  A module can be also placed directly into the main
      directory (e.g., plugin-proxy resides there because it does not actually
      fit into any of the categories).
    </para>
  </refsect1>
</refentry>