Skip to content

Cursor Tools

🛠️ Tools · ⬅ Home

cursorGet

Get the current cursor position

Usage

cursorGet

Get the current cursor position Output is

Arguments

  • none

Writes to standard output

UnsignedInteger

Examples

IFS=$'\n' read -r -d '' saveX saveY < <(cursorGet)

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

cursorSet

Move the cursor to x y

Usage

cursorSet x y

Move the cursor to x y

Arguments

  • x - UnsignedInteger. Required. Column to place the cursor.
  • y - UnsignedInteger. Required. Row to place the cursor.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

plasterLines

Outputs a line and fills the remainder with space

Usage

plasterLines

Outputs a line and fills the remainder with space

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

decorate at

Experimental

Usage

decorate at [ x ] [ y ] [ text ... ]

Experimental Place text at a position on the console.

Arguments

  • x - Integer. Console X offset
  • y - Integer. Console Y offset
  • text ... - EmptyString. Text line to output at the x,y console location. Additional lines are placed below the previous line.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

🛠️ Tools · ⬅ Top