Name

gwyddion — SPM data visualization and analysis

Synopsis

gwyddion [OPTION...] [FILE...]

Description

Gwyddion is a graphical SPM (Scanning Probe Microscope) data visualization and analysis program, using Gtk+.

Options

The program accepts all standard Gtk+, Gdk, and GtkGLExt options like --display or --sync. Please see documentation of these packages for description of toolkit options.

The behaviour of the remote-control options --remote-* is undefined when more than one instance of Gwyddion is running on the display. They can choose an arbitrary instance to communicate to.

If a directory is given as FILE argument the program opens a file chooser in this directory.

Gwyddion options:

--help

Prints a brief help and terminates.

--version

Prints version information and terminates.

--no-splash

Disables splash screen on program startup.

--remote-new

Opens files given on the command line in an already running instance of Gwyddion on the display. Runs a new instance if none is running.

This is probably the most useful remote control option. File type associations are usually installed to run Gwyddion with this option.

--remote-existing

Opens files given on the command line in an already running instance of Gwyddion on the display. Fails if none is running.

This is useful if you want to handle the case of Gwyddion not running differently than by starting it.

--remote-query

Succeeds if an instance of Gwyddion is already running on the display and prints its instance identifier. Fails if none is running.

The instance identifier depends on the remote control backend in use. In some cases it is useful as a global window identifier, in some it is not. With libXmu this option prints the X11 Window, on Win32 HWND is printed, while with LibUnique the startup id is printed.

--check

Instead of running the user interface and opening FILEs, it loads the files, performs a sanity check on them (printing errors to standard error output) and terminates.

--disable-gl

Disables OpenGL entirely, including any checks whether it is available. This option, of course, has any effect only if Gwyddion was built with OpenGL support and one of the most visible effects is that 3D view becomes unavailable. However, you may find it useful if you encounter a system so broken that even checking for OpenGL capabilities leads to X server errors. It can also help when you run Gwyddion remotely using X11 forwarding and the start-up time seems excessively long.

--log-to-file

Write messages from GLib, Gtk+, Gwyddion, etc. to ~/.gwyddion/gwyddion.log or file given in GWYDDION_LOGFILE environment variable. This option is most useful on Unix as on Win32 messages are redirected to a file by default. Logging to a file and console are not exclusive; messages can go to both.

--no-log-to-file

Prevents writing messages from GLib, Gtk+, Gwyddion, etc. to a file. This is most useful on Win32 where messages are written to a file by default.

--log-to-console

Print messages from GLib, Gtk+, Gwyddion, etc. to the console. More precisely, debugging messages are printed to the standard output, errors and warnings to the standard error. On Unix messages are printed to the console by default. Logging to a file and console are not exclusive; messages can go to both.

--no-log-to-file

Disables printing messages to the console. This is most useful on Unix where messages are printed to the console by default.

--disable-modules=MODULE,...

Prevents the registration modules of given names. This is mostly useful for development and debugging.

--debug-objects

Prints list of objects created during run time, with creation and desctruction times or reference counts on program exit. Useful only for developers.

--startup-time

Prints wall-clock time taken by various startup (and shutdown) tasks. Useful only for developers and people going to complain about too slow startup.

Environment

On Linux/Unix, following environment variables can be used to override compiled-in installation paths (MS Windows version always looks to directories relative to path where it was installed). Note they are intended to override system installation paths therefore they are not path lists, they can contain only a single path.

GWYDDION_DATADIR

Base data directory where resources (color gradients, OpenGL materials, …) were installed. Gwyddion looks into its gwyddion subdirectory for resources.

When it is unset, it defaults to compiled-in value of ${datadir} which is usually /usr/local/share.

GWYDDION_LIBDIR

Base library directory where modules were installed. Gwyddion looks into its gwyddion/modules subdirectory for modules.

When it is unset, it defaults to compiled-in value of ${libdir} which is usually /usr/local/lib or /usr/local/lib64.

GWYDDION_LIBEXECDIR

Base lib-exec directory where plug-ins were installed. Gwyddion looks into its gwyddion/plugins subdirectory for plug-ins.

When it is unset, it defaults to compiled-in value of ${libexecdir} which is usually /usr/local/libexec.

GWYDDION_LOCALEDIR

Locale data directory where message catalogs (translations) were installed.

When it is unset, it defaults to compiled-in value of ${datadir}/locale which is usually /usr/local/share/locale.

Other variables that influence Gwyddion run-time behaviour include GLib+ variables and Gtk+ variables and some Gwyddion-specific variables:

GWYDDION_LOGFILE

Name of file to redirect log messages to. On MS Windows, messages are always sent to a file as working with the terminal is cumbersome there. The default log file location, gwyddion.log in user's Documents and Settings, can be overridden with GWYDDION_LOGFILE. On Unix, messages go to the terminal by default and this environment variable has effect only if --log-to-file is given.

Files

~/.gwyddion/settings

Saved user settings and tool states. Do not edit while Gwyddion is running, it will overwrite it at exit.

~/.gwyddion/glmaterials, ~/.gwyddion/gradients, ...

User directories with various resources (OpenGL materials, color gradients, ...).

$GWYDDION_DATADIR/gwyddion/glmaterials, $GWYDDION_DATADIR/gwyddion/gradients ...

The same for system-wide resources.

~/.gwyddion/pixmaps

Directory to place user icons to. This is mainly useful for installation of modules to home.

$GWYDDION_DATADIR/gwyddion/pixmaps,

The same for system-wide icons.

~/.gwyddion/modules

Directory to place user modules to. They should be placed into file, graph, process, layer, and tools subdirectories according to their kind, though this is more a convention than anything else.

$GWYDDION_LIBDIR/gwyddion/modules,

The same for system-wide modules.

~/.gwyddion/plugins

Directory to place user plug-ins to. They should be placed into file and process subdirectories according to their kind.

$GWYDDION_LIBEXECDIR/gwyddion/plugins,

The same for system-wide plug-ins.

~/.gwyddion/pygwy

Directory to place user python modules or scripts to.

See also

gwyddion-thumbnailer(1), gxsm(1)