################## The ln_manager GUI ################## Overview ======== The GTK ``ln_manager`` window is organized as a notebook with tabs such as ``processes``, ``clients``, ``topics``, ``services``, ``parameters`` and ``log``. At the top-right of that notebook there is a small action area with instance-global buttons: * ``docs`` * ``web ui`` * ``save all`` * ``edit`` * ``reload`` These actions are global to the manager instance and therefore stay visible no matter which notebook tab is currently selected. Global Buttons ============== docs ---- The ``docs`` button opens documentation in the user's preferred desktop browser via ``xdg-open``. If the instance config does not define an :ref:`instance documentation URL or filename `, ``docs`` opens the built-in LN reference documentation served by the running manager at ``/doc/``. If the instance config *does* define ``documentation: ...``, pressing ``docs`` opens a small popup menu attached to the button with 2 entries: * ``instance documentation`` opens the configured instance-specific document * ``LN documentation`` opens the built-in LN reference documentation at ``/doc/`` This allows site-local or system-maintainer documentation to coexist with the generic LN documentation without adding a second permanent top-level button. web ui ------ The ``web ui`` button opens the built-in browser UI of the same running manager instance in the user's preferred browser. It opens the ``/lnm/`` target on the current manager host and port. See :doc:`ln_manager_webui` for authentication requirements and the available browser routes. save all -------- The ``save all`` button creates a compressed diagnostics archive with as much manager-side debug information as possible. This is the same function described in :doc:`howto_report_lnm_bug`. edit ---- The ``edit`` button opens the active manager configuration in the external editor selected by ``$EDITOR``. If the configuration consists of multiple included files, pressing ``edit`` opens a popup menu attached to the button so the user can pick the specific file to edit. reload ------ The ``reload`` button reloads the manager configuration from disk. .. _gui_reference/opening_a_scope: Opening a scope --------------- TODO: describe how to open a scope