Steve Losh avatar Steve Losh committed 9c983cb

clojure-lanterna: Update site.

Comments (0)

Files changed (3)

clojure-lanterna/index.html

 
 <span class="p">(</span><span class="k">def </span><span class="nv">scr</span> <span class="p">(</span><span class="nf">s/get-screen</span><span class="p">))</span>
 
-<span class="p">(</span><span class="nf">s/stop</span> <span class="nv">screen</span><span class="p">)</span>
+<span class="p">(</span><span class="nf">s/stop</span> <span class="nv">scr</span><span class="p">)</span>
 
 <span class="p">(</span><span class="nf">s/put-string</span> <span class="nv">scr</span> <span class="mi">10</span> <span class="mi">10</span> <span class="s">&quot;Hello, world!&quot;</span><span class="p">)</span>
 <span class="p">(</span><span class="nf">s/put-string</span> <span class="nv">scr</span> <span class="mi">10</span> <span class="mi">11</span> <span class="s">&quot;Press any key to exit!&quot;</span><span class="p">)</span>
-<span class="p">(</span><span class="nf">s/get-key-blocking</span><span class="p">)</span>
+<span class="p">(</span><span class="nf">s/get-key-blocking</span> <span class="nv">scr</span><span class="p">)</span>
 
-<span class="p">(</span><span class="nf">s/stop</span> <span class="nv">screen</span><span class="p">)</span>
+<span class="p">(</span><span class="nf">s/stop</span> <span class="nv">scr</span><span class="p">)</span>
 </pre></div>
 
 

clojure-lanterna/installation/index.html

 versions, but I make no guarantees.</p>
 <p>It has no other dependencies (aside from Lanterna itself, of course).</p>
 <p>Add this to your <code>project.clj</code>:</p>
-<div class="codehilite"><pre><span class="p">[</span><span class="n">clojure</span><span class="o">-</span><span class="n">lanterna</span> "0<span class="p">.</span>9<span class="p">.</span>2"<span class="p">]</span>
+<div class="codehilite"><pre><span class="p">[</span><span class="n">clojure</span><span class="o">-</span><span class="n">lanterna</span> "0<span class="p">.</span>9<span class="p">.</span>3"<span class="p">]</span>
 </pre></div>
 
 

clojure-lanterna/reference/index.html

 <li><a href="#key-codes">Key Codes</a></li>
 <li><a href="#charsets">Charsets</a></li>
 <li><a href="#consoles">Consoles</a></li>
+<li><a href="#palettes">Palettes</a></li>
+<li><a href="#font-names">Font Names</a></li>
 </ul></li>
 <li><a href="#terminals">Terminals</a><ul><li><a href="#lanternaterminalget-terminal">lanterna.terminal/get-terminal</a></li>
 <li><a href="#lanternaterminalstart">lanterna.terminal/start</a></li>
 <li><a href="#lanternaterminalget-key">lanterna.terminal/get-key</a></li>
 <li><a href="#lanternaterminalget-key-blocking">lanterna.terminal/get-key-blocking</a></li>
 <li><a href="#lanternaterminaladd-resize-listener">lanterna.terminal/add-resize-listener</a></li>
+<li><a href="#lanternaterminalget-available-fonts">lanterna.terminal/get-available-fonts</a></li>
 </ul></li>
 <li><a href="#screens">Screens</a><ul><li><a href="#lanternascreenget-screen">lanterna.screen/get-screen</a></li>
 <li><a href="#lanternascreenstart">lanterna.screen/start</a></li>
   appropriate kind of console (UNIX or Cygwin) by the OS.</li>
 <li><code>:unix</code> - Force a UNIX text-based console.</li>
 <li><code>:cygwin</code> - Force a Cygwin text-based console.</li>
-</ul><h2 id="terminals">Terminals</h2>
+</ul><h3 id="palettes">Palettes</h3>
+<p>When creating a Swing Terminal or Screen, you can choose the color palette to
+use.  Text-based Terminals and Screens will use the user's color scheme, of
+course.</p>
+<p>The following palettes are supported:</p>
+<ul><li><code>:gnome</code> - Gnome Terminal's colors.</li>
+<li><code>:windows-xp</code> - The colors of the Windows XP command prompt.</li>
+<li><code>:xterm</code> - Xterm's colors.</li>
+<li><code>:putty</code> - Putty's colors.</li>
+<li><code>:mac-os-x</code> - The colors of Mac OS X's Terminal.app.</li>
+</ul><h3 id="font-names">Font Names</h3>
+<p>When giving a font name, it should be a string naming a font family on your
+system.  For example: <code>"Consolas"</code>, <code>"Courier New"</code>, or <code>"Monaco"</code>.</p>
+<p>To see a the fonts available on your system you can call
+<a href="#lanternaterminalget-available-fonts"><code>get-available-fonts</code></a>.</p>
+<h2 id="terminals">Terminals</h2>
 <p>The terminal layer is the lowest-level layer.  Read the <a href="../terminals/">terminal
 documentation</a> for an overview.</p>
 <h3 id="lanternaterminalget-terminal">lanterna.terminal/get-terminal</h3>
   constant</a> (default <code>:utf-8</code>).</li>
 <li><code>:resize-listener</code> - A function to call when the terminal is resized.  This
   function should take two parameters: the new number of columns, and the new
-  number of rows.</li>
-</ul><p>The <code>:rows</code>, <code>:cols</code>, and <code>:charset</code> options are really just a suggestion!</p>
-<p>The text-based terminals will ignore rows and columns and will be the size of
-the user's window.</p>
-<p>The Swing terminal will start out at this size but can be resized later by the
-user, and will ignore the charset entirely.</p>
+  number of rows.
+*</li>
+</ul><p>The <code>:rows</code>, <code>:cols</code>, <code>:font</code>, <code>:font-size</code>, <code>:palette</code> and <code>:charset</code> options
+are really just a suggestion!</p>
+<p>The text-based terminals will ignore rows, columns, fonts and palettes.  They
+will be determined by the user's terminal window.</p>
+<p>The Swing terminal will start out at the given size but can be resized later by
+the user, and will ignore the charset entirely.</p>
 <p>God only know what Cygwin will do.</p>
 <p>Your application needs to be flexible and handle sizes on the fly.</p>
 <h3 id="lanternaterminalstart">lanterna.terminal/start</h3>
 <p>You probably don't need this because you can specify a resize listener function
 when you call <a href="#lanternaterminalget-terminal"><code>get-terminal</code></a>.  It's here if you
 <em>do</em> need it though.</p>
+<h3 id="lanternaterminalget-available-fonts">lanterna.terminal/get-available-fonts</h3>
+<div class="codehilite"><pre><span class="p">(</span><span class="nf">get-available-fonts</span><span class="p">)</span>
+</pre></div>
+
+
+<p>Return a set of strings of the names of available fonts on the current system.</p>
 <h2 id="screens">Screens</h2>
 <p>The screen layer is an abstraction that provides buffering on top of the
 terminal layer.  Read the <a href="../screens/">screen documentation</a> for an overview.</p>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.