1HERBSTCLIENT(1)                                                HERBSTCLIENT(1)
2
3
4

NAME

6       herbstclient - sends commands to a running herbstluftwm instance via X
7

SYNOPSIS

9       herbstclient [OPTIONS] COMMAND [ARGS ...]
10
11       herbstclient [OPTIONS] [--wait|--idle] [FILTER ...]
12

DESCRIPTION

14       Sends a COMMAND with its (optional) arguments ARGS to a running
15       herbstluftwm(1) instance via Xlib. If COMMAND has an output, it is
16       printed by herbstclient. If output does not end with a newline, then a
17       newline is added to improve readability.
18
19       See herbstluftwm(1) for a list of available COMMANDs and their ARGS.
20
21       If --wait or --idle is passed, then it waits for hooks from
22       herbstluftwm. The hook is printed, if it matches the optional FILTER.
23       FILTERs are regular expressions. For a list of available hooks see
24       herbstluftwm(1).
25

OPTIONS

27       -n, --no-newline
28           Do not print a newline if output does not end with a newline.
29
30       -0, --print0
31           Use the null character as delimiter between the output of hooks.
32
33       -l, --last-arg
34           When using -i or -w, only print the last argument of the hook.
35
36       -i, --idle
37           Wait for hooks instead of executing commands.
38
39       -w, --wait
40           Same as --idle but exit after first --count hooks.
41
42       -c, --count COUNT
43           Let --wait exit after COUNT hooks were received and printed. The
44           default COUNT is 1.
45
46       -q, --quiet
47           Do not print error messages if herbstclient cannot connect to the
48           running herbstluftwm instance.
49
50       -v, --version
51           Print the herbstclient version. To get the herbstluftwm version,
52           use herbstclient version.
53
54       -h, --help
55           Print the herbstclient usage with its command line options.
56

ENVIRONMENT VARIABLES

58       DISPLAY
59           Specifies the DISPLAY to use, i.e. where herbstluftwm(1) is
60           running.
61

EXIT STATUS

63       Returns the exit status of the COMMAND execution in herbstluftwm(1)
64       server.
65
66       0
67           Success.
68
69       other
70           Failure. See herbstluftwm(1) for a list of error codes.
71

BUGS

73       See the herbstluftwm distribution BUGS file.
74

COMMUNITY

76       Feel free to join the IRC channel #herbstluftwm on irc.freenode.net.
77

AUTHOR

79       herbstclient was written by Thorsten Wißmann. All contributors are
80       listed in the herbstluftwm distribution AUTHORS file.
81

RESOURCES

83       Homepage: http://herbstluftwm.org
84
85       Github page: http://github.com/herbstluftwm/herbstluftwm
86
87       Patch submission and bug reporting:
88
89           hlwm@lists.herbstluftwm.org
90

COPYING

92       Copyright 2011-2020 Thorsten Wißmann. All rights reserved.
93
94       This software is licensed under the "Simplified BSD License". See
95       LICENSE for details.
96
97
98
99  herbstluftwm 0.9.0              2021-07-22                   HERBSTCLIENT(1)