Rune - Revision history

Markm: /* Setting up rune */

Markm — Thu, 15 Mar 2007 22:52:55 GMT

Setting up rune

New page

Rune is the interactive command line interpreter for E code.

== Setting up rune ==

'''Windows:''' Copy the file <code>rune-bat-template.txt</code> to <code>rune.bat</code> and edit the settings in the file.

''Hint:'' If you plan on using rune a lot, you should try [http://sourceforge.net/projects/console Console], a Windows console window enhancement

'''unix/linux/mac/cygwin:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.
Add execute rights to the file by entering <code>chmod a+x rune</code>.

You should now be able to execute rune and get an interactive shell.

As an alternative, rune can be started using the java executable:
<code>$ java -jar e.jar --rune</code>

== Running an E script from rune ==

There are several ways to start an E script using rune.

=== Calling the "rune" script explicitly ===

Given that the "rune" script is on your PATH, you can give the name of the .e script as a command line argument to rune:

<code>$ rune [options...] example.e [args...]</code>

The additional args after <code>example.e</code> are available from within <code>example.e</code> as the value of the expression

<code>interp.getArgs()</code>

For more information on the options, do

<code>$ rune --help</code>

=== Calling the "rune" shell script implicitly ===

On the unix/linux/mac/cygwin platforms, you can place <code>#!/usr/bin/env rune</code> on the first line of example.e, make example.e executable, and use it directly as a command:

<code>$ example.e [args...]</code>

On cygwin, text files beginning with a "#!" are automatically considered executable.

=== Calling the "rune" function from within a running E system ===

You can start the script directly from the E command prompt, which can save some time because the running Java VM is used:

<code>? rune(["example.e"])</code>

=== Launching from the desktop ===

Currently on Windows only, you can double click on the shortcut icon for <code>example.e</code> in the file explorer (desktop).

== Command history ==
The interactive E interpreter does not provide command history. Under windows, the shell has its own command history, which can be used by pressing the up and down arrow keys.
If your system does not provide command history, you can try [http://freshmeat.net/projects/rlwrap/ rlwrap].

Markm: /* Running an E script from rune */

Markm — Thu, 15 Mar 2007 22:52:00 GMT

Running an E script from rune

←Older revision		Revision as of 22:52, 15 March 2007
Line 19:		Line 19:
	== Running an E script from rune ==		== Running an E script from rune ==

-	There are ~~two~~ ways to start an E script using rune.	+	There are several ways to start an E script using rune.
-	~~First, you can give the name of the script as a command line argument:~~	+

-	~~<code>./~~rune ~~example.e</code>~~	+	=== Calling the "rune" script explicitly ===

-	~~Second~~, you can ~~start~~ the script ~~directly from the E~~ command ~~prompt, which can save some time because the running Java VM is used~~:	+	Given that the "rune" script is on your PATH, you can give the name of the .e script as a command line argument to rune:

-	<code>? rune(["example.e"])</code>	+	<code>$ rune [options...] example.e [args...]</code>
		+
		+	The additional args after <code>example.e</code> are available from within <code>example.e</code> as the value of the expression
		+
		+	<code>interp.getArgs()</code>
		+
		+	For more information on the options, do
		+
		+	<code>$ rune --help</code>
		+
		+	=== Calling the "rune" shell script implicitly ===
		+
		+	On the unix/linux/mac/cygwin platforms, you can place <code>#!/usr/bin/env rune</code> on the first line of example.e, make example.e executable, and use it directly as a command:
		+
		+	<code>$ example.e [args...]</code>
		+
		+	On cygwin, text files beginning with a "#!" are automatically considered executable.
		+
		+	=== Calling the "rune" function from within a running E system ===
		+
		+	You can start the script directly from the E command prompt, which can save some time because the running Java VM is used:
		+
		+	<code>? rune(["example.e"])</code>
		+
		+	=== Launching from the desktop ===
		+
		+	Currently on Windows only, you can double click on the shortcut icon for <code>example.e</code> in the file explorer (desktop).

	== Command history ==		== Command history ==
	The interactive E interpreter does not provide command history. Under windows, the shell has its own command history, which can be used by pressing the up and down arrow keys.		The interactive E interpreter does not provide command history. Under windows, the shell has its own command history, which can be used by pressing the up and down arrow keys.
	If your system does not provide command history, you can try [http://freshmeat.net/projects/rlwrap/ rlwrap].		If your system does not provide command history, you can try [http://freshmeat.net/projects/rlwrap/ rlwrap].

Markm: /* Setting up rune */

Markm — Thu, 15 Mar 2007 22:29:07 GMT

Setting up rune

←Older revision		Revision as of 22:29, 15 March 2007
Line 7:		Line 7:
	''Hint:'' If you plan on using rune a lot, you should try [http://sourceforge.net/projects/console Console], a Windows console window enhancement		''Hint:'' If you plan on using rune a lot, you should try [http://sourceforge.net/projects/console Console], a Windows console window enhancement

-	'''unix/linux/mac:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.	+	'''unix/linux/mac/cygwin:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.
	Add execute rights to the file by entering <code>chmod a+x rune</code>.		Add execute rights to the file by entering <code>chmod a+x rune</code>.

Mscheffler: /* Setting up rune */

Mscheffler — Thu, 15 Mar 2007 14:33:21 GMT

Setting up rune

←Older revision		Revision as of 14:33, 15 March 2007
Line 5:		Line 5:
	'''Windows:''' Copy the file <code>rune-bat-template.txt</code> to <code>rune.bat</code> and edit the settings in the file.		'''Windows:''' Copy the file <code>rune-bat-template.txt</code> to <code>rune.bat</code> and edit the settings in the file.

-	''~~Tip~~:'' If you plan on using rune a lot, you should try [http://sourceforge.net/projects/console Console], a Windows console window enhancement	+	''Hint:'' If you plan on using rune a lot, you should try [http://sourceforge.net/projects/console Console], a Windows console window enhancement

	'''unix/linux/mac:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.		'''unix/linux/mac:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.

Mscheffler: /* Setting up rune */

Mscheffler — Thu, 15 Mar 2007 14:32:55 GMT

Setting up rune

←Older revision		Revision as of 14:32, 15 March 2007
Line 5:		Line 5:
	'''Windows:''' Copy the file <code>rune-bat-template.txt</code> to <code>rune.bat</code> and edit the settings in the file.		'''Windows:''' Copy the file <code>rune-bat-template.txt</code> to <code>rune.bat</code> and edit the settings in the file.

-	''Tip:'' If you plan on using rune a lot, you ~~may consider using~~ [http://sourceforge.net/projects/console Console], ~~which is~~ a Windows console window enhancement	+	''Tip:'' If you plan on using rune a lot, you should try [http://sourceforge.net/projects/console Console], a Windows console window enhancement

	'''unix/linux/mac:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.		'''unix/linux/mac:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.

Mscheffler: /* Setting up rune */

Mscheffler — Thu, 15 Mar 2007 14:32:05 GMT

Setting up rune

←Older revision		Revision as of 14:32, 15 March 2007
Line 4:		Line 4:

	'''Windows:''' Copy the file <code>rune-bat-template.txt</code> to <code>rune.bat</code> and edit the settings in the file.		'''Windows:''' Copy the file <code>rune-bat-template.txt</code> to <code>rune.bat</code> and edit the settings in the file.
-	'''Tip:''' If you plan on using rune a lot, you may consider using [http://sourceforge.net/projects/console Console], which is a Windows console window enhancement	+
		+	''Tip:'' If you plan on using rune a lot, you may consider using [http://sourceforge.net/projects/console Console], which is a Windows console window enhancement

	'''unix/linux/mac:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.		'''unix/linux/mac:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.

Mscheffler: /* Setting up rune */

Mscheffler — Thu, 15 Mar 2007 14:31:28 GMT

Setting up rune

←Older revision		Revision as of 14:31, 15 March 2007
Line 4:		Line 4:

	'''Windows:''' Copy the file <code>rune-bat-template.txt</code> to <code>rune.bat</code> and edit the settings in the file.		'''Windows:''' Copy the file <code>rune-bat-template.txt</code> to <code>rune.bat</code> and edit the settings in the file.
		+	'''Tip:''' If you plan on using rune a lot, you may consider using [http://sourceforge.net/projects/console Console], which is a Windows console window enhancement

	'''unix/linux/mac:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.		'''unix/linux/mac:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.

Kevin Reid: rlwrap, Java capitalization

Kevin Reid — Thu, 15 Mar 2007 14:26:23 GMT

rlwrap, Java capitalization

←Older revision		Revision as of 14:26, 15 March 2007
Line 22:		Line 22:
	<code>./rune example.e</code>		<code>./rune example.e</code>

-	Second, you can start the script directly from the E command prompt, which can save some time because the running ~~java~~ VM is used:	+	Second, you can start the script directly from the E command prompt, which can save some time because the running Java VM is used:

	<code>? rune(["example.e"])</code>		<code>? rune(["example.e"])</code>
Line 28:		Line 28:
	== Command history ==		== Command history ==
	The interactive E interpreter does not provide command history. Under windows, the shell has its own command history, which can be used by pressing the up and down arrow keys.		The interactive E interpreter does not provide command history. Under windows, the shell has its own command history, which can be used by pressing the up and down arrow keys.
-	If your system does not provide command history, you can try [http://freshmeat.net/projects/rlwrap/ ~~RLWrap~~].	+	If your system does not provide command history, you can try [http://freshmeat.net/projects/rlwrap/ rlwrap].

Mscheffler: /* Running an E script from rune */

Mscheffler — Thu, 15 Mar 2007 14:22:50 GMT

Running an E script from rune

←Older revision		Revision as of 14:22, 15 March 2007
Line 17:		Line 17:
	== Running an E script from rune ==		== Running an E script from rune ==

-	There are two ways to start an E script using rune:	+	There are two ways to start an E script using rune.
-	First, you can give the name of the script as a command line argument.	+	First, you can give the name of the script as a command line argument:
		+
	<code>./rune example.e</code>		<code>./rune example.e</code>

-	~~The second way is to~~ start the script from the E command prompt:	+	Second, you can start the script directly from the E command prompt, which can save some time because the running java VM is used:
		+
	<code>? rune(["example.e"])</code>		<code>? rune(["example.e"])</code>
-	~~The second method can be faster if you want to start a script more than once, for example for testing. The java virtual machine is only started once, which can save some seconds.~~

	== Command history ==		== Command history ==
	The interactive E interpreter does not provide command history. Under windows, the shell has its own command history, which can be used by pressing the up and down arrow keys.		The interactive E interpreter does not provide command history. Under windows, the shell has its own command history, which can be used by pressing the up and down arrow keys.
	If your system does not provide command history, you can try [http://freshmeat.net/projects/rlwrap/ RLWrap].		If your system does not provide command history, you can try [http://freshmeat.net/projects/rlwrap/ RLWrap].

Mscheffler: /* Setting up rune */

Mscheffler — Thu, 15 Mar 2007 14:20:30 GMT

Setting up rune

←Older revision		Revision as of 14:20, 15 March 2007
Line 6:		Line 6:

	'''unix/linux/mac:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.		'''unix/linux/mac:''' Copy <code>rune-template.txt</code> to <code>rune</code> and edit it.
-	Add execute rights to the file by ~~executing the shell command~~ <code>chmod a+x rune</code>.	+	Add execute rights to the file by entering <code>chmod a+x rune</code>.

	You should now be able to execute rune and get an interactive shell.		You should now be able to execute rune and get an interactive shell.