summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorGaetan Nadon <memsize@videotron.ca>2011-01-19 10:06:55 -0500
committerGaetan Nadon <memsize@videotron.ca>2011-01-19 10:06:55 -0500
commit81129a226ae24600642249847cdcc980ec5f9d18 (patch)
tree7c8620eb04768187635a506ae88bfa544fb47b73 /man
parent936aa5b9bbbe3a2bf08f928fa5f186d2b75e0a71 (diff)
config: move man pages into their own directory
Use services provided by XORG_MANPAGE_SECTIONS. Use standard Makefile for man pages. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am12
-rw-r--r--man/xclipboard.man151
-rw-r--r--man/xcutsel.man106
3 files changed, 269 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..bbaa367
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,12 @@
+
+appmandir = $(APP_MAN_DIR)
+appman_PRE = xclipboard.man xcutsel.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/man/xclipboard.man b/man/xclipboard.man
new file mode 100644
index 0000000..64474e8
--- /dev/null
+++ b/man/xclipboard.man
@@ -0,0 +1,151 @@
+.\" Copyright 1988, 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 XCLIPBOARD 1 __xorgversion__
+.SH NAME
+xclipboard \- X clipboard client
+.SH SYNOPSIS
+\fBxclipboard\fP [ \fI\-toolkitoption\fP ... ] [ \fB\-w\fP ]
+[ \fB\-nw\fP ]
+.SH DESCRIPTION
+The \fIxclipboard\fP program is used to collect and display text selections
+that are sent to the CLIPBOARD by other clients. It is typically used to
+save CLIPBOARD selections for later use. It stores each CLIPBOARD selection
+as a separate string, each of which can be selected. Each time CLIPBOARD
+is asserted by another application, \fIxclipboard\fP transfers the contents
+of that selection to a new buffer and displays it in the text window.
+Buffers are never automatically deleted, so you'll want to use the delete
+button to get rid of useless items.
+.PP
+Since \fIxclipboard\fP uses a Text Widget to display the contents of the
+clipboard, text sent to the CLIPBOARD may be re-selected for use in other
+applications. \fIxclipboard\fP also responds to requests for the CLIPBOARD
+selection from other clients by sending the entire contents of the currently
+displayed buffer.
+.PP
+An \fIxclipboard\fP window has the following buttons across the top:
+.TP 8
+.I quit
+When this button is pressed, \fIxclipboard\fP exits.
+.TP 8
+.I delete
+When this button is pressed, the current buffer is deleted and the
+next one displayed.
+.TP 8
+.I new
+Creates a new buffer with no contents. Useful in constructing a new
+CLIPBOARD selection by hand.
+.TP 8
+.I save
+Displays a File Save dialog box.
+Pressing the Accept button saves the currently
+displayed buffer to the file specified in the text field.
+.TP 8
+.I next
+Displays the next buffer in the list.
+.TP 8
+.I previous
+Displays the previous buffer.
+.SH OPTIONS
+The \fIxclipboard\fP program accepts all of the standard X Toolkit command
+line options as well as the following:
+.TP 8
+.B \-w
+This option indicates that lines of text that are too long to be displayed on
+one line in the clipboard should wrap around to the following lines.
+.TP 8
+.B \-nw
+This option indicates that long lines of text should not wrap around. This
+is the default behavior.
+.SH WIDGETS
+In order to specify resources, it is useful to know the hierarchy of
+the widgets which compose \fIxclipboard\fR. 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
+.ta .5i 1.0i 1.5i
+XClipboard xclipboard
+ Form form
+ Command Quit
+ Command delete
+ Command new
+ Command Save
+ Command next
+ Command prev
+ Label index
+ Text text
+ TransientShell fileDialogShell
+ Dialog fileDialog
+ Label label
+ Command accept
+ Command cancel
+ Text value
+ TransientShell failDialogShell
+ Dialog failDialog
+ Label label
+ Command continue
+.fi
+.sp
+.SH SENDING/RETRIEVING CLIPBOARD CONTENTS
+Text is copied to the clipboard whenever a client asserts ownership of the
+\fBCLIPBOARD\fP selection. Text is copied from the clipboard whenever a
+client requests the contents of the \fBCLIPBOARD\fP selection. Examples of
+event bindings that a user may wish to include in a resource configuration
+file to use the clipboard are:
+.sp
+.nf
+.TA .5i
+.ta .5i 3.0i
+*VT100.Translations: #override \\
+ <Btn3Up>: select-end(CLIPBOARD) \\n\\
+ <Btn2Up>: insert-selection(PRIMARY,CLIPBOARD) \\n\\
+ <Btn2Down>: ignore ()
+
+.fi
+.sp
+.SH "SEE ALSO"
+X(__miscmansuffix__), xcutsel(__appmansuffix__), xterm(__appmansuffix__), individual client documentation for how to make a
+selection and send it to the CLIPBOARD.
+.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__/XClipboard
+specifies required resources
+.SH AUTHOR
+Ralph R. Swick, DEC/MIT Project Athena
+.br
+Chris D. Peterson, MIT X Consortium
+.br
+Keith Packard, MIT X Consortium
diff --git a/man/xcutsel.man b/man/xcutsel.man
new file mode 100644
index 0000000..c122872
--- /dev/null
+++ b/man/xcutsel.man
@@ -0,0 +1,106 @@
+.\" Copyright 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 XCUTSEL 1 __xorgversion__
+.SH NAME
+xcutsel - interchange between cut buffer and selection
+.SH SYNOPSIS
+\fBxcutsel\fP [ \fI-toolkitoption\fP ...] [-selection \fIselection\fP] [-cutbuffer \fInumber\fP]
+.SH DESCRIPTION
+The \fIxcutsel\fP program is used to copy the current selection into a
+cut buffer and to make a selection that contains the current contents of
+the cut buffer. It acts as a bridge between applications that don't support
+selections and those that do.
+.PP
+By default, \fIxcutsel\fP will use the selection named PRIMARY and the cut
+buffer CUT_BUFFER0. Either or both of these can be overridden by command
+line arguments or by resources.
+.PP
+An \fIxcutsel\fP window has the following buttons:
+.TP 8
+.I " quit"
+When this button is pressed, \fIxcutsel\fP exits. Any selections held by
+\fIxcutsel\fP are automatically released.
+.TP 8
+.I " copy PRIMARY to 0"
+When this button is pressed, \fIxcutsel\fP copies the current selection into
+the cut buffer.
+.TP 8
+.I " copy 0 to PRIMARY"
+When this button is pressed, \fIxcutsel\fP converts the current contents of
+the cut buffer into the selection.
+.PP
+The button labels reflect the selection and cutbuffer selected by
+command line options or through the resource database.
+.PP
+When the ``copy 0 to PRIMARY'' button is activated, the button will
+remain inverted as long as \fIxcutsel\fP remains the owner of the
+selection. This serves to remind you which client owns the current
+selection. Note that the value of the selection remains constant;
+if the cutbuffer is changed, you must again activate the copy button
+to retrieve the new value when desired.
+.SH OPTIONS
+.I Xcutsel
+accepts all of the standard X Toolkit command line options as well as the
+following:
+.TP 8
+.B \-selection \fIname\fP
+This option specifies the name of the selection to use. The default is
+PRIMARY. The only supported abbreviations for this option are ``-select'',
+``-sel'' and ``-s'', as the standard toolkit option ``-selectionTimeout'' has a
+similar name.
+.TP 8
+.B \-cutbuffer \fInumber\fP
+This option specifies the cut buffer to use. The default is cut buffer 0.
+.SH X DEFAULTS
+This program accepts all of the standard X Toolkit resource names and classes
+as well as:
+.TP 8
+.B "selection (\fPclass\fB Selection)"
+This resource specifies the name of the selection to use. The default is
+PRIMARY.
+.TP 8
+.B "cutBuffer (\fPclass\fB CutBuffer)"
+This resource specifies the number of the cut buffer to use. The default is 0.
+.SH WIDGET NAMES
+The following instance names may be used when user configuration of the
+labels in them is desired:
+.TP 8
+.B "sel-cut (\fPclass\fB Command)"
+This is the ``copy SELECTION to BUFFER'' button.
+.TP 8
+.B "cut-sel (\fPclass\fB Command)"
+This is the ``copy BUFFER to SELECTION'' button.
+.TP 8
+.B "quit (\fPclass\fB Command)"
+This is the ``quit'' button.
+.SH "SEE ALSO"
+X(__miscmansuffix__), xclipboard(__appmansuffix__), xterm(__appmansuffix__), text widget documentation, individual client
+documentation for how to make a selection.
+.SH BUGS
+There is no way to change the name of the selection or the number of the
+cut buffer while the program is running.
+.SH AUTHOR
+Ralph R. Swick, DEC/MIT Project Athena