Open Menu / doc / usage / cmd / setcurs.rst
Loading...
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
.. SPDX-License-Identifier: GPL-2.0-or-later

.. index::
   single: setcurs (command)

setcurs command
===============

Synopsis
--------

::

    setcurs <col> <row>

Description
-----------

The setcurs command sets the cursor position on the video console.

col
    Column position in hex, with 0 being the left side. Note that this is the
    text-column position, so the number of pixels per position depends on the
    font size.

row
    Row position in hex, with 0 being the top edge. Note that this is the
    text-row position, so the number of pixels per position depends on the
    font size.


Examples
--------

Set cursor to column 0x10, row 5::

    => setcurs 10 5

Move cursor to top left::

    => setcurs 0 0

Configuration
-------------

The setcurs command is available if CONFIG_CMD_VIDEO=y.

See also
--------

* :doc:`video` - video command with subcommands
* :doc:`lcdputs` - print string on video framebuffer

Return value
------------

The return value $? is 0 (true) on success, 1 (false) on failure.