1BZADMIN(6)                          BZFlag                          BZADMIN(6)
2
3
4

NAME

6       bzadmin - a text based client for BZFlag
7

SYNOPSIS

9       bzadmin  [-help]  [-hide  msgtype[,msgtype]...]   [-show  msgtype[,msg‐
10       type]...]  [-ui {curses | stdboth | stdin  |  stdout}]  callsign[:pass‐
11       word]@hostname[:port] [command] [command] ...
12

DESCRIPTION

14       bzadmin is a textbased client for the game BZFlag. It can't be used for
15       playing, but it can be used to see when  players  join  and  leave  the
16       game,  to  see  the chat messages, and to send messages and commands to
17       the server, as well as see several other vital game messages.
18
19       When you start bzadmin without any  command  line  options  other  than
20       callsign  and  hostname  a  simple  curses-based user interface will be
21       started (unless you built bzadmin without curses support). This  inter‐
22       face  is divided into three rectangles; the output window (which covers
23       almost all of the terminal), the target window, and the input window.
24
25       The output window is where messages from the server will be shown.
26
27       The target window shows the name of the player that will  receive  your
28       next  message, or 'all' if it will be a public message.  You can change
29       target by using the left and right arrow keys.
30
31       The input window is where you type your messages. It also supports  tab
32       completion  of  commands  and callsigns. You can clear the input window
33       with the key combination Ctrl-U, and you can generate a  /kick  command
34       for  the  current  target  with  the F5 key (if the current target is a
35       player). You can also generate a ban command  for  the  current  target
36       with the F6 key, but this only works if you are an admin and the server
37       has sent you that players IP address (as a response  to  a  /playerlist
38       command).
39
40       The  curses  user interface also has a simple menu system where you can
41       edit the server variables (if you are an admin) and see a player  list.
42       If  you  are  an  admin you can also see the IP addresses in the player
43       list, if you have sent a /playerlist command. The menu  shows  up  when
44       you  hit  the  F2 key.  It only covers the upper half of the screen, so
45       you can still see what's going on in the game. You can navigate through
46       the  menu with the up and down arrow keys, and use the enter key to se‐
47       lect submenus and other menu items. If you hit  F2  again  the  command
48       prompt  will regain keyboard focus, but the menu will still be visible.
49       If you hit F2 a third time the menu will go away.
50
51   Options
52              -help          Show a simple help text.
53
54              -hide msgtype[,msgtype]...
55                             Tell bzadmin not to show these message types. The
56                             available  message  types  are  chat, join, kill,
57                             leave, pause,  ping,  rabbit,  spawn,  time,  and
58                             over.  By default chat, join, kill, leave, pause,
59                             and rabbit are shown. You can  also  change  this
60                             while  bzadmin is running with the commands /show
61                             <msgtype>  and  /hide  <msgtype>,  and  from  the
62                             curses menu.
63
64              -show msgtype[,msgtype]...
65                             Tell  bzadmin  to  show  these message types. See
66                             -hide for a list of available message types. If a
67                             message type is listed both in -show and -hide it
68                             will not be shown.
69
70              -ui {curses | stdboth | stdin | stdout}
71                             Select the user  interface  that  you  want.  The
72                             curses  interface  is  the default, and it is de‐
73                             scribed above.
74                             The stdin interface reads user commands from  the
75                             standard  in stream and sends them to the server.
76                             All server output is ignored.
77                             The stdout interface prints all server output  to
78                             the  standard  out stream.  All user input is ig‐
79                             nored.
80                             The stdboth interface is a combination  of  stdin
81                             and stdout - it prints server output to the stan‐
82                             dard out stream, and reads user commands from the
83                             standard in stream.
84
85              callsign[:password]@hostname[:port]
86                             Specifies  the callsign that you want your client
87                             to use, and the hostname where the BZFlag  server
88                             is.  The port number is optional, and the default
89                             value is 5154.
90
91              command        You can specify messages and commands to send  to
92                             the server on the command line. BZAdmin will con‐
93                             tinue running after sending  the  specified  com‐
94                             mands.
95
96   Examples
97              bzadmin admin@localhost:5154
98                             Join  the game on localhost, port 5154, using the
99                             callsign 'admin'.
100
101              bzadmin admin@localhost '/passwd secretpass' '/ban 192.168.0.2'
102                             Connect to the server at localhost and ban the IP
103                             192.168.0.2.
104
105              bzadmin -ui stdout spy@bzserver.xy | grep magicword
106                             Connect  to bzserver.xy and print all server mes‐
107                             sages that contain 'magicword'.
108

SEE ALSO

110       bzfs(6), bzflag(6), bzw(5)
111
112
113
114BZFlag 2.4.26                     2022-11-26                        BZADMIN(6)
Impressum