<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
  <!ENTITY dhsurname   "<surname>SURNAME</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>Mar 10, 2008</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>grandpaul@gmail.com</email>">
  <!ENTITY dhusername  "paulliu">
  <!ENTITY dhucpackage "<refentrytitle>NICOVIDEO-DL</refentrytitle>">
  <!ENTITY dhpackage   "nicovideo-dl">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>download a video file from www.nicovideo.jp</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option>options</option></arg>

      <arg choice="req"><replaceable>video_url</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.
    </para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.
    </para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>These programs follow the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.  
    </para>
    <variablelist>
      <varlistentry>
        <term><option>-h</option>
          <option>--help</option>
        </term>
        <listitem>
          <para>print this help text and exit</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-u <replaceable>USERNAME</replaceable></option>
          <option>--username=<replaceable>USERNAME</replaceable></option>
        </term>
        <listitem>
          <para>account username (e-mail address)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-p <replaceable>PASSWORD</replaceable></option>
          <option>--password=<replaceable>PASSWORD</replaceable></option>
        </term>
        <listitem>
          <para>account password</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-o <replaceable>FILE</replaceable></option>
          <option>--output=<replaceable>FILE</replaceable></option>
        </term>
        <listitem>
          <para>output video file name</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-q</option>
          <option>--quiet</option>
        </term>
        <listitem>
          <para>activates quiet mode</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option>
          <option>--simulate</option>
        </term>
        <listitem>
          <para>do not download video</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-t</option>
          <option>--title</option>
        </term>
        <listitem>
          <para>use title in file name</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-l</option>
          <option>--literal</option>
        </term>
        <listitem>
          <para>use literal title in file name</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-n</option>
          <option>--netrc</option>
        </term>
        <listitem>
          <para>use <filename>.netrc</filename> authentication data</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-g</option>
          <option>--get-url</option>
        </term>
        <listitem>
          <para>print final video URL only</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-2</option>
          <option>--title-too</option>
        </term>
        <listitem>
          <para>used with -g, print title too</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-c</option>
          <option>--get-comment</option>
        </term>
        <listitem>
          <para>download comment</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-x</option>
          <option>--raw-comment</option>
        </term>
        <listitem>
          <para>save comment in raw xml</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--comment-output=<replaceable>FILE</replaceable></option>
        </term>
        <listitem>
          <para>output comment file name</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>
          <option>--version</option>
        </term>
        <listitem>
          <para>print program version and exit</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>youtube-dl (1).</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the same terms as the license of the original software.
    </para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
