Title: ifm2i7

Convert map files generated by ifm (Interactive Fiction Mapper)
to Inform 7 source code.

--------------------------------------------------------------------

Section: Synopsis

ifm2i7 [OPTIONS] [INPUT [OUTPUT]]


--------------------------------------------------------------------

Section: Installation

    Please see the <INSTALL> file.


--------------------------------------------------------------------

Section: Description

    Use this program to convert maps created by ifm, ifmapper, or any
    other application capable of writing ifm format maps to Inform 7
    source code.

    As of version 1.1, ifm2i7 can use <ifm> map files to create
    Inform 7 source for rooms and regions, put the rooms in the
    appropriate regions, and link the rooms together.

--------------------------------------------------------------------

Section: Options

        Details below.
>
>       --help
>        -h
>               Display this usage information.
>
>       --input  <INPUT>
>        -i      <INPUT>
>               Path to a map file in ifm format (Optional)
>               Can be "-" for STDIN (Default)
>
>      --noexits
>       -n
>              Disable generation of Inform 7 code that puts
>              all the current room's exits up on the status line.
>
>
>       --output <OUTPUT>
>        -o      <OUTPUT>
>               File to write Inform 7 source code to.  (Optional)
>               Can be "-" for STDOUT (Default)
>
>       --verbosity=X
>        -v=X
>               Set the verbosity level to X.
>               Valid settings are:
>
>                  silent - (report almost no errors, and no warnings)
>                  quiet  - (report all errors, but no warnings)
>                  normal - (report all errors and warnings) (Default)
>                  debug  - (report everything and then some)
>
>       --version
>        -V
>               Print the version of this program and exit.
>       
>       input.ifm
>               Path to a map file in ifm format (Optional)
>               Can be "-" for STDIN (Default)
>       
>       output.ni
>               File to write Inform 7 source code to.  (Optional)
>               Can be "-" for STDOUT (Default)

NOTE  If you do not specify an input file, then ifm2i7 will
      look for its input on STDIN.  And if you do not specify an
      output file, ifm2i7 will send its output to STDOUT.


--------------------------------------------------------------------
    
Section: Bugs and Limitations

    Details below.

    - As of version 1.1, ifm2i7 will *not* generate Inform 7 source
      code for any items or tasks in the ifm file.

    - ifm2i7 treats all joins between two sections on an ifm map
      as two-way connections.

--------------------------------------------------------------------

Section: Todo

    Details below.

    items - There are plans to have ifm2i7 place items in rooms.

    tasks - There are *no* plans to have ifm2i7 do anything with
            ifm's tasks.

--------------------------------------------------------------------

Section: See Also

    Related applications.

    ifm - http://www.sentex.net/~dchapes/ifm
    ifmapper - Another mapping application, which can read and
               write ifm format files.
               http://ifmapper.rubyforge.org/start.html
    Inform 7 - http://www.inform-fiction.org/I7/Welcome.html

--------------------------------------------------------------------

Section: Author

    This program was written by Sergey Goldgaber -- Please see
    http://code.wetash.com for contact information.

--------------------------------------------------------------------

Section: License

    This program is licensed under the The Hacktivismo Enhanced-Source
    Software License Agreement (please see the <LICENSE> file
    for more details), with the additional provision that no part
    of this software may be used to wage or support war, or
    by the military or military contractors.

--------------------------------------------------------------------

Section: Acknowledgements
    
    The people who made this possible.

    Many thanks to:

        - Malarame on freenode's #ifdev for beta testing.
        - ifmud's #i7 community for troubleshooting.
        - Glenn Hutchings for ifm.
        - Gonzalo Garramuno for ifmapper.
        - Graham Nelson for Inform 7 and its documentation.
        - Emily Short for the example Inform 7 code.
        - Adam Thornton for the linux port of Inform 7 and devel tools
        - P. F. Chimento for the Gnome Inform 7 interface.
        - Many, many other Linux, perl, and vim developers.
