summaryrefslogtreecommitdiff
path: root/debian/el.sgml
blob: ceb47875f6bfe7bca2df8012bfc193275543b0ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<!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>Makoto</firstname>">
  <!ENTITY dhsurname   "<surname>OHURA</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>#SHORTDATE#</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>&lt;ohura@debian.org&gt;</email>">
  <!ENTITY dhusername  "OHURA Makoto">
  <!ENTITY dhucpackage "<refentrytitle>el</refentrytitle>">
  <!ENTITY dhpackage   "el">

  <!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>program to make a tuned shell-command for Oneliner</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option>-acdfhioxV</option></arg>

      <arg><option>--command <replaceable>cmd</replaceable></option></arg>
      <arg><option>--args <replaceable>n</replaceable></option></arg>
      <arg><option>--format <replaceable>fmt</replaceable></option></arg>
      <arg><option>--execute</option></arg>
      <arg><option>--inpipe <replaceable>buf</replaceable></option></arg>
      <arg><option>--outpipe <replaceable>buf</replaceable></option></arg>
      <arg><option>--serial</option></arg>
      <arg><option>--help</option></arg>
      <arg><option>--version</option></arg>
      <arg><option>--debug</option></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.
      Instead, it has documentation in the &gnu;
      <application>Info</application> format; see below.</para>

    <para><command>&dhpackage;</command> is a program that You can
      make a tuned shell-command for Oneliner with.
      This command can send S-exp to Emacs, and this can make Emacs
      evaluate it, too.  In other words, you can execute Emacs's
      function from shell-commands.  And you can make Emacs work in
      closer cooperation with your favorite shell-commands. </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.  For a complete description, see the
      <application>Info</application> files.</para>

    <variablelist>
      <varlistentry>
        <term><option>-c <replaceable>cmd</replaceable></option>
          <option>--command <replaceable>cmd</replaceable></option>
        </term>
        <listitem>
          <para>cmd means a function of Elisp.  Command line arguments
            and data from stdin means arguments of cmd.  If you
            specify the only -c switch, el output one S-exp by one
            line of stdin.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--a <replaceable>n</replaceable></option>
          <option>--args <replaceable>n</replaceable></option>
        </term>
        <listitem>
          <para>Specifies the maximum number of arguments of a Elisp
            function with -c switch.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-f <replaceable>fmt</replaceable></option>
          <option>--format <replaceable>fmt</replaceable></option>
        </term>
        <listitem>
          <para>Allows you to use format string of printf for making a
            S-exp.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-x</option>
          <option>--execute</option>
        </term>
        <listitem>
          <para>Requests to Oneliner to evaluate the S-exp to use
            *Oneliner auto-eval* buffer.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-i <replaceable>buf</replaceable></option>
          <option>--inpipe <replaceable>buf</replaceable></option>
        </term>
        <listitem>
          <para>Gets input from pipe-buffer. You can specify a number
            of pipe-buffer, too.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-o <replaceable>buf</replaceable></option>
          <option>--outpipe <replaceable>buf</replaceable></option>
        </term>
        <listitem>
          <para>Puts output to pipe-buffer. You can specify a number
            of pipe-buffer, too.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option>
          <option>--serial</option>
        </term>
        <listitem>
          <para>Makes el to serialize multiple lines to one line.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option>
          <option>--help</option>
        </term>
        <listitem>
          <para>Display help message.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-V</option>
          <option>--version</option>
        </term>
        <listitem>
          <para>Display version identifiers.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d</option>
          <option>--debug</option>
        </term>
        <listitem>
          <para>Enable debugging state.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>The programs are documented fully by
      <citetitle>Oneliner(Shell-mode hooks for Oneliners)</citetitle>
      available via the <application>Info</application> system.
    </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:
-->