summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoruint <abhinav.prsai@gmail.com>2025-12-14 19:31:09 +0000
committeruint <abhinav.prsai@gmail.com>2025-12-14 19:31:14 +0000
commitab931cbfeb4b3f7f67a6e03dfec14d3771be30af (patch)
tree2dc29d9444b21cf39cc0fe689ecdcacd7c0fc4fe
parent70dd7a54b1bd0e4709bdb7e5123d421724e6bf2f (diff)
add manpage
-rw-r--r--xnap.156
1 files changed, 56 insertions, 0 deletions
diff --git a/xnap.1 b/xnap.1
new file mode 100644
index 0000000..d255c85
--- /dev/null
+++ b/xnap.1
@@ -0,0 +1,56 @@
+.TH XNAP 1 xnap\-1.0
+.SH NAME
+xnap \- minimal X11 screenshot utility
+.SH SYNOPSIS
+.B xnap
+.RB [ \-f ]
+.RB [ \-w ]
+.RB [ \-s
+.IR n ]
+.SH DESCRIPTION
+.B xnap
+captures screen contents from an X11 display and writes to a PPM6 image
+to standard output.
+.PP
+By default,
+.B xnap
+allows the user to select a rectangular region using the mouse.
+The selection rectangle is drawn, inverted then removed after the selection
+is complete.
+.SH OPTIONS
+.TP
+.B \-f
+Capture the full root window; the whole screen.
+.TP
+.B \-w
+Capture the window currently under the pointer.
+.TP
+.BI \-s " N"
+Capture screen N
+.I n
+as reported by the Xinerama extension.
+.SH OUTPUT
+.B xnap
+writes a PPM (P6) image to stdout.
+.SH USAGE
+Redirect output to a file or pipe it to another program:
+.PP
+.nf
+xnap > image.ppm
+xnap \-f | converto... whatever.png
+.fi
+.SH ENVIRONMENT
+.TP
+.B DISPLAY
+Specifies the X11 display to connect to.
+.SH DEPENDENCIES
+.B xnap
+requires Xlib.
+Optional Xinerama support may be enabled at compile time.
+.SH AUTHORS
+Written by uint.
+.SH LICENSE
+See the LICENSE file for the terms of redistribution.
+.SH SEE ALSO
+.BR X (7),
+.BR ppm (5)