mirror/sway
1
1
Fork 0
mirror of https://github.com/swaywm/sway synced 2024-11-23 17:32:40 +01:00
Code Issues
2dace6b824
sway/contrib/grimshot.1

105 lines
2.2 KiB
Groff
Raw Normal View History

grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
.\" Generated by scdoc 1.11.1
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.nh
.ad l
.\" Begin generated content:
grimshot: document support for piping to STDOUT.
2021-02-23 16:20:45 +01:00
.TH "grimshot" "1" "2021-02-23"
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
.SH NAME
.P
grimshot - a helper for screenshots within sway
.P
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
.SH SYNOPSIS
.P
\fBgrimshot\fR [--notify] (copy|save) [TARGET] [FILE]
.br
\fBgrimshot\fR check
.br
\fBgrimshot\fR usage
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
.SH OPTIONS
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
\fB--notify\fR
.RS 4
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
Show notifications to the user that a screenshot has been taken.\&
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
.RE
\fBsave\fR
.RS 4
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
Save the screenshot into a regular file.\& Grimshot will write images
files to \fBXDG_SCREENSHOTS_DIR\fR if this is set (or defined
in \fBuser-dirs.\&dir\fR), or otherwise fall back to \fBXDG_PICTURES_DIR\fR.\&
grimshot: document support for piping to STDOUT.
2021-02-23 16:20:45 +01:00
Set FILE to '-' to pipe the output to STDOUT.\&
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
.RE
\fBcopy\fR
.RS 4
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
Copy the screenshot data (as image/png) into the clipboard.\&
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
.RE
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
.SH DESCRIPTION
.P
Grimshot is an easy-to-use screenshot utility for sway.\& It provides a
convenient interface over grim, slurp and jq, and supports storing the
screenshot either directly to the clipboard using wl-copy or to a file.\&
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
.SH EXAMPLES
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
An example usage pattern is to add these bindings to your sway config:
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
.nf
.RS 4
# Screenshots:
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
# Super+P: Current window
# Super+Shift+p: Select area
# Super+Alt+p Current output
# Super+Ctrl+p Select a window
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
Fix some mistakes in grimshot docs
2020-05-08 04:56:25 +02:00
bindsym Mod4+p exec grimshot save active
bindsym Mod4+Shift+p exec grimshot save area
bindsym Mod4+Mod1+p exec grimshot save output
bindsym Mod4+Ctrl+p exec grimshot save window
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.fi
.RE
.P
.SH TARGETS
.P
grimshot can capture the following named targets:
.P
\fIactive\fR
.RS 4
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
Captures the currently active window.\&
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
.RE
\fIscreen\fR
.RS 4
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
Captures the entire screen.\& This includes all visible outputs.\&
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
.RE
Fix some mistakes in grimshot docs
2020-05-08 04:56:25 +02:00
\fIarea\fR
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.RS 4
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
Allows manually selecting a rectangular region, and captures that.\&
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
.RE
\fIwindow\fR
.RS 4
Allows manually selecting a single window (by clicking on it), and
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
captures it.\&
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
.RE
\fIoutput\fR
.RS 4
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
Captures the currently active output.\&
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
.RE
.SH OUTPUT
.P
grimshot: Fix man page issues This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
2020-12-20 07:33:32 +01:00
Grimshot will print the filename of the captured screenshot to stdout if called
with the \fIsave\fR subcommand.\&
grimshot: Add a man page
2020-05-01 11:57:48 +02:00
.P
.SH SEE ALSO
.P
\fBgrim\fR(1)
Copy Permalink