HGDC(1)

NAME
hgdc - Client for the Hackathon Gunther Daemon.

SYNOPSIS
hgdc [-AaEehv] [-c config] [-m max-items] [-p port] [FL r refresh] [-s host] [-u user] [-x debug-level] Command Args

DESCRIPTION
hgdc is a client for the Hackathon Gunther Daemon; a music system suitable for hackathons, internet cafes, LAN parties etc.

The options are as follows:

-a  Turn ANSI terminal colours ON.

-A  Turn ANSI terminal colours OFF.

-c config
    Location of config file.

-e  Require server to supply an SSL encrypted channel, or exit.

-E  Don't use SSL encryption. The server has the rights to reject your connection.

-h  Show the usage help and exit.

-m max-items
    Maximum number of items to show in the playlist/hud display.

-p port
    Set the TCP port to connect to hgd-netd(1) on. Defaults to 6633.

-r refresh
    Set the refresh rate of the hud (in seconds).

-s host
    Set the server host name or IP.

-u user
    Set username to authenticate with.

-v  Show version information and exit.

-x level
    Set the debug level: 0=errors, 1=warnings, 2=info, 3=debug. Defaults to 1.

The commands are as follows:

hud Enter `heads up display mode'; shows the playlist updating every second. A persistent server connection is used.

id  Display information about your user account, including permissions and votes.

ls  Show playlist.

np  Show the now playing track.

q file1 [file2 ...]
    Queue the given file(s) in the playlist.

vo  Vote-off the currently playing track.

There are also the following admin commands:

skip
    Skip the currently playing song.

Pause
    Pause / un-pause the currently playing song.

user-add <user> [password]
    Add a new user to the server.

user-del <user>
    Remove <user> from the server.

user-list
    List all users registered on the server (and their permissions).

user-mkadmin <user>
    Make <user> and admin allowing them to use these admin commands.

user-noadmin <user>
    Remove <user>'s admin rights.

A NOTE ABOUT ENCRYPTION
NOTE: SSL support in HGD is fine as-is for encryption purposes, but host authentication (proving the server identity) is NOT (yet) implemented.

You can turn off SSL encryption or refuse speak to servers if they don't support SSL with -E and -e respectively; however the default behaviour involves a handshake between the client and server, favouring an encrypted connection if possible, otherwise falling back onto unencrypted socket communication.

A warning is always printed if SSL encryption is not enabled.

FILES
hgdc can read it's settings from a config file. The following locations (in the order shown) are searched:

1.  A path specified by '-c' (if given).
2.  ~/.config/hgd/hgdc.rc
3.  /etc/hgd/hgdc.rc

The first config file found is used. If no config file is found, default settings are used.

Sample config files are supplied in the source tarball and should be supplied by binary packagers.

HISTORY
HGD was inspired by the LPD hack -- a music system used at OpenBSD hackathons.

AUTHORS
-nosplit hgdc was written by Edd Barrett <vext01@gmail.com>, and Martin Ellis <ellism88@gmail.com>.

BUGS
Probably.