summaryrefslogtreecommitdiff
path: root/debian/circle-fe-gtk.pod
diff options
context:
space:
mode:
Diffstat (limited to 'debian/circle-fe-gtk.pod')
-rw-r--r--debian/circle-fe-gtk.pod77
1 files changed, 77 insertions, 0 deletions
diff --git a/debian/circle-fe-gtk.pod b/debian/circle-fe-gtk.pod
new file mode 100644
index 0000000..7567d71
--- /dev/null
+++ b/debian/circle-fe-gtk.pod
@@ -0,0 +1,77 @@
+=head1 NAME
+
+circle-fe-gtk - GTK 2 frontend for the Circle IRC client
+
+=head1 SYNOPSIS
+
+B<circle-fe-gtk> I<url>
+
+=head1 DESCRIPTION
+
+B<Circle> is an IRC client which merges the best attributes of a local
+client and the common screen+irssi recipe:
+
+=over
+
+=item * Keep IRC connects and state on a backend server, allowing
+disconnections from local UI.
+
+=item * Interact with a real local GUI for the frontend, instead of
+incurring SSH roundtrips for every keypress.
+
+=back
+
+Circle uses L<Tangence> for its underlying communications layer.
+
+B<circle-fe-gtk> is a GTK 2 user interface for B<Circle>. It needs
+B<circle-be> to be installed on the same or a different machine
+in order to be useful.
+
+The B<circle-fe-gtk> command accepts a single argument, a URL to the B<Circle>
+backend socket.
+
+The URL should be one of the following:
+
+=over
+
+=item * B<tcp://I<host>:I<port>>
+
+Connect to I<host>:I<port> over TCP.
+
+=item * B<exec:///I<path>?I<arguments>>
+
+Execute command I<path> with I<arguments>.
+
+=item * B<unix:///I<path>>
+
+Connect to a UNIX socket I<path>.
+
+=item * B<sshexec://I<host>/I<path>>
+
+Execute command I<path> with I<arguments> on a remote I<host> over SSH.
+
+=item * B<sshunix://I<host>/I<path>>
+
+Connect to a UNIX socket I<path> on a remote I<host> over SSH.
+
+=back
+
+=head1 ENVIRONMENT
+
+=over
+
+=item I<DISPLAY>
+
+X11 display to connect to.
+
+=back
+
+=head1 SEE ALSO
+
+L<circle-be(1)>, L<Circle(3pm)>
+
+=head1 AUTHOR
+
+This manual page was written by Andrej Shadura L<< <andrewsh@debian.org> >> for the Debian project (but may be used by others).
+
+The author of Circle is Paul Evans L<< <leonerd@leonerd.org.uk> >>