Metadata-Version: 2.4
Name: snomdial
Version: 0.5.3
Summary: A versatile dialing tool for Snom telephones on your X11 desktop
Home-page: https://github.com/frispete/snomdial
Author: Hans-Peter Jansen
Author-email: hp@lisa-gmbh.de
License: GPLv3
Keywords: snom phone dial X11 desktop selection clipboard PyQt5
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: X11 Applications
Classifier: Environment :: X11 Applications :: KDE
Classifier: Environment :: X11 Applications :: Qt
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Natural Language :: German
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Communications
Classifier: Topic :: Communications :: Telephony
Classifier: Topic :: Desktop Environment
Classifier: Topic :: Desktop Environment :: Gnome
Classifier: Topic :: Desktop Environment :: K Desktop Environment (KDE)
Classifier: Topic :: Office/Business
Classifier: Topic :: System :: Networking
Classifier: Topic :: Utilities
License-File: LICENSE.txt
Requires-Dist: PyQt5
Requires-Dist: PyQxtGlobalShortcut
Requires-Dist: keyring
Requires-Dist: xcffib
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

SnomDial
========

**SnomDial** is a dialing helper tool for your favorite X11 desktop
and - Surprise - SNOM phones.

Features
--------

    * Define a global dial shortcut (defaults to Meta+W)
    * Dial a selected phone number from selection and clipboard
      (selection takes precedence)
    * Edit selected number before dialing
    * Intelligently deal with most common phone number formats
      (including broken ones)
    * Special purpose QuickDial desktop menu
    * Handle tel: links in xdg desktop environments
    * Integrate with your favorite address book

QuickDial
---------

**SnomDial** manages a special purpose Desktop dial menu, that allows you
to quickly dial configured numbers. It organises them in a tree, and comes
with an integrated graphical editor (on right click).

The appearance of the QuickDial menu can be configured freely in a
separate tab on the configuration dialog. Various window manager aspects,
such as showing it in taskbars and pagers, as well as stickyness can be
configured there as well.

The QuickDial editor allows you to organize the contacts. You can create
simple items, submenus containing items and further submenus to your
liking. The item tree on the left allows you to reorganize the items with
drag and drop. Simple items have a label, a number and a flag to
distinquish internal from external calls (where appropriate).  Submenu
items just have a label.

The editor allows for importing and exporting parts or the whole tree in a
XML based format, that is stored with bz2 compression to disc (for
historical reasons).

tel: links
----------

**SnomDial** installs a tel: link xdg desktop sink, that should work
correctly from any application, that integrates correctly with the desktop
environment, as long as the main SnomDial GUI process is up and running.

Address book integration
------------------------

SnomDials integration with various address books boils down to calling
it with an -d or --dial option, e.g.::

    $ snomdial -d "phone-number"

Usually, address books have a configuration capability for that purpose.
The KDE 4 addressbooks are supported out of the box by adding the relevant
option into the config files behind the scenes. You should close
kaddressbook once before starting **SnomDial**, in order to not interfere
with configuration changes of its own. Now, you should be able to dial
any contact by clicking on the phone number.

Setup
-----

Disable hidden tags in the SNOM advanced QoS/Security configuration, please.
Another prerequisite is a correctly assigned hostname, because **SnomDial**
manages multiple assigned phones, based on the desktop host address.

When running **SnomDial** for the first time on a desktop, it opens its
configuration dialog, where you enter the ip address of the Snom phone, you
want to control. Beware of assigning a hostname in the Snom configuration
setup, that might result in the inability to detect the phone as one from
Snom. If you configured a password protection for your phone, you will be
asked for a username and password for authenication. The authentication
data is stored in a secure manner using **keyring**, that itself relies on
an operational backend, that is supported by **keyring**. Most prominent
backends are **SecretService** and **kwallet**. If no backend is found, the
authentication data must be given on every run.

Given, all worked out well, a small phone symbol should appear in the systray
area of your desktop. Right click opens an option menu, left click dials a
selected number, middle click hangs up.

Autostart
---------

KDE used to restart apps, that where running during logout, on start up.
If this doesn't work for you with snomdial, go to the system settings,
**Startup** **and** **Shutdown** and add **snomdial** with **Add**
**Program..** button on the **Autostart** tab.

Selection, Clipboard and numbers
--------------------------------

When an interactive dial command is triggered, **SnomDial** checks the
current selection buffer (the buffer carrying the text, that was selected
with the mouse in most desktop application windows). If it finds some text,
it examines the first line only, and filters for an optional prefixed '+'
and any digits. Then, the dial rules of country code, area code and dial
prefix are applied, reducing the number to the simplest sequence of digits
to dial.

If this logic fails, you can use the integrated dial editor.

Copyright/License
-----------------

This software was created (c) 2009-2019 by Hans-Peter Jansen <hp@lisa-gmbh.de>
and is released under the GNU GPL-3.0 license.
