bugGNU Octave - Bugs: bug #62855, Configuration option for...


bug #62855: Configuration option for "doc" command to choose whether it opens GUI window even in CLI

Submitter:  vidnyan kendra <octnuby>
Submitted:  Wed 03 Aug 2022 08:08:18 AM UTC
Category:  Documentation Severity:  1 - Wish
Priority:  5 - Normal Item Group:  Feature Request
Status:  Confirmed Assigned to:  None
Originator Name:  Open/Closed:  * Open
Release:  * dev Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup

Mon 17 Oct 2022 03:25:24 PM UTC, comment #3: 

I agree.  Changing the title and item group to a Feature Request.

Rik <rik5>
Group administrator
Mon 17 Oct 2022 01:19:42 PM UTC, comment #2: 

Allowing to use the documentation browser with the "doc" command also from the CLI interface is a new feature in Octave 7. The corresponding docstring can still be viewed in the CLI with the "help" command.

Imho, adding an option for whether "doc" should open the GUI documentation browser or the info browser in the CLI shouldn't block Octave 7.3.0.

Changing release to "dev".

Markus M├╝tzel <mmuetzel>
Group administrator
Wed 03 Aug 2022 03:07:10 PM UTC, comment #1: 

The code in question is located in scripts/help/doc.m at line 56

  ## Give event manager the first shot.

  status = ! __event_manager_show_documentation__ (function_name);

  if (status)

In Octave 5.2 this code was

  ## if GUI is running, let it display the function
  if (isguirunning ())
    status = ! __octave_link_show_doc__ (function_name);

It seems like this should be configurable because some people running the CLI will want to stay entirely in a terminal environment, while others might still appreciate being able to open up a Qt-based document browser for help while still coding in the CLI.

Rik <rik5>
Group administrator
Wed 03 Aug 2022 08:08:18 AM UTC, original submission:  

It appears that the `doc` command (in `doc.m`) now tries to launch a GUI documentation browser always, versus only when the GUI is running.  This seems like it should be a configurable option.

I think a simple example to reference is

doc ls

In version 6.4, this launches a CLI Info browser when running with the `--no-gui` option.  In Octave version 7.X this launches a Qt-based Info browser.

vidnyan kendra <octnuby>


(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:

No files currently attached


Depends on the following items: None found

Items that depend on this one: None found


Carbon-Copy List
  • -email is unavailable- added by mmuetzel (Posted a comment)
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by octnuby (Submitted the item)

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.


    Follow 7 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-10-17 rik5 Severity3 - Normal 1 - Wish
        Item GroupRegression Feature Request
        Summary&quot;doc&quot; command opens gui window in octave cli Configuration option for "doc" command to choose whether it opens GUI window even in CLI
    2022-10-17 mmuetzel Release7.2.0 dev
        Operating SystemGNU/Linux Any
    2022-08-03 rik5 StatusNone Confirmed
    2022-08-03 rik5 Item GroupDocumentation Regression

    Back to the top

    Powered by Savane 3.13-4b48.
    Corresponding source code