From: Antoine Beaupré <anarcat@koumbit.org>
Date: Thu, 1 May 2014 03:42:16 +0000 (-0400)
Subject: add manpage for irk
X-Git-Tag: 2.8~4
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=173d604db23fba1af1b8bc56a43707acbcf8da71;p=irker.git

add manpage for irk

i got tired of rereading the source code every time i wanted to use irk, isn't that silly?

Signed-off-by: Eric S. Raymond <esr@thyrsus.com>
---

diff --git a/Makefile b/Makefile
index a08ee4c..10ce0e7 100644
--- a/Makefile
+++ b/Makefile
@@ -9,7 +9,7 @@ prefix ?= /usr
 mandir ?= /share/man
 target = $(DESTDIR)$(prefix)
 
-docs: irkerd.html irkerd.8 irkerhook.html irkerhook.1
+docs: irkerd.html irkerd.8 irkerhook.html irkerhook.1 irk.html irk.1
 
 irkerd.8: irkerd.xml
 	xmlto man irkerd.xml
@@ -21,6 +21,11 @@ irkerhook.1: irkerhook.xml
 irkerhook.html: irkerhook.xml
 	xmlto html-nochunks irkerhook.xml
 
+irk.1: irk.xml
+	xmlto man irk.xml
+irk.html: irk.xml
+	xmlto html-nochunks irkerhook.xml
+
 install.html: install.txt
 	asciidoc -o install.html install.txt
 security.html: security.txt
@@ -28,7 +33,7 @@ security.html: security.txt
 hacking.html: hacking.txt
 	asciidoc -o hacking.html hacking.txt
 
-install: irkerd.8 irkerhook.1 uninstall
+install: irk.1 irkerd.8 irkerhook.1 uninstall
 	install -m 755 -o 0 -g 0 -d "$(target)/bin"
 	install -m 755 -o 0 -g 0 irkerd "$(target)/bin/irkerd"
 ifneq ($(strip $(SYSTEMDSYSTEMUNITDIR)),)
@@ -39,6 +44,7 @@ endif
 	install -m 755 -o 0 -g 0 irkerd.8 "$(target)$(mandir)/man8/irkerd.8"
 	install -m 755 -o 0 -g 0 -d "$(target)$(mandir)/man1"
 	install -m 755 -o 0 -g 0 irkerhook.1 "$(target)$(mandir)/man1/irkerhook.1"
+	install -m 755 -o 0 -g 0 irk.1 "$(target)$(mandir)/man1/irk.1"
 
 uninstall:
 	rm -f "$(target)/bin/irkerd"
@@ -47,9 +53,10 @@ ifneq ($(strip $(SYSTEMDSYSTEMUNITDIR)),)
 endif
 	rm -f "$(target)$(mandir)/man8/irkerd.8"
 	rm -f "$(target)$(mandir)/man1/irkerhook.1"
+	rm -f "$(target)$(mandir)/man1/irk.1"
 
 clean:
-	rm -f irkerd.8 irkerhook.1 irker-*.tar.gz *~ *.html
+	rm -f irkerd.8 irkerhook.1 irk.1 irker-*.tar.gz *~ *.html
 
 PYLINTOPTS = --rcfile=/dev/null --reports=n --include-ids=y --disable="C0103,C0111,C0301,C0302,R0201,R0902,R0903,R0912,R0913,R0914,R0915,E1101,W0142,W0201,W0212,W0621,W0702,W0703,F0401,E0611"
 pylint:
@@ -69,6 +76,7 @@ DOCS = \
 	hacking.txt \
 	irkerhook.xml \
 	irkerd.xml \
+	irk.xml \
 
 SOURCES = \
 	$(DOCS) \
@@ -87,7 +95,7 @@ EXTRA_DIST = \
 version:
 	@echo $(VERS)
 
-irker-$(VERS).tar.gz: $(SOURCES) irkerd.8 irkerhook.1
+irker-$(VERS).tar.gz: $(SOURCES) irkerd.8 irkerhook.1 irk.1
 	mkdir irker-$(VERS)
 	cp -pR $(SOURCES) $(EXTRA_DIST) irker-$(VERS)/
 	@COPYFILE_DISABLE=1 tar -cvzf irker-$(VERS).tar.gz irker-$(VERS)
@@ -95,5 +103,5 @@ irker-$(VERS).tar.gz: $(SOURCES) irkerd.8 irkerhook.1
 
 dist: irker-$(VERS).tar.gz
 
-release: irker-$(VERS).tar.gz irkerd.html irkerhook.html install.html security.html hacking.html
+release: irker-$(VERS).tar.gz irkerd.html irk.html irkerhook.html install.html security.html hacking.html
 	shipper version=$(VERS) | sh -e -x
diff --git a/irk.xml b/irk.xml
new file mode 100644
index 0000000..afa836f
--- /dev/null
+++ b/irk.xml
@@ -0,0 +1,84 @@
+<!DOCTYPE refentry PUBLIC
+   "-//OASIS//DTD DocBook XML V4.1.2//EN"
+   "docbook/docbookx.dtd">
+<refentry id='irk.8'>
+<refmeta>
+<refentrytitle>irk</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class='date'>Apr 30 2014</refmiscinfo>
+<refmiscinfo class='source'>irker</refmiscinfo>
+<refmiscinfo class='product'>irker</refmiscinfo>
+<refmiscinfo class='manual'>Commands</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>irk</refname>
+<refpurpose>test program for irkerd</refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+  <command>irk</command>
+     <arg><replaceable>target</replaceable></arg>
+     <arg choice='opt'><replaceable>message text</replaceable></arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+
+<para><application>irk</application> is a simple test program for
+<citerefentry><refentrytitle>irkerd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. It
+will construct a simple JSON object and pass it to the daemon running
+on localhost.</para>
+</refsect1>
+
+<refsect1 id='options'><title>OPTIONS</title>
+
+<para><application>irk</application> takes the following options:</para>
+
+<variablelist>
+<varlistentry>
+<term>target</term>
+<listitem><para>Which server and channel to join to announced the
+message. If not prefixed with "irc:", it will prefix
+"irc://chat.freenode.net/" to the argument before passing it directly
+to irkerd. This argument is passed as the "to" parameter in the JSON
+object.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>message</term>
+<listitem><para>Which message to send to the target specified
+above. If the string "-", the message will be read from standard
+input, with newlines stripped.</para></listitem>
+</varlistentry>
+</variablelist>
+
+</refsect1>
+
+<refsect1 id='limitations'><title>LIMITATIONS</title>
+
+<para><application>irk</application> has no commandline usage and may
+be riddled with bugs.</para>
+
+<para><application>irk</application> doesn't know how to talk to your
+favorite VCS. You will generally want to use
+<citerefentry><refentrytitle>irkerhook</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+instead</para>
+
+<para><application>irk</application> has also all the limitations of
+<application>irkerd</application>.</para>
+</refsect1>
+
+<refsect1 id='see_also'><title>SEE ALSO</title>
+<para>
+<citerefentry><refentrytitle>irkerhook</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+</para>
+</refsect1>
+
+<refsect1 id='authors'><title>AUTHOR</title>
+<para>Eric S. Raymond <email>esr@snark.thyrsus.com</email>.  See the
+project page at <ulink
+url='http://www.catb.org/~esr/irker'>http://www.catb.org/~esr/irker</ulink>
+for updates and other resources, including an installable repository
+hook script.</para>
+</refsect1>
+</refentry>