public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: Jared Finder <jared@finder.org>
To: "Günther Noack" <gnoack3000@gmail.com>
Cc: "Alejandro Colomar" <alx@kernel.org>,
	linux-man@vger.kernel.org, "Hanno Böck" <hanno@hboeck.de>,
	"Jann Horn" <jannh@google.com>,
	"Jiri Slaby" <jirislaby@kernel.org>,
	jwilk@jwilk.net
Subject: Re: [PATCH man v2 2/2] TIOCLINUX.2const: Document missing TIOCL_SETSEL selection modes
Date: Sun, 23 Feb 2025 15:19:02 -0800	[thread overview]
Message-ID: <ef429ddf8a438c47e6fdfbb41b25943f@finder.org> (raw)
In-Reply-To: <20250223213642.10042-3-gnoack3000@gmail.com>

Similarly to the other part of the patch, feel free to ignore my 
comments if they're not aligned with the usual documentation details.

On 2025-02-23 13:36, Günther Noack wrote:
> Documents the following TIOCL_SETSEL sub-operations:
> 
> * TIOCL_SELPOINTER
> * TIOCL_SELCLEAR
> * TIOCL_SELMOUSEREPORT
> 
> These previously undocumented selection modes for the Linux console
> are implemented in drivers/tty/vt/selection.c.  The name "selection
> mode" is slightly misleading as not all of them actually manipulate
> the kernel's mouse selection buffer.
> 
> Cc: Jared Finder <jared@finder.org>
> Cc: Hanno Böck <hanno@hboeck.de>
> Cc: Jann Horn <jannh@google.com>
> Cc: Jiri Slaby <jirislaby@kernel.org>
> Cc: jwilk@jwilk.net
> Signed-off-by: Günther Noack <gnoack3000@gmail.com>
> ---
>  man/man2const/TIOCLINUX.2const | 29 +++++++++++++++++++++++++++++
>  1 file changed, 29 insertions(+)
> 
> diff --git a/man/man2const/TIOCLINUX.2const 
> b/man/man2const/TIOCLINUX.2const
> index 5db3f6ea6..3aa1c7eb2 100644
> --- a/man/man2const/TIOCLINUX.2const
> +++ b/man/man2const/TIOCLINUX.2const
> @@ -82,6 +82,35 @@ and saved in a kernel buffer.
>  Select line-by-line.
>  The indicated screen characters are highlighted
>  and saved in a kernel buffer.
> +.TP
> +.B TIOCL_SELPOINTER
> +Show the pointer at position
> +.RI ( xe ,\~ ye ).

nit: Technically, "at the greater position of start or end".  See how ps 
and pe are swapped if ps > pe in vc_selection().

> +.TP
> +.B TIOCL_SELCLEAR
> +Remove the current selection highlight, if any,
> +from the console holding the selection.

I'd recommend stating explicitly if this affects the stored characters. 
(I believe it does not.)

> +.TP
> +.B TIOCL_SELMOUSEREPORT
> +Make the terminal report
> +.RI ( xs ,\~ ys )
> +as the current mouse location
> +using the
> +.BR xterm (1)
> +mouse tracking protocol
> +(see
> +.BR console_codes (4)).
> +The lower 4 bits of
> +.I sel_mode
> +.RB ( TIOCL_SELBUTTONMASK )
> +indicate the desired button press and
> +modifier key information for the mouse event.
> +.\" 
> <https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Normal-tracking-mode>
> +.IP
> +If mouse reporting is not enabled for the terminal,
> +this operation yields an
> +.B EINVAL
> +error.
>  .RE
>  .IP
>  Since Linux 6.7, using this subcode requires the

   -- MJF

  reply	other threads:[~2025-02-23 23:19 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-23 21:36 [PATCH man v2 0/2] TIOCLINUX.2const: Document TIOCL_SETSEL selection modes Günther Noack
2025-02-23 21:36 ` [PATCH man v2 1/2] TIOCLINUX.2const: Restructure documentation for " Günther Noack
2025-02-23 23:13   ` Jared Finder
2025-03-02  7:06     ` Alejandro Colomar
2025-03-02 19:45       ` Günther Noack
2025-03-02 19:00     ` Günther Noack
2025-02-23 21:36 ` [PATCH man v2 2/2] TIOCLINUX.2const: Document missing " Günther Noack
2025-02-23 23:19   ` Jared Finder [this message]
2025-03-02 19:23     ` Günther Noack

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ef429ddf8a438c47e6fdfbb41b25943f@finder.org \
    --to=jared@finder.org \
    --cc=alx@kernel.org \
    --cc=gnoack3000@gmail.com \
    --cc=hanno@hboeck.de \
    --cc=jannh@google.com \
    --cc=jirislaby@kernel.org \
    --cc=jwilk@jwilk.net \
    --cc=linux-man@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox