nxde

h1. nxhelper Commands

h2. nxbacklightctrl

<pre>

nxbacklightctrl [up, down, cur, set value]

</pre>

Manipulates the display backlight. The Display used is either the first in _/sys/class/backlight/_ or the value of key _bright_path_.

* **cur** echos the current brightness

* **set value** sets the current brightness to `cur`

* **up**, **down** increases or decreases the brightness by value of key _bright_steps_

> Later additional commands will be added: **bright** (sets macimum brightness), **dark** (sets minimum (key _dark_brightness_) brightness), **max** (echos max brightness)\

> Currently only usable as root (directly accessing backlight in sys). Later, it shall become usable for users by utilizing **nxsysdaemon**

h2. nxdisplaydaemon

<pre>

nxdisplaydaemon [-d[d]] [-t]`

</pre>

Manages brightness (using **nxsysdaemon** ) and screen locking (with **nxulock**). Does _not_ do power management. Leave that to dpms! When startet with `-d` or `-dd` prints out some or many debug messages. When start with `-t` (implies `-d`), sets darken timeouts to 5 Seconds.

Keys:

* _darken_timeout_ (default: 30s): inactivity time untils brightnes is reduced

* _darken_ac_timeout_ (default: 2 * _darken_timeout_): same but when connected to mains

* _lock_timeout_ (default: 300s): inactivity time until screen is locked

* _lock_ac_timeout_ (default: cfg.lock_timeout): same but when connected to mains

* _lock_save_timeout_ (default: 0): same but when docked or connected to a safe network

* _save_networks_ (default: ""): ESSID considered to be safe (see above), for example at home.

* _dock_is_save_ (default: false): Being docked is considered to be safe

* _pseudo_dock_, (default: ""): "VENDOR:DEVICE" string of a USB device which indicates safeness (eg a USB dock)

* _fade_step_duration_ (default: 0.1): duration of a step when fading the brightness up or down

* _dark_brightness_ (default: 1): darkest brightness when dimming down after inactivity

* _bright_fade_steps_ (default: 20): Amout of steps from maximum to minimal brightness

> There are many things to do. Both save_networks and pseudo_dock shall become arrays. Default values for _fade_step_duration_ and _bright_fade_steps_ shall be calculated suitably to the displays maximum brightness and possible amount of steps and a new key _fade_time_.\

> Also, i will investigate how Gnome and KDE make it so that many videos will disable screen locking. At least some very common cases shall be supported.

h2. nxlid

<pre>

nxlid open/close

</pre>

Should be run by acpid for "button.*(LID).*close" and *open. For open, sends signal SIGHUP to **nxrandrd** (see there). For close sends SIGHUP to **nxrandrd** (see there) when docked (see `is_docked` in **nxhshlib**), otherwise calls `nxsuspend mem`.

> This is totally a stub

h2. nxrandr

<pre>

nxrandr [initialize] [silent] [debug]

</pre>

Automagically initializes multihead setups using xrandr. By default, nxrandr iterates through all connected displays, sets them to `--auto` and `--left-of` the one before. As that is boring, it tries to load _$NX_CONFIG_HOME/nxrandr.rc, which is supposed to be a bash script. See the examples one, it is pretty well documented.

As nxrandr is supposed to be called by **nxrandrd** upon changes to the connected displays, it tries to detect misfirings. Those usually happen as multiple, indistuingishable firings after connecteing or disconnecting a display. These multiple firings are detected by simply ignoring events in short succession.

> Note: The handling of multiple / misleading / wrong xrandr-events can become quite tricky. More on that in the example nxrandr.rc. Those events are may also be bugs in **nxrandrd** (see there)

h2. nxsdwhisper

<pre>

nxsdwhisper message

</pre>

Echos what **nxsysdaemon** answers to `message`. Returns 0 on success, 1 otherwise.

h2. nxsysdaemon

<pre>

nxsysdaemon [-d] [-g GID]

</pre>

A user-accessible interface to (a very small part of) /sys. Debug mode (`-d`) prints out all communication and disables daemonizing. Communications happens through a named pipe (/run/nxsysdaemon_fifo), by default the group 998 has write access. The group can be set by `-g GID`.

Protocoll:

* gpv [string]: returns the protocol version

* gcb [number]: returns current brightness

* gmb [number]: returns maximum brightness

* scbNUMBER [boolean]: sets current brightness to NUMBER, returns success

* iac [boolean]: returns 1 when connected to mains

> Note: This should probably provide much more features. For example batteries. And more.\

> Note: Currently only support ONE display for brightness. Should support many.\

> Note: Currently only support ONE power source for iac. Should support many.\

> Note: The named pipes location should be configurable.\

> Side note: this does not use DBus. Not because we find DBus particulary evil, but to keep the number of dependencies small.\

> A future feature might be optional DBus support. Maybe implementing (part) of upower or something like that.

> This project is _especially_ open for more features. But keep in mind that this shall always remain a pretty thin layer. And look at the protocol. Its primitive, and shall remain so.

h2. nxulock

<pre>

nxulock -t

</pre>

Locks the screen. Uses value of key _lockApp_ if set, otherwise: csxlock, sxlock, slock xscreensaver. Uses **nxhshlibs** `prime_user` to find the current user owning an X11 session (see there). If the current user is neither that nor root, screen locking fails.

When `-t` is set returns 0 when the screen was already locked by nxulock and echos the PID of the current screen locker. Return 1 otherwise.

> Note: Screen locking should work at least also when the current user is not the prime_user but has an X11 session nontheless. The whole thing is somewhat b0rky. See **nxhshlibs** `prime_user` for more on that. Anyway. _Works for me_

h2. nxunotify

<pre>

nxunotify

</pre>

A wrapper for notify-send. When called as root, uses **nxhshlibs** `prime_user` to get the current X11 user and use notify-send as that user. Sets notify-send's `-a` parameter to the calling processes' name. All parameters are send through.

> Use with care (as root user), as one can never be quite sure which user gets the message.

h2. nxurandr

<pre>

nxrandr

</pre>

Execs the value of key _randrApp_. When called as root, uses **nxhshlibs** `prime_user` to get the current X11 user and exec the value of key _randrApp_ in that users X session. Used to bind a xrandr-GUI-tool to an ACPI-key.

> This is a stub. Should rather become universal.

h2. nxwall

<pre>

nxwall path setter

</pre>

Randomly pics an image from `path` (recursive), and sets that as X-wallpaper using `setter`.

h2. nxxdg

<pre>

nxxdg [get file] [set aplication file]

</pre>

Either `get`s `file`s mimetype (via xdg-mime) or `set`s `application` as handler for `file`s mimetype (via xdg-mime). Makes working with xdg-open a wee bit less painfull. Stull hurts. A lot.

> Total stub. WIP. More an idea. Dont look.

h2. nxxsel

<pre>

nxxsel

</pre>

Displays a menu to select the X session to start.

> Now THIS is most stubby stub of all. Its literally just the menu I use. Completly static. Well, one can copy and modify it. But no worries, i intend to improve this.\

> Might be moved to nxinit

h2. wait_wm

<pre>

wait_wm

</pre>

Simply waits until there is window manager present. Usefull for X initialization. Some thing to not like to be started before a window manager appears.

> Might be moved to nxinit