about summary refs log tree commit homepage
path: root/Documentation/dtas-enq.pod
diff options
authorEric Wong <e@80x24.org>2016-01-18 05:18:09 +0000
committerEric Wong <e@80x24.org>2016-01-18 07:02:39 +0000
commit3083b7fbe2bc6e8dcd935b10bb7a165257c5252b (patch)
treeaf5d87ea9a2ea161df619c2305ef951cb18d087a /Documentation/dtas-enq.pod
parent0699498e5eb717a351c223e6a5a6a3bd3d3c6cde (diff)
perlpod(1) is already installed by default on Debian and
RedHat-based systems; and probably most modern *nixes; pandoc(1)
(and Haskell) are not.

POD also more standardized than Markdown (which flavor? :P),
especially for generating manpages.  So save any potential
documentation editors some disk space by not forcing them to install
Haskell and pandoc.

Finally, I'm a mildly proficient in Perl and do not know Haskell
at all and have a better chance at reading/hacking the source if
the document generator breaks.
Diffstat (limited to 'Documentation/dtas-enq.pod')
1 files changed, 43 insertions, 0 deletions
diff --git a/Documentation/dtas-enq.pod b/Documentation/dtas-enq.pod
new file mode 100644
index 0000000..2611a2e
--- /dev/null
+++ b/Documentation/dtas-enq.pod
@@ -0,0 +1,43 @@
+% dtas-enq(1) dtas user manual
+=head1 NAME
+dtas-enq - enqueue audio files for playback with dtas-player
+=head1 SYNOPSYS
+dtas-enq [FILE...]
+dtas-enq will enqueue a list of files given on the command-line to a
+running instance of L<dtas-player(1)>.  dtas-player will start playing
+the newly enqueued files in the order given.
+=head1 EXAMPLE
+        $ dtas-enq /path/to/your/favorite/album/*.flac
+DTAS_PLAYER_SOCK - the path to the dtas-player listen socket.
+This defaults to ~/.dtas/player.sock
+=head1 CONTACT
+All feedback welcome via plain-text mail to: L<mailto:dtas-all@nongnu.org>
+Mailing list archives available at L<http://80x24.org/dtas-all/>
+and L<ftp://lists.gnu.org/dtas-all/>
+No subscription is necessary to post to the mailing list.
+Copyright 2013-2016 all contributors L<mailto:dtas-all@nongnu.org>
+License: GPL-3.0+ L<http://www.gnu.org/licenses/gpl-3.0.txt>
+=head1 SEE ALSO
+L<dtas-player(1)>, L<dtas-ctl(1)>