-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
134 lines (108 loc) · 4.66 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<title>Console Demo</title>
<style type="text/css">
h2, body > p
{
margin-left:24px;
}
ol
{
margin-left:9px;
}
.centered-text
{
text-align:center;
}
body
{
background:grey;
}
div
{
width: 48%;
height: 48%;
margin-left: 27%;
}
p,ul > li,.main-description
{
color:darkgrey;
}
</style>
<link rel="stylesheet" type="text/css" href="contrib/bootstrap/css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="contrib/bootstrap/css/bootstrap-theme.css">
<link rel="stylesheet" type="text/css" href="jqTerminal/jqTerminal.css">
<script type="text/javascript" src="contrib/jquery/jquery.min.js"></script>
<script type="text/javascript" src="contrib/bootstrap/js/bootstrap.min.js"></script>
<script type="text/javascript" src="jqTerminal/jqTerminal.js"></script>
<script type="text/javascript" src="jqTerminal/default.js"></script>
<script type="text/javascript">
$(function(){
var terminal = new Terminal("root@domain", "$","console-container");
terminal.initialize();
terminal.addCommandList(defaultCommands);
terminal.setEnvironmentVariable("COMMANDS", "man \n clear \n ls\n cat\n echo \n shutdown");
});
</script>
</head>
<body>
<h1 class="centered-text">JQTerminal</h1>
<h3 class="centered-text main-description">A Unix-like terminal, written in Javascript. </h3>
<h1 class="centered-text">Demo (Try It Out!)</h1>
<br/>
<div id="console-container"></div>
<h1 class="centered-text">Frequently Asqued Questions (F.A.Q)</h1>
<ol>
<li><h3><a href="#wat">Introduction</a></h3></li>
<li><h3><a href="#use">Can I use it on my page?</a></h3></li>
<li><h3><a href="#license">License</a></li>
<li><h3><a href="#make-commands">Making your own commands</a></h3></li>
<li><h3><a href="#commands-implemented">Default Commands</a></h3></li>
<li><h3><a href="#use-howto">How to use</a></h3></li>
<li><h3><a href="#interesting">Can I do anything interesting with it?</a></h3></li>
<li><h3><a href="#issues">Regarding Issues</a></h3></li>
</ol>
<h2 id="wat">1. Ok. So, what is it?</h2>
<p>
JQTerminal is an application that emulates a Unix terminal. It emulates as much as possible of the way a unix shell works. To that end it implements some
of the commands that you will find in a typicall Unix shell such as cat, man and echo (go to point 5 for a comprehensive list).
The commands already written are not hardcoded into the main logic and instead implemented in the form of plugins.
It is possible to write your own commands
</p>
<h2 id="use">2. Can I use it on my page?</h2>
<p>You can, as long as you respect the license.</p>
<h2 id="license">3. What license?</h2>
<p> As stated in the source files, JQTerminal is under the BSD-2-Clause License.
It's a fairly permissive license. It basically says you can do anything you want with the program provided you respect the following conditions:
</p>
<ul>
<li>You cannot claim that you wrote the software</li>
<li>You cannot sue the author of the software.</li>
<li>You cannot remove or modify the license.</li>
</ul>
<p>A copy of the license can be found in <a href="http://opensource.org/licenses/BSD-2-Clause" target="_blank">the OSI website</a>.</p>
<h2 id="make-commands">4. Can I make my own commands?</h2>
<p>You are wellcome to do so. JQTerminal was designed with the goal of being extensible in mind.</p>
<h2 id="commands-implemented">5. Which commands are already implemented?</h2>
<p>
<code>man - Find information about a specific command.</code><br/>
<code>clear - Clear the console.</code> <br/>
<code>ls - List directory contents.</code> <br/>
<code>cat - Concatenate files and print on the standard output.</code> (concatenation remains unimplemented) <br/>
<code>echo - Print messages on the standard output (supports environment variables).</code> <br/>
<code>shutdown / reboot - Destroy the console.</code><br />
<code>export - export an environment variable </code> <br/>
<code>color - change the terminal's background color </code>
</p>
<h2 id="use-howto">6. I just want to use it on my page. How do I do that?</h2>
<p>You might want to check out <a href="tutorial.html">the tutorial pages.</a></p>
<h2 id="interesting">7. Can I do anything interesting with it?</h2>
<p>That depends on your definition of interesting.
I made a page inspired on <a href="./docs/examples/ParkAdministration.html"> the iconic "hacking" scene of Jurassic Park</a> using this terminal.
You might find that amusing.
</p>
<h2 id="issues">8. I've spotted an issue. How do I report it?</h2>
<p>GitHub has a nice feature called "issues". You can use it to report any problem with the application. If it's really an issue, I'll start working on it as soon as I can.</p>
</body>
</html>