yarp.sgml

来自「一个语言识别引擎」· SGML 代码 · 共 213 行

<!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>Paul</firstname>">
  <!ENTITY dhsurname   "<surname>Fitzpatrick</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>April 18, 2006</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>[e-mail]</email>">
  <!ENTITY dhusername  "Paul Fitzpatrick">
  <!ENTITY dhucpackage "<refentrytitle>YARP</refentrytitle>">
  <!ENTITY dhpackage   "yarp">

  <!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>this is the YARP network companion.  It helps you control communication between ports in different programs across a local network.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option>verbose</option></arg>

      <command>COMMAND</command>

      <arg><option>OPTIONS</option></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>The
      <command>&dhpackage;</command> lets a user interact with a
      YARP network.</para>

    <para>For example, "yarp server" starts a name server, "yarp list"
    reports known ports, and "yarp connect /foo /bar" sends any output
    from port "/foo" to "/bar".</para>

  </refsect1>
  <refsect1>
    <title>COMMANDS</title>

    <variablelist>

      <varlistentry>
        <term><option>help</option>
        </term>
        <listitem>
          <para>Show list of possible commands.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>where</option>
        </term>
        <listitem>
          <para>Report contact information for YARP name server, 
	  if it is running.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>server</option>
        </term>
        <term><option>server PORT</option>
        </term>
        <term><option>server HOSTNAME PORT</option>
        </term>
        <listitem>
          <para>Run YARP name server (optionally with specified identifier and port).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>read PORTNAME</option>
        </term>
        <listitem>
          <para>Read from standard input and broadcast to the specified PORTNAME.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>write PORTNAME</option>
        </term>
        <listitem>
          <para>Write to standard output from the specified PORTNAME.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>connect SRCNAME DESTNAME</option>
        </term>
        <term><option>connect SRCNAME DESTNAME [tcp|udp|mcast|text|...]</option>
        </term>
        <listitem>
          <para>Connect from the output port SRCNAME to the input port DESTNAME (optionally using a specified protocol).  A single output port can broadcast to many input ports, and a single input port can receive from many output ports.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>disconnect SRCNAME DESTNAME</option>
        </term>
        <listitem>
          <para>Disconnect the output port SRCNAME from the input port DESTNAME.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>check</option>
        </term>
        <listitem>
          <para>Does a very basic test of the YARP network to make sure it seems to be operating okay.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>version</option>
        </term>
        <listitem>
          <para>Show version of program.</para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>netcat (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 terms of the &gnu; General Public License, Version 2 any 
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</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:
-->