comment -*- mode: text -*-

How to build & install libvte compatible library using mlterm engine.

* Requirements
  o vte library and headers
  o gtk+ 2.x
  o terminal emulators using libvte (gnome-terminal, roxterm or etc)

* Build
  $ ./configure (--with-type-engine=xcore,xft ...)
    (Xft is not required, but strongly recommended because it is impossible
     to change font settings from preferences menu without xft.)
  $ make
  $ cd gtk ; make

* Install (Replace official libvte)
  $ cd kiklib ; make install
  $ cd mkf ; make install
  $ cd gtk ; make install
  $ ln -sf [where libvte of mlterm is installed]/libvte.so.9.0.0 \
	   [where official libvte is installed]/libvte.so.9

* Start terminal emulators using libvte
  $ gnome-terminal (roxterm or etc)
  => mlterm inside gnome-terminal is started.

* Notice
  o Because it is mlterm that works inside gnome-terminal or etc,
    - Configuration files in ~/.mlterm/ are applied. (*)
    - Configuration protocol (like '$ mlcc [key] [value]') is mostly available.
    - Pressing Ctrl+Button3 shows 'mlconfig' menu.

    (*) Following configurations are invalidated by gnome-terminal or etc in startup.
       - 'DEFAULT' settings in ~/.mlterm/(v)(aa)font
       - 'bel_mode', 'fg_color', 'bg_color', 'cursor_bg_color', 'wall_picture',
         'use_transbg', 'alpha' and 'encoding' options in ~/.mlterm/main

  o Default value of following options are not same as that of normal mlterm.
    [Option]       [Default Value]                            (Normal mlterm)
    type_engine => xft (if compiled with --enable-anti-alias) (xcore)
  
  o Following functions which normal mlterm provides are not available.
    - Daemon mode
    - Multiple ptys using Ctrl+F1 / Ctrl+F2 / Ctrl+F3
    - Vertical writing mode
    - screen_width_ratio and screen_height_ratio options

  o If libvte compatible mlterm dies in compiz environment,
    try XLIB_SKIP_ARGB_VISUAL variable as follows.
    $ XLIB_SKIP_ARGB_VISUAL=1 gnome-terminal
  
  o Unsupported vte api functions
    - vte_terminal_feed
    - vte_terminal_feed_child
    - vte_terminal_feed_child_binary
    - vte_terminal_copy_primary
    - vte_terminal_paste_primary
    - vte_terminal_set_scroll_background
    - vte_terminal_set_scroll_on_output
    - vte_terminal_set_scroll_on_keystroke
    - vte_terminal_set_color_dim
    - vte_terminal_set_color_bold
    - vte_terminal_set_color_highlight
    - vte_terminal_set_colors (inocmplete)
    - vte_terminal_set_default_colors
    - vte_terminal_set_background_tint_color
    - vte_terminal_set_color_blink_mode
    - vte_terminal_set_cursor_shape
    - vte_terminal_set_scrollback_lines
    - vte_terminal_im_append_menuitems
    - vte_terminal_get_font
    - vte_terminal_set_allow_bold
    - vte_terminal_get_allow_bold
    - vte_terminal_is_word_char
    - vte_terminal_set_mouse_autohide
    - vte_terminal_get_mouse_autohide
    - vte_terminal_get_text
    - vte_terminal_get_text_include_trailing_spaces
    - vte_terminal_get_text_range
    - vte_terminal_match_clear_all
    - vte_terminal_match_add_gregex (incomplete)
    - vte_terminal_match_set_cursor
    - vte_terminal_match_set_cursor_type
    - vte_terminal_match_set_cursor_name
    - vte_terminal_match_remove
    - vte_terminal_match_check (incomplete)
    - vte_terminal_set_emulation
    - vte_terminal_get_status_line
    - vte_terminal_set_pty
    - vte_terminal_get_child_exit_status
    - vte_terminal_set_cursor_blinks
    - vte_terminal_match_add
    - vte_terminal_set_alternate_screen_scroll

  o Unsupported vte signals and properties
    - signals
      "eof"
      "commit"
      "emulation-changed"
      "selection-changed"
      "contents-changed"
      "cursor-moved"
      "deiconify-window"
      "iconify-window"
      "raise-window"
      "lower-window"
      "refresh-window"
      "restore-window"
      "maximize-window"
      "resize-window"
      "move-window"
      "status-line-changed"
      "increase-font-size"
      "decrease-font-size"
      "text-modified"
      "text-inserted"
      "text-deleted"
      "text-scrolled"
      "copy-clipboard"
      "paste-clipboard"

    - class property
      "allow-bold"
      "audible-bell"
      "background-image-file"
      "background-image-pixbuf"
      "background-opacity"
      "background-saturation"
      "background-tint-color"
      "background-transparent"
      "backspace-binding"
      "cursor-blink-mode"
      "cursor-shape"
      "delete-binding"
      "emulation"
      "encoding"
      "font-desc"
      "pointer-autohide"
      "pty"
      "scroll-background"
      "scrollback-lines"
      "scroll-on-keystroke"
      "scroll-on-output"
      "word-chars"
      "visible-bell"

    - style property
      "inner-border"
