Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

DEPRECATED: Mirror of Win32::Console Gem project with improved MinGW support

branch: master
README.txt
= Win32::Console

* http://rubyforge.org/projects/winconsole
* http://github.com/luislavena/win32console
* http://rdoc.info/projects/luislavena/win32console

== DEPRECATION NOTICE

Win32::Console has been deprecated in favor of an external tool named ANSICON:

* https://github.com/adoxa/ansicon
* http://blog.mmediasys.com/2010/11/24/we-all-love-colors/

This project is left here for history purposes but no further development will be done.

== DESCRIPTION

Win32::Console allows controling the windows command line terminal
thru an OO-interface. This allows you to query the terminal (find
its size, characters, attributes, etc). The interface and functionality
should be identical to Perl's counterpart.

A port of Perl's Win32::Console and Win32::Console::ANSI modules.

This gem packages Gonzalo Garramuno's Win32::Console project, and includes
a compiled binary for speed. The Win32::Console project's home can be
found at:

  http://rubyforge.org/projects/win32console

== FEATURES

Win32::Console::ANSI is a class derived from IO that seamlessly
translates ANSI Esc control character codes into Windows' command.exe
or cmd.exe equivalents.

To ease usage, you can use in combination with term-ansicolor gem and avoid
writing ANSI codes manually.

== EXAMPLES

To output a simple bolded string, try this script:

  require 'rubygems'
  require 'win32console'
  include Win32::Console::ANSI
  include Term::ANSIColor

  puts bold << "bolded text" << clear << " and no longer bold."

== INSTALL

To install from rubygems, simple run:

  gem install win32console

To install from source, make sure you have the Ruby development kit from
RubyInstaller on your Windows host, install the following gems:

  * rake
  * hoe
  * rake-compiler

Then run the following:

  rake gem
  gem install pkg\win32console-1.3.0.gem

== DEVELOPERS:

After checking out the source, run:

  $ rake newb

This task will install any missing dependencies, run the tests/specs,
and generate the RDoc.

== LICENSE

This program is FREE; you can redistribute, modify, disassemble, or even
reverse engineer this software at your will. Keep in mind, however, that
NOTHING IS GUARANTEED to work and everything you do is AT YOUR OWN RISK - I
will not take responsibility for any damage, loss of money and/or health
that may arise from the use of this program!

This is distributed under the terms of Larry Wall's Artistic License.
Something went wrong with that request. Please try again.