diff options
Diffstat (limited to 'app/editres/man')
| -rw-r--r-- | app/editres/man/Makefile.am | 12 | ||||
| -rw-r--r-- | app/editres/man/Makefile.in | 458 | ||||
| -rw-r--r-- | app/editres/man/editres.man | 421 |
3 files changed, 891 insertions, 0 deletions
diff --git a/app/editres/man/Makefile.am b/app/editres/man/Makefile.am new file mode 100644 index 000000000..f43decee3 --- /dev/null +++ b/app/editres/man/Makefile.am @@ -0,0 +1,12 @@ + +appmandir = $(APP_MAN_DIR) +appman_PRE = editres.man +appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX)) + +EXTRA_DIST = $(appman_PRE) +CLEANFILES = $(appman_DATA) +SUFFIXES = .$(APP_MAN_SUFFIX) .man + +# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure +.man.$(APP_MAN_SUFFIX): + $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@ diff --git a/app/editres/man/Makefile.in b/app/editres/man/Makefile.in new file mode 100644 index 000000000..eaf351e15 --- /dev/null +++ b/app/editres/man/Makefile.in @@ -0,0 +1,458 @@ +# Makefile.in generated by automake 1.12.5 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994-2012 Free Software Foundation, Inc. + +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +VPATH = @srcdir@ +am__make_dryrun = \ + { \ + am__dry=no; \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \ + | grep '^AM OK$$' >/dev/null || am__dry=yes;; \ + *) \ + for am__flg in $$MAKEFLAGS; do \ + case $$am__flg in \ + *=*|--*) ;; \ + *n*) am__dry=yes; break;; \ + esac; \ + done;; \ + esac; \ + test $$am__dry = yes; \ + } +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = man +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = +SOURCES = +DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = f=`echo $$p | sed -e 's|^.*/||'`; +am__install_max = 40 +am__nobase_strip_setup = \ + srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*|]/\\\\&/g'` +am__nobase_strip = \ + for p in $$list; do echo "$$p"; done | sed -e "s|$$srcdirstrip/||" +am__nobase_list = $(am__nobase_strip_setup); \ + for p in $$list; do echo "$$p $$p"; done | \ + sed "s| $$srcdirstrip/| |;"' / .*\//!s/ .*/ ./; s,\( .*\)/[^/]*$$,\1,' | \ + $(AWK) 'BEGIN { files["."] = "" } { files[$$2] = files[$$2] " " $$1; \ + if (++n[$$2] == $(am__install_max)) \ + { print $$2, files[$$2]; n[$$2] = 0; files[$$2] = "" } } \ + END { for (dir in files) print dir, files[dir] }' +am__base_list = \ + sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ + sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + test -z "$$files" \ + || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && rm -f $$files; }; \ + } +am__installdirs = "$(DESTDIR)$(appmandir)" +DATA = $(appman_DATA) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +ADMIN_MAN_DIR = @ADMIN_MAN_DIR@ +ADMIN_MAN_SUFFIX = @ADMIN_MAN_SUFFIX@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +APPDEFS_CFLAGS = @APPDEFS_CFLAGS@ +APPDEFS_LIBS = @APPDEFS_LIBS@ +APP_MAN_DIR = @APP_MAN_DIR@ +APP_MAN_SUFFIX = @APP_MAN_SUFFIX@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +BASE_CFLAGS = @BASE_CFLAGS@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CHANGELOG_CMD = @CHANGELOG_CMD@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CWARNFLAGS = @CWARNFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DRIVER_MAN_DIR = @DRIVER_MAN_DIR@ +DRIVER_MAN_SUFFIX = @DRIVER_MAN_SUFFIX@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EDITRES_CFLAGS = @EDITRES_CFLAGS@ +EDITRES_LIBS = @EDITRES_LIBS@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FILE_MAN_DIR = @FILE_MAN_DIR@ +FILE_MAN_SUFFIX = @FILE_MAN_SUFFIX@ +GREP = @GREP@ +INSTALL = @INSTALL@ +INSTALL_CMD = @INSTALL_CMD@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LDFLAGS = @LDFLAGS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIB_MAN_DIR = @LIB_MAN_DIR@ +LIB_MAN_SUFFIX = @LIB_MAN_SUFFIX@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MAN_SUBSTS = @MAN_SUBSTS@ +MISC_MAN_DIR = @MISC_MAN_DIR@ +MISC_MAN_SUFFIX = @MISC_MAN_SUFFIX@ +MKDIR_P = @MKDIR_P@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRICT_CFLAGS = @STRICT_CFLAGS@ +STRIP = @STRIP@ +VERSION = @VERSION@ +XORG_MAN_PAGE = @XORG_MAN_PAGE@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +appdefaultdir = @appdefaultdir@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +appmandir = $(APP_MAN_DIR) +appman_PRE = editres.man +appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX)) +EXTRA_DIST = $(appman_PRE) +CLEANFILES = $(appman_DATA) +SUFFIXES = .$(APP_MAN_SUFFIX) .man +all: all-am + +.SUFFIXES: +.SUFFIXES: .$(APP_MAN_SUFFIX) .man +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign man/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign man/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): +install-appmanDATA: $(appman_DATA) + @$(NORMAL_INSTALL) + @list='$(appman_DATA)'; test -n "$(appmandir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(appmandir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(appmandir)" || exit 1; \ + fi; \ + for p in $$list; do \ + if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; \ + done | $(am__base_list) | \ + while read files; do \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(appmandir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(appmandir)" || exit $$?; \ + done + +uninstall-appmanDATA: + @$(NORMAL_UNINSTALL) + @list='$(appman_DATA)'; test -n "$(appmandir)" || list=; \ + files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ + dir='$(DESTDIR)$(appmandir)'; $(am__uninstall_files_from_dir) +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + +cscope cscopelist: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile $(DATA) +installdirs: + for dir in "$(DESTDIR)$(appmandir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-appmanDATA + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-appmanDATA + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic distclean \ + distclean-generic distdir dvi dvi-am html html-am info info-am \ + install install-am install-appmanDATA install-data \ + install-data-am install-dvi install-dvi-am install-exec \ + install-exec-am install-html install-html-am install-info \ + install-info-am install-man install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic pdf \ + pdf-am ps ps-am uninstall uninstall-am uninstall-appmanDATA + + +# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure +.man.$(APP_MAN_SUFFIX): + $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@ + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/app/editres/man/editres.man b/app/editres/man/editres.man new file mode 100644 index 000000000..4999634b5 --- /dev/null +++ b/app/editres/man/editres.man @@ -0,0 +1,421 @@ +'\" t +.\" Copyright 1993, 1994, 1998 The Open Group +.\" +.\" Permission to use, copy, modify, distribute, and sell this software and its +.\" documentation for any purpose is hereby granted without fee, provided that +.\" the above copyright notice appear in all copies and that both that +.\" copyright notice and this permission notice appear in supporting +.\" documentation. +.\" +.\" The above copyright notice and this permission notice shall be included +.\" in all copies or substantial portions of the Software. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR +.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +.\" OTHER DEALINGS IN THE SOFTWARE. +.\" +.\" Except as contained in this notice, the name of The Open Group shall +.\" not be used in advertising or otherwise to promote the sale, use or +.\" other dealings in this Software without prior written authorization +.\" from The Open Group. +.\" +.\" +.TH EDITRES 1 __xorgversion__ +.SH NAME +editres \- a dynamic resource editor for X Toolkit applications +.SH SYNTAX +\fBeditres\fP [ \fI\-toolkitoption\fP .\|.\|. ] +.SH OPTIONS +.I Editres +accepts all of the standard X Toolkit command line +options (see \fIX(__miscmansuffix__)\fP). The order of the command line options is +not important. +.SH DESCRIPTION +Editres is a tool that allows users and application developers to view +the full widget hierarchy of any X Toolkit application that speaks the +Editres protocol. In addition, editres will help the user construct +resource specifications, allow the user to apply the resource to +the application and view the results dynamically. Once the user is +happy with a resource specification editres will append the resource +string to the user's X Resources file. +.SH USING EDITRES +.I Editres +provides a window consisting of the following four areas: +.IP "Menu Bar" 25 +A set of popup menus that allow you full access to editres's features. +.IP "Panner" +The panner allows a more intuitive way to scroll the application tree display. +.IP "Message Area" +Displays information to the user about the action that editres expects +of her. +.IP "Application Widget Tree" 25 +This area will be used to display the selected application's widget tree. +.LP +To begin an editres session select the \fBGet Widget Tree\fP menu item from +the command menu. This will change the pointer cursor to cross hair. +You should now select the application you wish look at by clicking on +any of its windows. If this application understands the editres +protocol then editres will display the application's widget tree in its +tree window. If +the application does not understand the editres protocol editres will +inform you of this fact in the message area after a few seconds delay. +.LP +Once you have a widget tree you may now select any of the other menu +options. The effect of each of these is described below. +.SH COMMANDS +.IP "Get Widget Tree" 8 +Allows the user to click on any application that speaks the editres +protocol and receive its widget tree. +.IP "Refresh Current Widget Tree" +Editres only knows about the widgets that exist at the present time. +Many applications create and destroy widgets on the fly. Selecting +this menu item will cause editres to ask the application to resend its +widget tree, thus updating its information to the new state of the application. +.IP +For example, +xman only creates the widgets for its \fItopbox\fP when it +starts up. None of the widgets for the manual page window are created +until the user actually clicks on the \fIManual Page\fP button. If +you retrieved +xman's widget tree before the the manual page is active, you may +wish to refresh the widget tree after the manual page has been +displayed. This will allow you to also edit the manual page's resources. +.IP "Dump Widget Tree to a File" +For documenting applications it is often useful to be able to +dump the entire application widget tree to an ASCII file. This file +can then be included in the manual page. When this menu item is selected +a popup dialog is activated. Type the name of the file in this +dialog, and either select \fIokay\fP, or type a carriage-return. Editres +will now dump the widget tree to this file. To cancel the file dialog, +select the \fIcancel\fP button. +.IP "Show Resource Box" +This command will popup a resource box for the current application. This +resource box (described in detail below) will allow the user to see +exactly which resources can be set for the widget that is currently +selected in the widget tree display. Only one widget may be currently +selected; if greater or fewer are selected editres will refuse to +pop up the resource box and put an error message in the \fBMessage Area\fP. +.IP "Set Resource" +This command will popup a simple dialog box for setting an arbitrary +resource on all selected widgets. You must type in the resource name, +as well as the value. You can use the Tab key to switch between the +resource name field the resource value field. +.IP "Quit" +Exits editres. +.SH TREE COMMANDS +The \fBTree\fP menu contains several commands that allow operations to +be performed on the widget tree. +.IP "Select Widget in Client" +This menu item allows you to select any widget in the application; editres +will then highlight the corresponding element the widget tree display. +Once +this menu item is selected the pointer cursor will again turn to a +crosshair, and you must click any pointer button in the widget you +wish to have displayed. Since some widgets are fully obscured by +their children, it is not possible to get to every widget this way, +but this mechanism does give very useful feedback between the elements +in the widget tree and those in the actual application. +.IP "Select All" +.IP "Unselect All" +.IP "Invert All" +These functions allow the user to select, unselect, or invert all +widgets in the widget tree. +.IP "Select Children" +.IP "Select Parents" +These functions select the immediate parent or children of each of the +currently selected widgets. +.IP "Select Descendants" +.IP "Select Ancestors" +These functions select all parents or children of each of the +currently selected widgets. This is a recursive search. +.IP "Show Widget Names" +.IP "Show Class Names" +.IP "Show Widget IDs" +.IP "Show Widget Windows" +When the tree widget is initially displayed the labels of each widget +in the tree correspond to the widget names. These functions will +cause the label of \fBall\fP widgets in the tree to be changed to show the +class name, IDs, or window associated with each widget in the application. +The widget IDs, and windows are shown as hex numbers. +.LP +In addition there are keyboard accelerators for each of the +Tree operations. If the input focus is over an individual widget in +the tree, then that operation will only effect that widget. If the +input focus is in the Tree background it will have +exactly the same effect as the corresponding menu item. +.LP +The translation +entries shown may be applied to any widget in the application. If +that widget is a child of the Tree widget, then it will only affect that +widget, otherwise it will have the same effect as the commands in the +tree menu. +.IP "Flash Active Widgets" +This command is the inverse of the \fBSelect Widget in Client\fP +command, it will show the user each widget that is currently selected in +the widget tree, by flashing the corresponding widget in the +application \fInumFlashes\fP (three by default) times in the +\fIflashColor\fP. +.sp +.TS +lb lb lb +l l l. +Key Option Translation Entry +- +space Unselect Select(nothing) +w Select Select(widget) +s Select Select(all) +i Invert Select(invert) +c Select Children Select(children) +d Select Descendants Select(descendants) +p Select Parent Select(parent) +a Select Ancestors Select(ancestors) +N Show Widget Names Relabel(name) +C Show Class Names Relabel(class) +I Show Widget IDs Relabel(id) +W Show Widget Windows Relabel(window) +T Toggle Widget/Class Name Relabel(toggle) +.TE +.sp +Clicking button 1 on a widget adds it to the set of selected widgets. +Clicking button 2 on a widget deselects all other widgets and then +selects just that widget. +Clicking button 3 on a widget toggles its label between the widget's +instance name the widget's class name. +.sp +.SH USING THE RESOURCE BOX +The resource box contains five different areas. Each of the areas, +as they appear on the screen, from top to bottom will be discussed. +.IP "The Resource Line" +This area at the top of the resource box shows the current resource +name exactly as it would appear if you were to save it to a file or +apply it. +.IP "The Widget Names and Classes" +This area allows you to select exactly which widgets this resource will +apply to. The area contains four lines, the first contains the +name of the selected widget and all its ancestors, and the more restrictive +dot (\fB.\fP) separator. The second line contains less specific the +Class names +of each widget, and well as the less restrictive star (\fB*\fP) separator. +The third line contains a set of special buttons called \fBAny Widget\fP +which will generalize this level to match any widget. +The last line contains a set of special buttons called \fBAny +Widget Chain\fP which will turn the single level into something that +matches zero or more levels. +.sp +The initial state of this area is the most restrictive, using the +resource names and the dot separator. By selecting the other buttons +in this area you can ease the restrictions to allow more and more widgets +to match the specification. The extreme case is to select all the +\fBAny Widget Chain\fP buttons, which will match every widget in the +application. As you select different buttons the tree display will update +to show you exactly which widgets will be effected by the current +resource specification. +.IP "Normal and Constraint Resources" +The next area allows you to select the name of the normal or +constraint resources you wish to set. Some widgets may not have constraint +resources, so that area will not appear. +.IP "Resource Value" +This next area allows you to enter the resource value. This value +should be entered exactly as you would type a line into your resource file. +Thus it should contain no unescaped new-lines. There are a few +special character sequences for this file: +.sp +\\n - This will be replaced with a newline. +.sp +\\### - Where # is any octal digit. This will be replaced with a +single byte that contains this sequence interpreted as an octal number. +For example, a value containing a NULL byte can be stored by +specifying \\000. +.sp +\\<new-line> - This will compress to nothing. +.sp +\\\\ - This will compress to a single backslash. +.IP "Command Area" +This area contains several command buttons, described in +this section. +.IP "Set Save File" +This button allows the user to modify file that the resources +will be saved to. This button will bring up a dialog box that will +ask you for a filename; once the filename has been entered, either hit +carriage-return or click on the \fIokay\fP button. To pop down the +dialog box without changing the save file, click the \fIcancel\fP button. +.IP "Save" +This button will append the \fBresource line\fP described above to the +end of the current save file. If no save file has been set the \fBSet +Save File\fP dialog box will be popped up to prompt the user for a filename. +.IP "Apply" +This button attempts to perform a XtSetValues call on all widgets +that match the \fBresource line\fP described above. The value specified +is applied directly to all matching widgets. This behavior is an attempt +to give a dynamic feel to the resource editor. Since this feature allows +users to put an application in states it may not be willing to handle, +a hook has been provided to allow specific applications to +block these SetValues +requests (see \fBBlocking Editres Requests\fP below). +.sp +Unfortunately due to design constraints imposed on the widgets by the X +Toolkit and the Resource Manager, trying to coerce an inherently +static system into dynamic behavior can cause strange results. There +is no guarantee that the results of an apply will be the same as what +will happen when you save the value and restart the application. +This functionality is provided to try to give you a rough feel for what +your changes will accomplish, and the results obtained should be considered +suspect at best. Having said that, this is one of the neatest +features of editres, and I strongly suggest that you play with it, and +see what it can do. +.IP "Save and Apply" +This button combines the Save and Apply actions described above into +one button. +.IP "Popdown Resource Box" +This button will remove the resource box from the display. +.SH BLOCKING EDITRES REQUESTS +The editres protocol has been built into the Athena Widget set. This allows +all applications that are linked against Xaw to be able to speak to the +resource editor. While this provides great flexibility, and is a +useful tool, it can quite easily be abused. It is therefore possible +for any Xaw application to specify a value for the \fBeditresBlock\fP +resource described below, to keep editres from divulging information +about its internals, or to disable the \fBSetValues\fP part of the protocol. +.TP 8 +.B editresBlock (\fPClass\fB EditresBlock) +Specifies which type of blocking this application wishes to impose on the +editres protocol. +.LP +The accepted values are: +.IP all 15 +Block all requests. +.IP setValues +Block all SetValues requests. As this is the only editres request that +actually modifies the application, this is in effect stating that the +application is read-only. +.IP none +Allow all editres requests. +.LP +Remember that these resources are set on any Xaw application, \fBnot +editres\fP. They allow individual applications to keep all or some +of the requests editres makes from ever succeeding. Of course, +editres is also an Xaw application, so it may also be viewed and modified +by editres (rather recursive, I know), these commands can be blocked +by setting the \fBeditresBlock\fP resource on editres itself. +.SH RESOURCES +For \fIeditres\fP the available application resources are: +.TP 8 +.B numFlashes (\fPClass\fB NumFlashes) +Specifies the number of times the widgets in the application +will be flashed when the \fBShow Active Widgets\fP command in invoked. +.TP 8 +.B flashTime (\fPClass\fB FlashTime) +Amount of time between the flashes described above. +.TP 8 +.B flashColor (\fPClass\fB flashColor) +Specifies the color used to flash application widgets. A bright color +should be used that will immediately draw your attention to the area being +flashed, such as red or yellow. +.TP 8 +.B saveResourcesFile (\fPClass\fB SaveResourcesFile) +This is the file the resource line will be append to when the \fBSave\fP +button activated in the resource box. +.SH WIDGETS +In order to specify resources, it is useful to know the hierarchy of +the widgets which compose \fIeditres\fP. In the notation below, +indentation indicates hierarchical structure. The widget class name +is given first, followed by the widget instance name. +.sp +.nf +.TA .5i 1.0i 1.5i 2.0i +.ta .5i 1.0i 1.5i 2.0i +Editres editres + Paned paned + Box box + MenuButton commands + SimpleMenu menu + SmeBSB sendTree + SmeBSB refreshTree + SmeBSB dumpTreeToFile + SmeLine line + SmeBSB getResourceList + SmeLine line + SmeBSB quit + MenuButton treeCommands + SimpleMenu menu + SmeBSB showClientWidget + SmeBSB selectAll + SmeBSB unselectAll + SmeBSB invertAll + SmeLine line + SmeBSB selectChildren + SmeBSB selectParent + SmeBSB selectDescendants + SmeBSB selectAncestors + SmeLine line + SmeBSB showWidgetNames + SmeBSB showClassNames + SmeBSB showWidgetIDs + SmeBSB showWidgetWindows + SmeLine line + SmeBSB flashActiveWidgets + Paned hPane + Panner panner + Label userMessage + Grip grip + Porthole porthole + Tree tree + Toggle <name of widget in application> + . + . + . + TransientShell resourceBox + Paned pane + Label resourceLabel + Form namesAndClasses + Toggle dot + Toggle star + Toggle any + Toggle name + Toggle class + . + . + . + Label namesLabel + List namesList + Label constraintLabel + List constraintList + Form valueForm + Label valueLabel + Text valueText + Box commandBox + Command setFile + Command save + Command apply + Command saveAndApply + Command cancel + Grip grip + Grip grip +.fi +.sp +.SH ENVIRONMENT +.PP +.TP 8 +.B DISPLAY +to get the default host and display number. +.TP 8 +.B XENVIRONMENT +to get the name of a resource file that overrides the global resources +stored in the RESOURCE_MANAGER property. +.SH FILES +.TP +.I __apploaddir__/Editres +specifies required resources +.SH SEE ALSO +X(__miscmansuffix__), xrdb(__appmansuffix__), Athena Widget Set +.SH RESTRICTIONS +This is a prototype, there are lots of nifty features I would love to add, +but I hope this will give you some ideas about what a resource editor +can do. +.SH AUTHOR +Chris D. Peterson, formerly MIT X Consortium + |