Skip to content

Added man page #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iwasMateo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added man page #149

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions hyprshot.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.\" Man page for hyprshot
.\" GNU General Public License
.\" Original Author: Gustasch
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License
.TH "Hyprshot" "1" "15. March 2026" "Gustash" "documentation"
.SH "NAME "
Hyprshot
.SH "Synopsis "
\fBhyprshot\fP [options ..] [\-m [mode] .. ] \-\- [command]
.SH "DESCRIPTION "
\fPhyprshot\fP is a screenshot application for the Hyprland desktop environment and window manager. It acts as a simplification of versions with grim and slurp, to make it easier to use.
.SS "Options "
.TP
\fB\-h, \-\-help\fP
show help message
.TP
\fB\-m, \-\-mode\fP
chooses mode. Must be one of: output, window, region, active, OUTPUT_NAME
.TP
\fB\-o, \-\-output\-folder\fP
directory in which to save the screenshot (temporary)
.TP
\fB\-f, \-\-filename\fP
the file name of the resulting screenshot
.TP
\fB\-z, \-\-freeze\fP
freeze the screen when taking the screenshot
.TP
\fB\-d, \-\-debug\fP
print debug info
.TP
\fB\-s, \-\-silent\fP
don't send a notification when screenshot is saved
.TP
\fB\-r, \-\-raw\fP
output raw image data to stdout
.TP
\fB\-t, \-\-notif\-timeout\fP
notification timeout in milliseconds (default 5000)
.TP
\fB\-\-clipboard\-only\fB
copy screenshot to clipboard and don't save image in disk
.TP
\fB\-\- [command]\fP
open screenshot with a command of your choosing. e.g. hyprshot \-m window \-\- mirage