BZAdmin - Revision history

Zehra: /* Command Line Options */ added wiki table

2017-02-15T22:31:56Z

Command Line Options: added wiki table

← Older revision		Revision as of 22:31, 15 February 2017
Line 46:		Line 46:

	== Command Line Options ==		== Command Line Options ==
			{\|{{Prettytable}}
	'''-help'''		\|-
			\| {{Hl3}} \|'''Command'''
	This will display a help message including a list of command line options.		\| {{Hl3}} \|'''Description'''
			\|-
			\| '''-help''' \|\| This will display a help message including a list of command line options.
	'''-hide msgtype{,msgtype}*'''		\|-
			\| '''-hide msgtype{,msgtype}*''' \|\| Tell bzadmin not to show these message types. The available message types are: chat, join, kill, leave, pause, ping, rabbit, and spawn. By default chat, join, kill, leave, pause, and rabbit are shown.
	Tell bzadmin not to show these message types. The available message types are: chat, join, kill, leave, pause, ping, rabbit, and spawn. By default chat, join, kill, leave, pause, and rabbit are shown.		\|-
			\| '''-show msgtype{,msgtype}*''' \|\| Tell bzadmin to show these message types. See -hide for a list of available message types. If a message type is listed both in -show and -hide it will not be shown.
			\|-
	'''-show msgtype{,msgtype}*'''		\| '''-ui <nowiki>{curses \| stdboth \| stdin \| stdout}</nowiki>''' \|\| Select the user interface that you want. The curses interface is the default, and it is described above. The stdin interface reads user commands from the standard in stream and sends them to the server. All server output is ignored. The stdout interface prints all server output to the standard out stream. All user input is ignored. The stdboth interface is a combination of stdin and stdout - it prints server output to the standard out stream, and reads user commands from the standard in stream.
			\|-
	Tell bzadmin to show these message types. See -hide for a list of available message types. If a message type is listed both in -show and -hide it will not be shown.		\|}


	'''-ui {curses \| stdboth \| stdin \| stdout}'''

	Select the user interface that you want. The curses interface is the default, and it is described above. The stdin interface reads user commands from the standard in stream and sends them to the server. All server output is ignored. The stdout interface prints all server output to the standard out stream. All user input is ignored. The stdboth interface is a combination of stdin and stdout - it prints server output to the standard out stream, and reads user commands from the standard in stream.

	== Other Examples ==		== Other Examples ==

RayCast: /* Running BZAdmin */

2012-06-21T20:33:47Z

Running BZAdmin

← Older revision		Revision as of 20:33, 21 June 2012
Line 6:		Line 6:

	== Running BZAdmin ==		== Running BZAdmin ==
	~~''Please note that: The password and/or port are optional. BZAdmin will default to port 5154.''~~

	~~=== Mac ===~~		BZAdmin is run from the command line with its required arguments, a callsign and a server:
	~~Open up~~ a ~~terminal (/Applications/Utilities/Terminal.app)~~ and ~~type~~:
			Please note: fields surrounded by brackets e.g. "[field]" are optional''

	{\|		{\|
	\|		\|
	~~/Applications/BZFlag*/Contents/MacOS/~~bzadmin callsign[:password]@server[:port]		bzadmin callsign[:password]@server[:port]
	\|}
	~~Example:~~
	{\|
	\|
	~~/Applications/BZFlag2.0.8/Contents/MacOS/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158~~
	\|}		\|}

	=== Windows ===		=== Examples ===

			On specific platforms for the callsign "example" with a password of "password" accessing the viper.pimpi.org server at port 5158:

			==== Windows ====
	Open up a command prompt (start -> run -> "cmd") and type:		Open up a command prompt (start -> run -> "cmd") and type:

	{\|		{\|
	\|		\|
	"C:\Program Files\BZFlag*\bzadmin.exe" ~~callsign[~~:password]@~~server[~~:~~port]~~"		"C:\Program Files\BZFlag2.4.0_32Bit\bzadmin.exe" example:password@viper.pimpi.org:5158"
	\|}		\|}
	~~Example~~:
			==== Mac OS X ====

			Open up a terminal (/Applications/Utilities/Terminal.app) and type:

	{\|		{\|
	\|		\|
	~~"C:\Program Files\~~BZFlag2.0.8\bzadmin~~.exe" brad~~:~~imanidiot~~@~~tankwar~~.~~gamesunited~~.de:5158"		/Applications/BZFlag2.4.0.app/Contents/MacOS/bzadmin example:password@viper.pimpi.org:5158
	\|}		\|}

	=== ~~Unix~~ ===		==== Linux ====
	Open up a terminal and type:		Open up a terminal and type:

	{\|		{\|
	\|		\|
	/usr/local/bin/bzadmin ~~callsign[~~:password]@~~server[:port]~~		/usr/local/bin/bzadmin example:password@viper.pimpi.org:5158
	\|}
	~~Example:~~
	{\|
	\|
	~~/usr/local/bin/bzadmin brad:imanidiot@tankwar~~.~~gamesunited~~.de:5158
	\|}		\|}

RayCast: /* Running BZAdmin */

2011-08-20T16:56:31Z

Running BZAdmin

← Older revision		Revision as of 16:56, 20 August 2011
Line 6:		Line 6:

	== Running BZAdmin ==		== Running BZAdmin ==
	''Please note that: The password and/or port are optional. ~~Without a port set, the~~ default port is 5154.''		''Please note that: The password and/or port are optional. BZAdmin will default to port 5154.''

	=== Mac ===		=== Mac ===

RayCast: /* Running BZAdmin */

2011-08-20T16:54:59Z

Running BZAdmin

← Older revision		Revision as of 16:54, 20 August 2011
Line 6:		Line 6:

	== Running BZAdmin ==		== Running BZAdmin ==
	~~NOTE~~: The password and/or port are optional. ~~The~~ default port is 5154.		''Please note that: The password and/or port are optional. Without a port set, the default port is 5154.''

	=== Mac ===		=== Mac ===

RayCast: Organized Running Examples

2011-08-20T16:51:52Z

Organized Running Examples

← Older revision		Revision as of 16:51, 20 August 2011
Line 3:		Line 3:
	When you start [[BZAdmin]] without any command line options other than callsign and hostname a simple curses-based user interface will be started (unless you built [[BZAdmin]] without curses support). This interface is divided into three rectangles; the output window (which covers almost all of the terminal), the target window, and the input window.		When you start [[BZAdmin]] without any command line options other than callsign and hostname a simple curses-based user interface will be started (unless you built [[BZAdmin]] without curses support). This interface is divided into three rectangles; the output window (which covers almost all of the terminal), the target window, and the input window.

	The curses user interface also has a simple menu system where you can edit the server variables (if you are an admin) and see a player list. If you are an admin you can also see the IP addresses in the player list, if you have sent a /playerlist command. The menu shows up when you hit the F2 key. It only covers the upper half of the screen, so you can still see what's going on in the game. You can navigate through the menu with the up and down arrow keys, and use the enter key to select submenus and other menu items. If you hit F2 again the command prompt will regain keyboard focus, but the menu will still be visible. If you hit F2 a third time the menu will go away.		The curses user interface also has a simple menu system where you can edit the server variables (if you are an admin) and see a player list. If you are an admin you can also see the IP addresses in the player list, if you have sent a /playerlist command. The menu shows up when you hit the F2 key. It only covers the upper half of the screen, so you can still see what's going on in the game. You can navigate through the menu with the up and down arrow keys, and use the enter key to select submenus and other menu items. If you hit F2 again the command prompt will regain keyboard focus, but the menu will still be visible. If you hit F2 a third time the menu will go away.

	== Mac ==		== Running BZAdmin ==
			NOTE: The password and/or port are optional. The default port is 5154.

			=== Mac ===
	Open up a terminal (/Applications/Utilities/Terminal.app) and type:		Open up a terminal (/Applications/Utilities/Terminal.app) and type:
	{\|		{\|
Line 16:		Line 19:
	/Applications/BZFlag2.0.8/Contents/MacOS/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158		/Applications/BZFlag2.0.8/Contents/MacOS/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158
	\|}		\|}
	~~NOTE: The password and/or port are optional. The default port is 5154.~~

	== Windows ==		=== Windows ===
	Open up a command prompt (start -> run -> "cmd") and type:		Open up a command prompt (start -> run -> "cmd") and type:
	{\|		{\|
Line 29:		Line 31:
	"C:\Program Files\BZFlag2.0.8\bzadmin.exe" brad:imanidiot@tankwar.gamesunited.de:5158"		"C:\Program Files\BZFlag2.0.8\bzadmin.exe" brad:imanidiot@tankwar.gamesunited.de:5158"
	\|}		\|}
	~~NOTE: The password and/or port are optional. The default port is 5154.~~

	== Unix ==		=== Unix ===
	Open up a terminal and type:		Open up a terminal and type:
	{\|		{\|
Line 42:		Line 43:
	/usr/local/bin/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158		/usr/local/bin/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158
	\|}		\|}
	~~NOTE: The password and/or port are optional. The default port is 5154.~~

	== ~~Other~~ Command Line Options ==		== Command Line Options ==

	'''-help'''		'''-help'''

RayCast: /* Mac */

2011-08-20T16:47:54Z

Mac

← Older revision		Revision as of 16:47, 20 August 2011
Line 6:		Line 6:

	== Mac ==		== Mac ==
	Open up a terminal (Terminal.app) and type:		Open up a terminal (/Applications/Utilities/Terminal.app) and type:
	{\|		{\|
	\|		\|

A11: Undo revision 7884 by 173.236.27.154 (talk)

2011-07-25T04:03:11Z

Undo revision 7884 by 173.236.27.154 (talk)

Show changes

173.236.27.154: /* Mac */

2011-07-25T03:55:22Z

Mac

Show changes

Joevano at 13:35, 11 March 2007

2007-03-11T13:35:25Z

← Older revision		Revision as of 13:35, 11 March 2007
Line 22:		Line 22:
	{\|		{\|
	\|		\|
	"C:\Program Files\BZFlag*\bzadmin.exe" callsign[:password]@server[:port]		"C:\Program Files\BZFlag*\bzadmin.exe" callsign[:password]@server[:port]"
	\|}		\|}
	Example:		Example:
	{\|\|		{\|
	"C:\Program Files\BZFlag2.0.8\bzadmin.exe" brad:imanidiot@tankwar.gamesunited.de:5158		\|
			"C:\Program Files\BZFlag2.0.8\bzadmin.exe" brad:imanidiot@tankwar.gamesunited.de:5158"
	\|}		\|}
	NOTE: The password and/or port are optional. The default port is 5154.		NOTE: The password and/or port are optional. The default port is 5154.
Line 32:		Line 33:
	== Unix ==		== Unix ==
	Open up a terminal and type:		Open up a terminal and type:
	{\|\|		{\|
			\|
	/usr/local/bin/bzadmin callsign[:password]@server[:port]		/usr/local/bin/bzadmin callsign[:password]@server[:port]
	\|}		\|}
	Example:		Example:
	{\|\|		{\|
			\|
	/usr/local/bin/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158		/usr/local/bin/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158
	\|}		\|}
Line 64:		Line 67:
	== Other Examples ==		== Other Examples ==
	Join the game on localhost, port 5154, using the callsign 'admin'.		Join the game on localhost, port 5154, using the callsign 'admin'.
	{\|\|		{\|
			\|
	bzadmin admin@localhost:5154		bzadmin admin@localhost:5154
	\|}		\|}
	Connect to the server at localhost and ban the IP 192.168.0.2 for 2 hours.		Connect to the server at localhost and ban the IP 192.168.0.2 for 2 hours.
	{\|\|		{\|
			\|
	bzadmin admin@localhost "/password secretpass" "/ban 192.168.0.2 2h test"		bzadmin admin@localhost "/password secretpass" "/ban 192.168.0.2 2h test"
	\|}		\|}
	Connect to bzserver.org and print all server messages that contain 'magicword'.		Connect to bzserver.org and print all server messages that contain 'magicword'.
	{\|\|		{\|
			\|
	bzadmin -ui stdout spy@bzserver.org \| grep magicword		bzadmin -ui stdout spy@bzserver.org \| grep magicword
	\|}		\|}
	[[Category:Client]]		[[Category:Client]]

Joevano: Formatting

2007-03-11T13:31:21Z

Formatting

← Older revision		Revision as of 13:31, 11 March 2007
Line 7:		Line 7:
	== Mac ==		== Mac ==
	Open up a terminal (Terminal.app) and type:		Open up a terminal (Terminal.app) and type:
			{\|
			\|
	/Applications/BZFlag*/Contents/MacOS/bzadmin callsign[:password]@server[:port]		/Applications/BZFlag*/Contents/MacOS/bzadmin callsign[:password]@server[:port]
			\|}
	Example:		Example:
			{\|
			\|
	/Applications/BZFlag2.0.8/Contents/MacOS/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158		/Applications/BZFlag2.0.8/Contents/MacOS/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158
			\|}
	NOTE: The password and/or port are optional. The default port is 5154.		NOTE: The password and/or port are optional. The default port is 5154.

	== Windows ==		== Windows ==
	Open up a command prompt (start -> run -> "cmd") and type:		Open up a command prompt (start -> run -> "cmd") and type:
			{\|
			\|
	"C:\Program Files\BZFlag*\bzadmin.exe" callsign[:password]@server[:port]		"C:\Program Files\BZFlag*\bzadmin.exe" callsign[:password]@server[:port]
			\|}
	Example:		Example:
			{\|\|
	"C:\Program Files\BZFlag2.0.8\bzadmin.exe" brad:imanidiot@tankwar.gamesunited.de:5158		"C:\Program Files\BZFlag2.0.8\bzadmin.exe" brad:imanidiot@tankwar.gamesunited.de:5158
			\|}
	NOTE: The password and/or port are optional. The default port is 5154.		NOTE: The password and/or port are optional. The default port is 5154.

	== Unix ==		== Unix ==
	Open up a terminal and type:		Open up a terminal and type:
			{\|\|
	/usr/local/bin/bzadmin callsign[:password]@server[:port]		/usr/local/bin/bzadmin callsign[:password]@server[:port]
			\|}
	Example:		Example:
			{\|\|
	/usr/local/bin/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158		/usr/local/bin/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158
			\|}
	NOTE: The password and/or port are optional. The default port is 5154.		NOTE: The password and/or port are optional. The default port is 5154.

Line 61:		Line 64:
	== Other Examples ==		== Other Examples ==
	Join the game on localhost, port 5154, using the callsign 'admin'.		Join the game on localhost, port 5154, using the callsign 'admin'.
			{\|\|
	bzadmin admin@localhost:5154		bzadmin admin@localhost:5154
			\|}
	Connect to the server at localhost and ban the IP 192.168.0.2 for 2 hours.		Connect to the server at localhost and ban the IP 192.168.0.2 for 2 hours.
			{\|\|
	bzadmin admin@localhost "/password secretpass" "/ban 192.168.0.2 2h test"		bzadmin admin@localhost "/password secretpass" "/ban 192.168.0.2 2h test"
			\|}
	Connect to bzserver.org and print all server messages that contain 'magicword'.		Connect to bzserver.org and print all server messages that contain 'magicword'.
			{\|\|
	bzadmin -ui stdout spy@bzserver.org \| grep magicword		bzadmin -ui stdout spy@bzserver.org \| grep magicword
			\|}
	[[Category:Client]]		[[Category:Client]]