diff options
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | vis-clipboard.1 | 105 |
2 files changed, 107 insertions, 0 deletions
@@ -96,8 +96,10 @@ install: vis vis-menu @mkdir -p ${DESTDIR}${MANPREFIX}/man1 @sed -e "s/VERSION/${VERSION}/g" < vis.1 > ${DESTDIR}${MANPREFIX}/man1/vis.1 @sed -e "s/VERSION/${VERSION}/g" -e "s/MONTH DAY, YEAR/$(date +'%B %m, %Y')/g" < vis-menu.1 > ${DESTDIR}${MANPREFIX}/man1/vis-menu.1 + @sed -e "s/VERSION/${VERSION}/g" -e "s/MONTH DAY, YEAR/$(date +'%B %m, %Y')/g" < vis-clipboard.1 > ${DESTDIR}${MANPREFIX}/man1/vis-clipboard.1 @chmod 644 ${DESTDIR}${MANPREFIX}/man1/vis.1 @chmod 644 ${DESTDIR}${MANPREFIX}/man1/vis-menu.1 + @chmod 644 ${DESTDIR}${MANPREFIX}/man1/vis-clipboard.1 uninstall: @echo removing executable file from ${DESTDIR}${PREFIX}/bin diff --git a/vis-clipboard.1 b/vis-clipboard.1 new file mode 100644 index 0000000..e91023b --- /dev/null +++ b/vis-clipboard.1 @@ -0,0 +1,105 @@ +.Dd MONTH DAY, YEAR +.Os Vis VERSION +.Dt VIS-CLIPBOARD 1 + +.Sh NAME +.Nm vis-clipboard +.Nd Read from or write to the system clipboard + +.Sh SYNOPSIS +.Nm vis-clipboard +.Fl -usable +.Pp +.Nm vis-clipboard +.Fl -copy +.Pp +.Nm vis-clipboard +.Fl -paste + +.Sh DESCRIPTION +.Nm vis-clipboard +wraps various system-specific tools for interacting with a system clipboard, +like +.Xr xsel 1 +for X11, +.Xr pbcopy 1 +for Mac OS X, +and +.Pa /dev/clipboard +on Cygwin. +.Pp +.Nm vis-clipboard +can run in three different ways, +depending on the flag given on the command-line. +.Bl -tag -width flag +.It Fl -usable +In this mode, +.Nm vis-clipboard +looks for a way to interface with the system clipboard. +If it finds one, +it terminates with exit code 0. +If no interface to the system clipboard is available, +it terminates with exit code 1. +.It Fl -copy +In this mode, +.Nm vis-clipboard +reads the content of standard input, +and stores it in the system clipboard. +.It Fl -paste +In this mode, +.Nm vis-clipboard +reads the content of the system clipboard, +and writes it to standard output. +.El + +.Sh ENVIRONMENT + +The following environment variables affect the operation of +.Nm vis-clipboard : + +.Bl -tag -width .Ev +.It Ev DISPLAY +If non-empty, +.Nm vis-clipboard +will prefer to access the X11 clipboard even if other options are available. +.El + +.Sh EXIT STATUS +.Ex -std vis-clipboard + +When run with the +.Fl -usable +flag, +an exit status of 0 means that it found a supported system-specific tool, +while 1 means that clipboard access is not available. + +.Sh EXAMPLES + +Test whether clipboard access is available: +.Bd -literal -offset indent +if vis-clipboard --usable; then + echo "Clipboard access available" +else + echo "No clipboard" +fi +.Ed + +Copy a friendly greeting to the clipboard: +.Bd -literal -offset indent +echo "Hello, World" | vis-clipboard --copy +.Ed + +Send the current contents of the system clipboard to be recorded and analyzed: +.Bd -literal -offset indent +vis-clipboard --paste | curl -d - https://www.nsa.gov/ +.Ed + +.Sh SEE ALSO +.Xr pbcopy 1 , +.Xr pbpaste 1 , +.Xr xclip 1 , +.Xr xsel 1 , +.Xr vis 1 +.Sh AUTHORS + +.An "Marc Andr\('e Tanner" Aq mat@brain-dump.org |