From 094e398731ddaa72e2746a8c91c3567fbe0ef53d Mon Sep 17 00:00:00 2001
From: CheerfulPianissimo <sooraj2642@gmail.com>
Date: Mon, 13 May 2024 19:31:27 +0530
Subject: [PATCH] [docs] update manpage (1) with changes in freeze-feat

---
 docs/wayshot.1.scd | 59 ++++++++++++++++++++++++++++------------------
 1 file changed, 36 insertions(+), 23 deletions(-)

diff --git a/docs/wayshot.1.scd b/docs/wayshot.1.scd
index 47a9a8fe..65dea812 100644
--- a/docs/wayshot.1.scd
+++ b/docs/wayshot.1.scd
@@ -6,57 +6,70 @@ Wayshot - Screenshot tool for compositors implementing zwlr_screencopy_v1 such a
 
 # SYNOPSIS
 
-*wayshot* [_options_]
+*wayshot* [_options_] [_output_]
+
+# ARGUMENTS
+
+*output*,
+	Location to send captured screenshot to, it can be of the following types:
+		1. A directory, image outputs will be saved in the default format "wayshot-yyyy-mm-dd-hh-mm-ss.png"
+
+		2. A path (Encoding is automatically inferred from the extension).
+
+		3. '-' which sends the screenshot to stdout.
+
+	The *--clipboard* option can also be used simultaneously with any of the above to copy the image to the clipboard too. 
 
 # OPTIONS
 
-*-h*, *--help*
-	Print help message and quit.
+*-h*,
+	Print concise help messages and quit.
+
+*--help*,
+	Print full help message and quit.
 
 *-V*, *--version*
 	Print version information.
 
-*-d*, *--debug*
-	Enable debug mode.
+*--log-level <LOG_LEVEL>*
+	Log level to be used for printing to stderr  
+	Possible values: trace, debug, info, warn, error
+
+	Default value: info
 
 *-c*, *--cursor*
 	Enable cursor visibility in screenshots.
 
 *--clipboard*
-	Copy image contents to clipboard.
+	Copy image contents to clipboard also. 
+	Using this flag will cause the wayshot process to fork and persist in the background offering the image
+	on the wayland clipboard until some other program overwrites the clipboard.
 
 *-e*, *--extension*
-	Set the image encoder.
+	Set the image encoder. Without this option, encoding is either inferred from the *output* filename or defaults to png.  
 	Valid arguments:
-		- jpeg
 		- jpg
 		- png (Default encoder)
 		- ppm
 		- qoi
 		- webp
 
-*-f*, *--file*
-	Set a custom file path. The default path is `./{current_unix_timestamp}-wayshot.{encoder}`
-	eg: 1659034753-wayshot.png
-
-*-l*, *--listoutputs*
+*-l*, *--list-outputs*
 	List all valid output names. This flag is generally used in combination with *-o* flag.
 
-*--chooseoutput*
+*--choose-output*
 	Present a fuzzy selector for display (wl_output) selection.
 
 *-o*, *--output*
 	Choose a particular display (wl_output) to screenshot.
 
-*-s*, *--slurp* <GEOMETRY>
-	Choose a portion of your display to screenshot using the slurp program.
-	https://github.com/emersion/slurp . Valid arguments have the form
-	"%x %y %w %h" or "%x,%y %wx%h", where for example "%w" is an integer giving
-	the width of the region.
-
-*--stdout*
-	Emit image data to stdout. The following flag is helpful to pipe image data
-	to other programs.
+*-s*, *--slurp*=<SLURP_ARGS>
+	If this option is passed, wayshot takes a screenshot first and then uses the *slurp* program to select a portion of that screenshot
+	https://github.com/emersion/slurp . SLURP_ARGS are any arguments that need to be passed to *slurp*, see *slurp(1)* for more information.
+	
+	Example:
+	*wayshot -s="-b 11223377"*
+	- This takes a screenshot then calls slurp with "-b 11223377" as an argument for cropping the screenshot.
 
 # SEE ALSO
 	- wayshot(7)