awesome/awesome-client.1.txt

awesome-client(1)
=================

NAME
----

awesome-client - awesome window manager command line interface

SYNOPSIS
--------

awesome-client

DESCRIPTION
-----------

awesome-client is the command line interface to awesome. It communicates with awesome
via a socket located in the users's HOME directory.

USAGE
-----
To determine which socket is to be used, it reads the DISPLAY environment variable.
awesome-client reads commands from standard input.

When you pipe multiple lines into awesome-client, an empty line will flush already
collected lines into awesome with an according immediate execution.

The command format is:
 screen_number command argument

For example, to change a statusbar textbox text on screen 0, you can do the following:

    echo 0 widget_tell <statusbar-name> <textbox-name> text Hello, world | awesome-client

To change an iconbox image on screen 1, you can do the following:

    echo 0 widget_tell <statusbar-name> <iconbox-name> image /home/user/image.jpg | awesome-client

To view tag number 3 on screen 1:

    echo 1 tag_view 3 | awesome-client

To zoom focused window on screen 0:

    echo 0 client_zoom | awesome-client

To execute a command on all active screens, use -1 as the screen number:

    echo -1 tag_view 3 | awesome-client

SEE ALSO
--------
awesome(1) awesomerc(5)

AUTHORS
-------
Julien Danjou <julien@danjou.info>

WWW
---
http://awesome.naquadah.org