Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
satty(1)		     General Commands Manual			satty(1)

NAME
     satty - Modern Screenshot Annotation.

SYNOPSIS
     satty  [--man]  [--license]  [-c|--config]  <-f|--filename>  [--fullscreen]
     [--resize] [--floating-hack] [-o|--output-filename] [--early-exit]  [--cor-
     ner-roundness] [--initial-tool] [--copy-command] [--annotation-size-factor]
     [--save-after-copy]  [--auto-copy]  [--actions-on-enter]  [--actions-on-es-
     cape] [--actions-on-right-click] [-d|--default-hide-toolbars] [--focus-tog-
     gles-toolbars]   [--default-fill-shapes]	[--font-family]   [--font-style]
     [--primary-highlighter]	[--disable-notifications]    [--profile-startup]
     [--no-window-decoration]	[--brush-smooth-history-size]	 [--zoom-factor]
     [--pan-step-size] [--text-move-length] [--input-scale] [--title] [--app-id]
     [--right-click-copy] [--action-on-enter] [-h|--help] [-V|--version]

DESCRIPTION
     Modern Screenshot Annotation.

OPTIONS
     --man  Show manpage. Pipe to man -l -

     --license
	    Show license

     -c, --config <CONFIG>
	    Path  to  the  config  file.  Otherwise  will  be read from XDG_CON-
	    FIG_DIR/satty/config.toml

     -f, --filename <FILENAME>
	    Path to input image or '-' to read from stdin

     --fullscreen [<FULLSCREEN>]
	    Start Satty in fullscreen mode. Since 0.20.1, takes optional parame-
	    ter. --fullscreen without parameter is  equivalent	to  --fullscreen
	    current. Mileage may vary depending on compositor

	    Possible values:

		   * all

		   * current-screen

     --resize [<MODE|WIDTHxHEIGHT>]
	    Resize  to	coordinates or use smart mode (0.20.1). --resize without
	    parameter is equivalent to --resize smart [possible  values:  smart,
	    WxH.]

     --floating-hack
	    Try to enforce floating (0.20.1). Mileage may vary depending on com-
	    positor

     -o, --output-filename <OUTPUT_FILENAME>
	    Filename to use for saving action or '-' to print to stdout. Omit to
	    disable   saving   to   file.   Might   contain  format  specifiers:
	    <https://docs.rs/chrono/latest/chrono/format/strftime/index.html>.
	    Since 0.20.0, can contain tilde (~) for home dir

     --early-exit [<EARLY_EXIT>...]
	    Exit directly after save action. 0.21.0: changed to accommodate dif-
	    ferent triggers

	    Possible values:

		   * all

		   * copy

		   * save

		   * save-as

     --corner-roundness <CORNER_ROUNDNESS>
	    Draw corners of rectangles round if the value is greater than 0 (De-
	    faults to 12) (0 disables rounded corners)

     --initial-tool <TOOL>
	    Select the tool on startup

	    Possible values:

		   * pointer

		   * crop

		   * line

		   * arrow

		   * rectangle

		   * ellipse

		   * text

		   * marker

		   * blur

		   * highlight

		   * brush

     --copy-command <COPY_COMMAND>
	    Configure the command to be called on copy, for example `wl-copy`

     --annotation-size-factor <ANNOTATION_SIZE_FACTOR>
	    Increase or decrease the size of the annotations

     --save-after-copy
	    After copying the screenshot, save it to a file as	well  Preferably
	    use the `action_on_copy` option instead

     --auto-copy
	    Automatically  copy  to  clipboard	after  every  annotation  change
	    (0.21.0)

     --actions-on-enter <ACTIONS_ON_ENTER>
	    Actions to perform when pressing Enter

	    Possible values:

		   * save-to-clipboard

		   * save-to-file

		   * save-to-file-as

		   * copy-filepath-to-clipboard

		   * exit

     --actions-on-escape <ACTIONS_ON_ESCAPE>
	    Actions to perform when pressing Escape

	    Possible values:

		   * save-to-clipboard

		   * save-to-file

		   * save-to-file-as

		   * copy-filepath-to-clipboard

		   * exit

     --actions-on-right-click <ACTIONS_ON_RIGHT_CLICK>
	    Actions to perform when hitting the copy Button

	    Possible values:

		   * save-to-clipboard

		   * save-to-file

		   * save-to-file-as

		   * copy-filepath-to-clipboard

		   * exit

     -d, --default-hide-toolbars
	    Hide toolbars by default

     --focus-toggles-toolbars
	    Experimental (since 0.20.0): Whether to toggle toolbars based on fo-
	    cus. Doesn't affect initial state

     --default-fill-shapes
	    Experimental feature (since 0.20.0): Fill shapes by default

     --font-family <FONT_FAMILY>
	    Font family to use for text annotations

     --font-style <FONT_STYLE>
	    Font style to use for text annotations

     --primary-highlighter <PRIMARY_HIGHLIGHTER>
	    The primary highlighter to use, secondary is accessible with CTRL

	    Possible values:

		   * block

		   * freehand

     --disable-notifications
	    Disable notifications

     --profile-startup
	    Print profiling

     --no-window-decoration
	    Disable the window decoration (title bar, borders, etc.) Please note
	    that the compositor has the final say in this. Requires  xdg-decora-
	    tion-unstable-v1

     --brush-smooth-history-size <BRUSH_SMOOTH_HISTORY_SIZE>
	    Experimental feature: How many points to use for the brush smoothing
	    algorithm. 0 disables smoothing. The default value is 0 (disabled)

     --zoom-factor <ZOOM_FACTOR>
	    Experimental feature (0.20.1): The zoom factor to use for the image.
	    1.0 means no zoom. defaults to 1.1

     --pan-step-size <PAN_STEP_SIZE>
	    Experimental feature (0.20.1): The pan step size to use when panning
	    with arrow keys. defaults to 50.0

     --text-move-length <TEXT_MOVE_LENGTH>
	    Experimental  feature (0.20.1): The length to move the text when us-
	    ing the arrow keys. defaults to 50.0

     --input-scale <INPUT_SCALE>
	    Experimental feature (0.20.1): Scale the default window size to  fit
	    different displays. Note that before 0.21.0 this is ignored with ex-
	    plicit resize

     --title <TITLE>
	    Experimental feature (0.21.0): Set window title

     --app-id <APP_ID>
	    Experimental  feature  (0.21.0): Set toplevel app_id. Note that this
	    has to match D-Bus well known name format, otherwise  GTK  does  not
	    accept it

     --right-click-copy
	    Right  click to copy. Preferably use the `action_on_right_click` op-
	    tion instead

     --action-on-enter <ACTION_ON_ENTER>
	    Action to perform when  pressing  Enter.  Preferably  use  the  `ac-
	    tions_on_enter` option instead

	    Possible values:

		   * save-to-clipboard

		   * save-to-file

		   * save-to-file-as

		   * copy-filepath-to-clipboard

		   * exit

     -h, --help
	    Print help

     -V, --version
	    Print version

VERSION
     v0.21.1

AUTHORS
     Matthias Gabriel <gabm+aur@mailbox.org>

				  satty 0.21.1				satty(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=satty&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help