nougat.1

.\" Automatically generated by Pandoc 2.1.2
.\"
.TH "nougat" "1" "" "Version 1.0" "Nougat Man Page"
.hy
.SH NAME
.PP
nougat \- A beautiful screenshot wrapper
.SH SYNOPSIS
.PP
\f[I]nougat\f[] [ \f[B]\-h\f[] | \f[B]\-f\f[] | \f[B]\-m\f[] | \f[B]\-c\f[] |
\f[B]\-t\f[] | \f[B]\-s\f[] | \f[B]\-i\f[] | \f[B]\-b\f[] \f[I]backend\f[] |
\f[B]\-p\f[] ] [\f[I]DIRECTORY\f[]]
.SH DESCRIPTION
.PP
\f[B]Nougat\f[] is a screenshot wrapper that organizes screenshots by
date and time (dates are subdirectories, times are filenames).
It has backend support for maim, scrot, and imagemagick, as well as a
few convenient features for users.
.SH OPTIONS
.PP
\f[B]\-h\f[]
.PD 0
.P
.PD
Display the help and exit.
.PP
\f[B]\-f\f[]
.PD 0
.P
.PD
Takes a fullscreen screenshot.
.PP
\f[B]\-m\f[]
.PD 0
.P
.PD
Takes a fullscreen screenshot of the currently focused display.

This requires xdotool and is incompatible with the scrot backend.
.PP
\f[B]\-c\f[]
.PD 0
.P
.PD
Copies to clipboard (Requires xclip dependency)
.PP
\f[B]\-t\f[]
.PD 0
.P
.PD
Places the screenshot in /tmp rather than the set directory.
.PP
\f[B]\-i\f[]
.PD 0
.P
.PD
Outputs the taken image to stdout. This is useful for scripts
that accept an image as input on stdin. (Implies \-s)
.PP
.PP
\f[B]\-s\f[]
.PD 0
.P
.PD
Does not output the file's path.
.PP
\f[B]\-b\f[]
.PD 0
.P
.PD
Selects what backend to use.
Nougat will detect avaliable backends if \-b is not specified.
Nougat will prefer maim over all others.
.PP
\f[B]\-p\f[]
.PD 0
.P
.PD
Cleans symlinks that point to nowhere in the all subdirectory.
Does not take screenshot.
.PP
\f[B]DIRECTORY\f[]
.PD 0
.P
.PD
Puts current screenshot in specified directory.
.SH EXAMPLES
.PP
\f[B]nougat \-fc\f[] \f[I]~/pictures\f[]
.PD 0
.P
.PD
\ \ \ \ This particular command takes a fullscreen picture without a
cursor and moves it to clipboard as well as saving it directly to
~/pictures/
.PP
\f[B]nougat \-cts\f[]
.PD 0
.P
.PD
\ \ \ \ This command here will allow you to do selection, and take the
picture without cursor and silently without putting it to any directory
but putting it directly into clipboard.
.PP
\f[B]nougat \-c\f[]
.PD 0
.P
.PD
\ \ \ \ This will take a picture of your screenshot in selection and
without cursor but put the picture into whatever your
NOUGAT_SCREENSHOT_DIRECTORY is in the symlinked to all and
subcatagorized by date folders.
.PP
\f[B]nougat \-fcb imagemagisk\f[] \f[I]~/pictures\f[]
.PD 0
.P
.PD
\ \ \ \ This command will take a full screen picture with cursor and
saves it to ~/pictures as well as clipboard, however it requests
imagemagisk to be the backend instead of whatever is originally used.
.PP
\f[B]nougat \-fi | curl -sF'file=@-' https://0x0.st\f[]
.PD 0
.P
.PD
\ \ \ \ This takes a fullscreen picture and pipes
the image to curl where it is uploaded to 0x0.st (requires curl installed).
.PP
.SH ENVIRONMENT
.PP
\f[B]NOUGAT_CONFIG\f[]
.PD 0
.P
.PD
\ \ \ \ This is your configuration, All environment variables can be
modified from this file.
It is found in your configuration folder.
\f[B]EX:~/.config/nougat\f[]
.SH TROUBLESHOOTING
.PP
\f[B]I've just installed Nougat, and set it to a keybinding, but it
doesn't work with the keybinding.\f[]
.PD 0
.P
.PD
\ \ \ \ First ensure that you meet the dependencies of at least one
backend.
If you've exported the screenshot directory, you will be required to
logout and log back in.
.PP
\f[B]Nougat always outputs the path of a screenshot.\f[]
.PD 0
.P
.PD
\ \ \ \ This is done to make it easier to integrate Nougat into other
applications (for example an image uploader).
Pass \f[B]\-s\f[]
.PP
\f[B]My name is Ted\f[]
.PD 0
.P
.PD
\ \ \ \ Get the developer and general Linux users of varying experience
levels together for an hour in a Discord voice chat, one explaining a
handful of commands to install it, the other two making a pacman package
for you.
Then, one puts the package on the AUR, \ \ \ \ and install from there.
.SH AUTHOR
.PP
Nougat was created by Sweets <https://github.com/Sweets>
.PD 0
.P
.PD
Man Page was created by Good Friend Snow.
.PD 0
.P
.PD
Fucking Ted.