.. /*  
    * This file is part of the SavaPage project <https://www.savapage.org>.
    * Copyright (c) 2026 Datraverse B.V.
    * Author: Rijk Ravestein.
    *
    * SPDX-FileCopyrightText: (c) 2020 Datraverse B.V. <info@datraverse.com>
    * SPDX-License-Identifier: CC-BY-SA-4.0
    *
    * For more information, please contact Datraverse B.V. at this
    * address: info@datraverse.com
    */

.. _ch-user-client-options:

|USER_CLIAPP| Options
---------------------

In order of precedence, User Client options can be set ...

1. On the Command-line.

2. As value in a ``client.properties`` file. An annotated template is
   available in the ``/opt/savapage/client/app/config/`` directory.

3. As Configuration Property.

.. code-block:: text

   usage: savapage-client <options>
         --anchor <ne|nw|se|sw>     Show on desktop at anchor position instead of tray.
                                    --notify-send switch is auto activated (Linux only).
      -d,--debug                    Write debug messages to the log file.
      -h,--help                     Display help text in GUI.
         --help-tui                 Display help text in TUI.
         --log-dir <dir>            Log file directory. Default: $HOME
         --notify-send              Use 'notify-send' command to send desktop
                                    notifications (Linux only).
      -p,--print-dialog             Show action dialog at print-in event.
         --passkey <key>            The admin passkey (optional).
         --print-dialog-btn <arg>   Button text on print-in action dialog for opening
                                    User Web App (optional).
         --print-url-query <arg>    URL query for opening User Web App at print-in event
                                    (optional).
         --properties <file>        File with default command-line options (optional).
                                    Default: $APP/config/client.properties
         --server-host <arg>        IP address or name of SavaPage server
         --server-port <number>     SSL port of SavaPage server (optional). Default:
                                    8632.
         --user <name>              A different username than current user $USER
                                    (optional).
      -x,--hide-exit                Hide the "Exit" menuitem (optional). Default: false.

.. note::

   The ``passkey`` option can also be applied as environment variable
   ``SAVAPAGE_CLIAPP_ADMIN_PASSKEY``. This is the preferred way to use
   in generic login scripts, since the command-line option might be
   visible in system process viewers.

   On Debian, the ``notify-send`` utility is part of the
   ``libnotify-bin`` package.


.. list-table:: User Client Options Configuration Properties 
   :width: 100%
   :widths: 50 50
   :header-rows: 1

   * - Configuration property
     - Command-Line Option

   * - cliapp.print-in.url-querycliapp.print-in.url-query
     - ``--print-url-query`` |br|
       |br|
       The query string to be appended to the  base URL when opening the
       User Web App in response to a print-in event. Do *not* prefix the
       value with a ``?`` or ``&`` character.

   * - cliapp.print-in.dialog.button-open
     - ``--print-dialog-btn`` |br|
       |br|
       Action button text on print-in action dialog for opening User Web App.


See |RST_LINK_CONFIG_EDITOR| on how to enter these items.