bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[Calvin Heim]

Hi Guix developers,

When using mate-terminal version 1.12.1 (the default graphical terminal provided in Trisquel 8), Guix commands
that print hyperlinks to the terminal (such as `guix describe` and `guix show`)
print a mangled \x1b]8;; OSC character. I haven't tested the mate-terminal
package provided by Guix though, so this bug may only be visible to Trisquel users
of the Guix package manager relying on their host distribution's default terminal soon
after installing Guix.

On a related note, the procedure supports-hyperlinks in module (guix ui) checks the
environment variable INSIDE_EMACS to prevent hyperlink mangling when using Emacs.
Perhaps this procedure could be edited to solve this bug.

--
Calvin

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[zimoun]

Hi,

Thank you for your report.


On Sun, 5 Jan 2020 at 07:49, Calvin Heim <frofroggy@gmail.com> wrote:

> When using mate-terminal version 1.12.1 (the default graphical terminal provided in Trisquel 8), Guix commands
> that print hyperlinks to the terminal (such as `guix describe` and `guix show`)
> print a mangled \x1b]8;; OSC character. I haven't tested the mate-terminal
> package provided by Guix though, so this bug may only be visible to Trisquel users
> of the Guix package manager relying on their host distribution's default terminal soon
> after installing Guix.

I have tested with "guix environment --ad-hoc mater-terminal" on
foreign distro (Debian) and I do not see an issue.

So it probably comes from the Trisquel default configuration.


> On a related note, the procedure supports-hyperlinks in module (guix ui) checks the
> environment variable INSIDE_EMACS to prevent hyperlink mangling when using Emacs.
> Perhaps this procedure could be edited to solve this bug.

Does "INSIDE_EMACS=1 guix describe" fix the issue?


All the best,
simon

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[Calvin Heim]

On Mon, 2020-01-06 at 19:37 +0100, zimoun wrote:
> Hi,
> 
> Thank you for your report.
> 
> 
> On Sun, 5 Jan 2020 at 07:49, Calvin Heim <frofroggy@gmail.com> wrote:
> 
> > 
> > When using mate-terminal version 1.12.1 (the default graphical terminal provided in Trisquel 8), Guix commands
> > that print hyperlinks to the terminal (such as `guix describe` and `guix show`)
> > print a mangled \x1b]8;; OSC character. I haven't tested the mate-terminal
> > package provided by Guix though, so this bug may only be visible to Trisquel users
> > of the Guix package manager relying on their host distribution's default terminal soon
> > after installing Guix.
> I have tested with "guix environment --ad-hoc mater-terminal" on
> foreign distro (Debian) and I do not see an issue.
> 
> So it probably comes from the Trisquel default configuration.
> 
I concur.
> 
> > 
> > On a related note, the procedure supports-hyperlinks in module (guix ui) checks the
> > environment variable INSIDE_EMACS to prevent hyperlink mangling when using Emacs.
> > Perhaps this procedure could be edited to solve this bug.
> Does "INSIDE_EMACS=1 guix describe" fix the issue?
> 

Yes.
>  
> 
> All the best,
> simon

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[zimoun]

Hi Calvin,

On Mon, 6 Jan 2020 at 21:26, Calvin Heim <frofroggy@gmail.com> wrote:

> > On Sun, 5 Jan 2020 at 07:49, Calvin Heim <frofroggy@gmail.com> wrote:

> > > When using mate-terminal version 1.12.1 (the default graphical terminal provided in Trisquel 8), Guix commands
> > > that print hyperlinks to the terminal (such as `guix describe` and `guix show`)
> > > print a mangled \x1b]8;; OSC character. I haven't tested the mate-terminal
> > > package provided by Guix though, so this bug may only be visible to Trisquel users
> > > of the Guix package manager relying on their host distribution's default terminal soon
> > > after installing Guix.
> > I have tested with "guix environment --ad-hoc mater-terminal" on
> > foreign distro (Debian) and I do not see an issue.
> >
> > So it probably comes from the Trisquel default configuration.
> >
> I concur.

So, it is not a bug. ;-)


> > > On a related note, the procedure supports-hyperlinks in module (guix ui) checks the
> > > environment variable INSIDE_EMACS to prevent hyperlink mangling when using Emacs.
> > > Perhaps this procedure could be edited to solve this bug.
> > Does "INSIDE_EMACS=1 guix describe" fix the issue?
> Yes.

Put in your configuration "export INSIDE_EMACS=1". :-)


Does the environment variable NO_OSC appears to you more meaningful
than INSIDE_EMACS?
Where do you think this should be documented? Which part of the manual?


All the best,
simon

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[Calvin Heim]

Hi Zimoun,

On Tue, 2020-01-07 at 12:58 +0100, zimoun wrote:
> Does the environment variable NO_OSC appears to you more meaningful
> than INSIDE_EMACS?

It is more meaningful, but this terminal does interpret other operating system codes,
like OSC 12 for changing the cursor color. NO_OSC_8 would be specific to hyperlinks.

> Where do you think this should be documented? Which part of the manual?
Installation > Application setup > Terminals
> Some Guix commands print hyperlinks by sending non-printing control characters (\1b]8;;) 
> to the terminal display. In most cases, this works fine. But some older terminals will 
> misinterpret hyperlinks and print the control characters. 
> If that happens, define the NO_OSC_8 variable to disable hyperlinks:
>	 
>	$ export NO_OSC_8=1
> 
> If you later upgrade to a terminal with hyperlink support, unset this variable to enable
> hyperlinks.

Sincerely,
Calvin

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[Ludovic Courtès]

Hi,

Calvin Heim <frofroggy@gmail.com> skribis:

> On Tue, 2020-01-07 at 12:58 +0100, zimoun wrote:
>> Does the environment variable NO_OSC appears to you more meaningful
>> than INSIDE_EMACS?
>
> It is more meaningful, but this terminal does interpret other operating system codes,
> like OSC 12 for changing the cursor color. NO_OSC_8 would be specific to hyperlinks.

The theory is that terminals should ignore OSC codes that they do not
support.  Good’ol xterm, for instance, silently ignores those hyperlink
codes, whereas GNOME Terminal interprets them nicely.

So I would say that this is a bug in this version of mate-terminal, or
perhaps in the libvte version it’s using?

I’ve just tried mate-terminal 1.22.0 on vte 0.58.3 from Guix, and it
silently ignores those codes.

Thanks,
Ludo’.

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[Calvin Heim]

On Wed, 2020-01-08 at 22:28 +0100, Ludovic Courtès wrote:
> Hi,
> 
> Calvin Heim <frofroggy@gmail.com> skribis:
> 
> > 
> > On Tue, 2020-01-07 at 12:58 +0100, zimoun wrote:
> > > 
> > > Does the environment variable NO_OSC appears to you more meaningful
> > > than INSIDE_EMACS?
> > It is more meaningful, but this terminal does interpret other operating system codes,
> > like OSC 12 for changing the cursor color. NO_OSC_8 would be specific to hyperlinks.
> The theory is that terminals should ignore OSC codes that they do not
> support.  Good’ol xterm, for instance, silently ignores those hyperlink
> codes, whereas GNOME Terminal interprets them nicely.
> 
I concur.

> So I would say that this is a bug in this version of mate-terminal, or
> perhaps in the libvte version it’s using?
Yes, the bug is in libvte 0.28.2 as distributed with Trisquel 8's software updater. 
I misspoke earlier when I mentioned mate-terminal.

This bug will be resolved eventually by Trisquel following the upstream sources in 
Ubuntu, so barring objections I will close this issue.
> I’ve just tried mate-terminal 1.22.0 on vte 0.58.3 from Guix, and it
> silently ignores those codes.
> 
> Thanks,
> Ludo’.

Thanks,
Calvin

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[zimoun]

Hi Calvin.

On Wed, 8 Jan 2020 at 23:54, Calvin Heim <frofroggy@gmail.com> wrote:

> This bug will be resolved eventually by Trisquel following the upstream sources in
> Ubuntu, so barring objections I will close this issue.

Please close by sending an email to 38940-done@debbugs.gnu.org with
some explanations when you judge it is resolved; even if it is *not* a
bug of Guix but a _bug of Trisquel_. ;-)


All the best,
simon

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[zimoun]

Hi Ludo,


On Wed, 8 Jan 2020 at 22:28, Ludovic Courtès <ludo@gnu.org> wrote:

> The theory is that terminals should ignore OSC codes that they do not
> support.  Good’ol xterm, for instance, silently ignores those hyperlink
> codes, whereas GNOME Terminal interprets them nicely.

Héhé! It is what the comment you wrote in `supports-hyperlinks?' says. :-)

1. Instead of INSIDE_EMACS, the variable name NO_SUPPORT_HYPERLINK or
other seems more meaningful. Maybe?
2. The comment should go in the docstring.


What do you think?



All the best,
simon

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[Ludovic Courtès]

Hi!

zimoun <zimon.toutoune@gmail.com> skribis:

> On Wed, 8 Jan 2020 at 22:28, Ludovic Courtès <ludo@gnu.org> wrote:
>
>> The theory is that terminals should ignore OSC codes that they do not
>> support.  Good’ol xterm, for instance, silently ignores those hyperlink
>> codes, whereas GNOME Terminal interprets them nicely.
>
> Héhé! It is what the comment you wrote in `supports-hyperlinks?' says. :-)
>
> 1. Instead of INSIDE_EMACS, the variable name NO_SUPPORT_HYPERLINK or
> other seems more meaningful. Maybe?

Actually the goal was to remove ‘INSIDE_EMACS’ from there once a
widespread-enough Emacs version supports it, which could be within a
year.  And since other terminals are supposed to ignore it altogether, I
would rather not add a special environment variable.

WDYT?

> 2. The comment should go in the docstring.

I tend to write “implementation details” as comments, while keeping pure
descriptions of the interface as docstrings; I think it’s OK.  :-)

Ludo’.

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[Ludovic Courtès]

Hi Calvin,

Calvin Heim <frofroggy@gmail.com> skribis:

> Yes, the bug is in libvte 0.28.2 as distributed with Trisquel 8's software updater. 
> I misspoke earlier when I mentioned mate-terminal.
>
> This bug will be resolved eventually by Trisquel following the upstream sources in 
> Ubuntu, so barring objections I will close this issue.

Sure, closing!

Thanks,
Ludo’.

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[zimoun]

Hi Ludo,

On Thu, 9 Jan 2020 at 22:23, Ludovic Courtès <ludo@gnu.org> wrote:

> > 1. Instead of INSIDE_EMACS, the variable name NO_SUPPORT_HYPERLINK or
> > other seems more meaningful. Maybe?
>
> Actually the goal was to remove ‘INSIDE_EMACS’ from there once a
> widespread-enough Emacs version supports it, which could be within a
> year.  And since other terminals are supposed to ignore it altogether, I
> would rather not add a special environment variable.

Sound reasonable. :-)


> > 2. The comment should go in the docstring.
>
> I tend to write “implementation details” as comments, while keeping pure
> descriptions of the interface as docstrings; I think it’s OK.  :-)

I fully trust your experience. ;-)


Cheers,
simon

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[Jack Hill]

[-- Attachment #1: Type: text/plain, Size: 611 bytes --]

Hi Ludo'

On Thu, 9 Jan 2020, Ludovic Courtès wrote:

>> 1. Instead of INSIDE_EMACS, the variable name NO_SUPPORT_HYPERLINK or
>> other seems more meaningful. Maybe?
>
> Actually the goal was to remove ‘INSIDE_EMACS’ from there once a
> widespread-enough Emacs version supports it, which could be within a
> year.  And since other terminals are supposed to ignore it altogether, I
> would rather not add a special environment variable.

Which Emacs version support it? I'm using Emacs 26.3 from master, and see 
the escape sequences in eshell. They seem to be correctly ignored in M-x 
shell.

Thanks,
Jack

bug#38940: \x1b]8; ; OSC character displayed on hyperlinks shown after calls to `guix describe` or `guix show` on mate-terminal 1.12.1 (Trisquel 8)

[Ludovic Courtès]

Hi,

Jack Hill <jackhill@jackhill.us> skribis:

> On Thu, 9 Jan 2020, Ludovic Courtès wrote:
>
>>> 1. Instead of INSIDE_EMACS, the variable name NO_SUPPORT_HYPERLINK or
>>> other seems more meaningful. Maybe?
>>
>> Actually the goal was to remove ‘INSIDE_EMACS’ from there once a
>> widespread-enough Emacs version supports it, which could be within a
>> year.  And since other terminals are supposed to ignore it altogether, I
>> would rather not add a special environment variable.
>
> Which Emacs version support it? I'm using Emacs 26.3 from master, and
> see the escape sequences in eshell. They seem to be correctly ignored
> in M-x 
> shell.

Emacs 26.3 does not support it; all I know is that there’s a patch by
José Marchesi floating around.

Ludo’.