doc/man/isympy.xml

   1 <?xml version='1.0' encoding='ISO-8859-1'?>
   2 <?xml-stylesheet type="text/xsl"
   3         href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
   4 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   5         "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
   6
   7 <!-- Process this file docbook2x-man:
   8
   9 docbook2x-man isympy.xml
  10
  11 this will generate isympy.1 in the current directory. -->
  12
  13   <!-- Fill in your name for FIRSTNAME and SURNAME.              -->
  14   <!ENTITY dhfirstname "Fabian">
  15   <!ENTITY dhsurname   "Seoane">
  16   <!ENTITY dhemail     "fabian@fseoane.net">
  17   <!-- dhusername could also be set to "&firstname; &surname;".  -->
  18   <!ENTITY dhusername  "&dhfirstname; &dhsurname;">
  19
  20   <!-- Please adjust the date whenever revising the manpage.     -->
  21   <!ENTITY dhdate      "2007-10-8">
  22   <!ENTITY dhrelease   "unused">
  23
  24   <!-- TITLE should be something like "User commands",           -->
  25   <!-- "&dhpackage; command-line reference" or similar (see e.g. -->
  26   <!-- http://www.tldp.org/HOWTO/Man-Page/q2.html). But limit    -->
  27   <!-- the length to 30 chars.                                   -->
  28   <!ENTITY dhtitle     "&dhpackage; command-line reference">
  29
  30   <!ENTITY dhucpackage "isympy">
  31   <!ENTITY dhpackage   "isympy">
  32
  33   <!-- If the application e.g. belongs to a package like X.org,  -->
  34   <!-- this should be set to the its name instead.               -->
  35   <!ENTITY dhproduct   "python-sympy">
  36
  37   <!-- SECTION should be 1-8, maybe w/ subsection other          -->
  38   <!-- parameters are allowed: see man(7), man(1) and            -->
  39   <!-- http://www.tldp.org/HOWTO/Man-Page/q2.html.               -->
  40   <!ENTITY dhsection   "1">
  41
  42 ]>
  43
  44 <refentry>
  45         <refentryinfo>
  46                 <title>&dhtitle;</title>
  47                 <productname>&dhpackage;</productname>
  48                 <releaseinfo role="version">&dhrelease;</releaseinfo>
  49                 <date>&dhdate;</date>
  50                 <authorgroup>
  51                         <author>
  52                                 <firstname>Ondrej</firstname>
  53                                 <surname>Certik</surname>
  54                                 <contrib>Design, programming.</contrib>
  55                                 <address>
  56                                         <email>ondrej@certik.cz</email>
  57                                 </address>
  58                         </author>
  59                         <author>
  60                                 <firstname>&dhfirstname;</firstname>
  61                                 <surname>&dhsurname;</surname>
  62                                 <contrib>Programming.</contrib>
  63                                 <address>
  64                                         <email>&dhemail;</email>
  65                                 </address>
  66                         </author>
  67                 </authorgroup>
  68                 <copyright>
  69                         <year>2007</year>
  70                         <holder>Ondrej Certik</holder>
  71                 </copyright>
  72                 <legalnotice>
  73                         <para>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</para>
  74                         <orderedlist>
  75                                 <listitem>
  76                                         <para>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</para>
  77                                 </listitem>
  78                                 <listitem>
  79                                         <para>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</para>
  80                                 </listitem>
  81                         </orderedlist>
  82                         <para>THIS SOFTWARE IS PROVIDED BY THE AUTHOR &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</para>
  83                 </legalnotice>
  84         </refentryinfo>
  85         <refmeta>
  86                 <refentrytitle>&dhucpackage;</refentrytitle>
  87                 <manvolnum>&dhsection;</manvolnum>
  88         </refmeta>
  89         <refnamediv>
  90                 <refname>&dhpackage;</refname>
  91                 <refpurpose>interactive shell for SymPy</refpurpose>
  92         </refnamediv>
  93         <refsynopsisdiv>
  94                 <cmdsynopsis>
  95                         <command>&dhpackage;</command>
  96                         <group choice="opt">
  97                                 <arg choice="plain"><option>-c</option></arg>
  98                                 <arg choice="plain"><option>--console</option></arg>
  99                         </group>
 100                 </cmdsynopsis>
 101                 <cmdsynopsis>
 102                         <command>&dhpackage;</command>
 103       <!-- Normally the help and version options make the programs stop
 104                              right after outputting the requested information. -->
 105                         <group choice="opt">
 106                                 <arg choice="plain">
 107                                         <group choice="req">
 108                                                 <arg choice="plain"><option>-h</option></arg>
 109                                                 <arg choice="plain"><option>--help</option></arg>
 110                                         </group>
 111                                 </arg>
 112                                 <arg choice="plain">
 113                                         <group choice="req">
 114                                                 <arg choice="plain"><option>-v</option></arg>
 115                                                 <arg choice="plain"><option>--version</option></arg>
 116                                         </group>
 117                                 </arg>
 118                         </group>
 119                 </cmdsynopsis>
 120         </refsynopsisdiv>
 121         <refsect1 id="description">
 122                 <title>DESCRIPTION</title>
 123     <para>isympy is a Python shell for SymPy. It is just a normal python shell
 124         (ipython shell if you have the ipython package installed) that executes
 125         the following commands so that you don't have to:
 126     </para>
 127
 128     <programlisting>
 129 >>> from __future__ import division
 130 >>> from sympy import *
 131 >>> x, y, z = symbols("xyz")
 132 >>> k, m, n = symbols("kmn", integer=True)
 133     </programlisting>
 134
 135     <para>So starting isympy is equivalent to starting python (or ipython) and
 136     executing the above commands by hand. It is intended for easy and quick
 137     experimentation with SymPy. For more complicated programs, it is recommended
 138     to write a script and import things explicitly (using the "from sympy
 139         import sin, log, Symbol, ..." idiom).</para>
 140
 141         </refsect1>
 142         <refsect1 id="options">
 143                 <title>OPTIONS</title>
 144                 <variablelist>
 145                         <!-- Use the variablelist.term.separator and the
 146                              variablelist.term.break.after parameters to
 147                              control the term elements. -->
 148                         <varlistentry>
 149                                 <term><option>-c <replaceable class="parameter">shell</replaceable></option></term>
 150                                 <term><option>--console=<replaceable class="parameter">shell</replaceable></option></term>
 151                                 <listitem>
 152                                         <para>Use the specified shell (python or ipython) as
 153                         console backend instead of the default one (ipython
 154                         if present or python otherwise).</para>
 155                                         <para>Example: isympy -c python</para>
 156                                 </listitem>
 157                         </varlistentry>
 158                 </variablelist>
 159         </refsect1>
 160         <refsect1 id="files">
 161                 <title>FILES</title>
 162                 <variablelist>
 163                         <varlistentry>
 164                                 <term><filename>${HOME}/.sympy-history</filename></term>
 165                                 <listitem>
 166                                         <para>Saves the history of commands when using the python
 167                         shell as backend.</para>
 168                                 </listitem>
 169                         </varlistentry>
 170                 </variablelist>
 171         </refsect1>
 172
 173         <refsect1 id="bugs">
 174                 <!-- Or use this section to tell about upstream BTS. -->
 175                 <title>BUGS</title>
 176                 <para>The upstreams <acronym>BTS</acronym> can be found at <ulink
 177                 url="http://code.google.com/p/sympy/issues/list">http://code.google.com/p/sympy/issues/list</ulink>
 178         Please report all bugs that you find in there, this will help improve
 179         the overall quality of SymPy.</para>
 180         </refsect1>
 181         <refsect1 id="see_also">
 182                 <title>SEE ALSO</title>
 183                 <!-- In alpabetical order. -->
 184                 <para><citerefentry>
 185                                 <refentrytitle>ipython</refentrytitle>
 186                                 <manvolnum>1</manvolnum>
 187                         </citerefentry>, <citerefentry>
 188                                 <refentrytitle>python</refentrytitle>
 189                                 <manvolnum>1</manvolnum>
 190                         </citerefentry></para>
 191         </refsect1>
 192 </refentry>
 193