Documentation

User documentation, Manual pages, Developer documentation, FAQ (Frequently Asked Questions).

Miscellaneous:

• A slightly technical overview of Gwyddion design.
• Motivation, a document predating Gwyddion and explaining circumstances that led to its creation.
• What is new in 2.0, an overview of major user-visible changes in Gwyddion 2.0.
• Some plans for future versions and version numbering explanation.

User documentation

User documentation consists of Gwyddion User guide which is available in several languages. Note the English version is primary; the other language versions may or may not be as complete as the English guide. The guide is updated continuously and may occasionaly describe features present only in the development snapshots of Gwyddion.

HTML version for on-line browsing:

English

French

Russian

the same HTML version, packed to an archive:

English, HTML archive:	gwyddion-user-guide-xhtml-en.tar.gz	2012-05-21	5.8 MB
French, HTML archive:	gwyddion-user-guide-xhtml-fr.tar.gz	2012-05-21	5.88 MB
Russian, HTML archive:	gwyddion-user-guide-xhtml-ru.tar.gz	2012-05-21	6.19 MB

and PDF version suitable for printing:

English, PDF (A4 paper):	gwyddion-user-guide-en.pdf	2012-05-21	5.82 MB
French, PDF (A4 paper):	gwyddion-user-guide-fr.pdf	2012-05-21	7.11 MB
Russian, PDF (A4 paper):	gwyddion-user-guide-ru.pdf	2012-05-21	6.16 MB

Known problems in the PDF version:

• The figures are in color as in the HTML version. Hence, some are not very useful if printed on a black-and-white printer.
• Long commands or variables sometimes stick out of the paragraph, or even the page; this concerns namely section Installation.
• Hyphenation does not work in the Russian guide. Any insight from Russian TeX experts concerning the reason of this would be welcome.

DocBook source:

gwyddion-user-guide.tar.gz

2012-05-21

9.3 MB

Gwyddion user guide can be copied, distributed and/or modified under the terms of either GNU General Public License or GNU Free Documentation License.

Manual pages

Unix manual pages of Gwyddion commands are now part of the user guide:

gwyddion(1)
gwyddion-thumbnailer(1)

Developer documentation

Developer documentation consists of API reference of Gwyddion libraries (for core developers and module authors), and Module tutorial (for module writers) and Plug-in proxy reference (for plug-in writers) that are included in libgwymodule documentation.

Two different versions of API documentation exist: stable which describes the last stable Gwyddion version (currently 2.28); and the nightly generated one, which reflects whatever state the source tree currently is. Gwyddion version a function or other symbol was introduced in is noted in its entry, at least in the stable documentation. API documentation is also present in source tarballs and development packages.

Stable documentation index (2.28):

• libgwyddion – Gwyddion core library
• libgwyprocess – Gwyddion data processing library
• libgwydraw – Gwyddion drawing library
• libgwydgets – Gwyddion widget library
  • Data windows and views
  • Graph
  • 3D Widgets
  • General widgets
  • Widget utilities
• libgwymodule – Gwyddion module library
  • Module library
  • Module tutorial
  • Plug-in proxy reference
• libgwyapp – Gwyddion application library

Subversion trunk (head) documentation index:

• libgwyddion – Gwyddion core library
• libgwyprocess – Gwyddion data processing library
• libgwydraw – Gwyddion drawing library
• libgwydgets – Gwyddion widget library
  • Data windows and views
  • Graph
  • 3D Widgets
  • General widgets
  • Widget utilities
• libgwymodule – Gwyddion module library
  • Module library
  • Module tutorial
  • Plug-in proxy reference
• libgwyapp – Gwyddion application library
• pygwy – Python interface, for now it is mostly generated from the C API documentation, therefore it can be a bit confusing (read: wrong)
• Pygwy tutorial – An introduction to Pygwy: Gwyddion binding to Python language