summaryrefslogtreecommitdiff
path: root/documentation/src/fltk-options.man
diff options
context:
space:
mode:
authorMatthias Melcher <github@matthiasm.com>2023-01-21 17:14:41 +0100
committerGitHub <noreply@github.com>2023-01-21 17:14:41 +0100
commit1fc269b0d4c79b256cc57740d318f95dded8c340 (patch)
tree5df94f8cb7f4e8629dbce7a36f070ea5b513d5d7 /documentation/src/fltk-options.man
parent4ddcbc81de60faa0e9922db7df316f3d69cb8df7 (diff)
Move global FLTK options into new app fltk-admin (#560)
Diffstat (limited to 'documentation/src/fltk-options.man')
-rw-r--r--documentation/src/fltk-options.man98
1 files changed, 98 insertions, 0 deletions
diff --git a/documentation/src/fltk-options.man b/documentation/src/fltk-options.man
new file mode 100644
index 000000000..c3beae1c1
--- /dev/null
+++ b/documentation/src/fltk-options.man
@@ -0,0 +1,98 @@
+.TH fltk\-options 1 "Fast Light Tool Kit" "13. January 2023"
+.SH NAME
+fltk\-options \- application to get and modify FLTK runtime options.
+.sp
+.SH SYNOPSIS
+fltk\-options
+[ \-S\fIoption[=value]\fR ]
+[ \-U\fIoption[=value]\fR ]
+[ \-L ]
+[ \-LS ]
+[ \-LU ]
+[ \-f ]
+[ \-v ] [ \-\-verbose ]
+[ \-h[option] ] [ \-\-help [option] ]
+.SH DESCRIPTION
+\fIfltk\-options\fR is a tool that allows you to access and change settings
+related to the user interface in applications built with FLTK. These settings
+will be applied when the program is launched. They can be set at the system
+level or by the individual user. User settings take precedence
+over system settings.
+.LP
+The following command line arguments are supported:
+.TP 5
+\-S\fIoption[=value]\fR
+.br
+Change or print system wide option.
+.TP 5
+\-U\fIoption[=value]\fR
+.br
+Change or print user option. Values can be "0" or "OFF" to clear,
+or "1" or "ON" to set the option. The value "-1" or "DEFAULT" sets
+the option to its default value.
+If no value is given, the current setting is returned as "-1", "0", or "1".
+.TP 5
+\-L
+.br
+List the value of all options.
+.TP 5
+\-LS
+.br
+List the value of all system options.
+.TP 5
+\-LU
+.br
+List the value of all user options.
+.TP 5
+\-f
+.br
+Suppress error messages concerning file access permissions.
+.TP 5
+\-v, \-\-verbose
+.br
+Print additional information in command line mode.
+.TP 5
+\-h[option], \-\-help [option]
+.br
+Prints a help page. If an option is give, print detailed information
+for that option.
+.LP
+The following FLTK options are supported:
+.TP 5
+OPTION_VISIBLE_FOCUS
+.br
+Draw a dotted rectangle in widget with keyboard focus.
+.TP 5
+OPTION_ARROW_FOCUS
+.br
+Arrow keys will move focus beyond text input field.
+.TP 5
+OPTION_SHOW_TOOLTIPS
+.br
+Show or hide tooltips.
+.TP 5
+OPTION_DND_TEXT
+.br
+User can drag text from FLTK into other apps.
+.TP 5
+OPTION_FNFC_USES_GTK
+.br
+Use GTK file chooser instead of FLTK if available.
+.TP 5
+OPTION_PRINTER_USES_GTK
+.br
+Use GTK printer dialog instead of FLTK if available.
+.TP 5
+OPTION_SHOW_SCALING
+.br
+Show the zoom factor in a transient popup window.
+.LP
+Calling fltk-options without options will launch fltk-options interactive mode.
+.SH SEE ALSO
+fluid(1), fltk-config(1), fltk(3)
+.br
+FLTK Programming Manual
+.br
+FLTK Web Site, https://www.fltk.org/
+.SH AUTHORS
+Bill Spitzak and others.