From 95d2a3806a39bb31c9cca38c2c6158ecb77818e9 Mon Sep 17 00:00:00 2001 From: spiralman Date: Mon, 27 May 2002 00:58:49 +0000 Subject: added help for opie-sh --- (limited to 'help') diff --git a/help/opie-sh/index.html b/help/opie-sh/index.html new file mode 100644 index 0000000..19ed36b --- a/dev/null +++ b/help/opie-sh/index.html @@ -0,0 +1,117 @@ + + + + + +Opie-sh Howto + + + + + + + + + + + + + + + + + +next +up +previous + +contents +
+ Next: Contents +   Contents +
+
+ +

Opie-sh Howto

+

Thomas F. Stephens

+

+
+ + + + + +
+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/labels.pl b/help/opie-sh/labels.pl new file mode 100644 index 0000000..1b6b109 --- a/dev/null +++ b/help/opie-sh/labels.pl @@ -0,0 +1,13 @@ +# LaTeX2HTML 2002-1 (1.68) +# Associate labels original text with physical files. + + +1; + + +# LaTeX2HTML 2002-1 (1.68) +# labels from external_latex_labels array. + + +1; + diff --git a/help/opie-sh/node1.html b/help/opie-sh/node1.html new file mode 100644 index 0000000..974a180 --- a/dev/null +++ b/help/opie-sh/node1.html @@ -0,0 +1,102 @@ + + + + + +Contents + + + + + + + + + + + + + + + + + + + + +next + +up + +previous +
+ Next: Introduction + Up: Opie-sh Howto + Previous: Opie-sh Howto +
+
+ +
+ +

+Contents +

+ + + + +
+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node10.html b/help/opie-sh/node10.html new file mode 100644 index 0000000..d21827e --- a/dev/null +++ b/help/opie-sh/node10.html @@ -0,0 +1,80 @@ + + + + + +Fileviewer + + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: Usage + Up: Opie-sh Howto + Previous: Icons +   Contents +
+
+ + +

+Fileviewer +

+This is probably the simplest of the dialogs, it uses the ``-f'' flag. It is designed to dispaly a large amount of output, or output that does not require a user response. It can handle HTML, plain text, and QML (which is basically HTML). + +

+

+ +Subsections + + + +
+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node11.html b/help/opie-sh/node11.html new file mode 100644 index 0000000..81475d0 --- a/dev/null +++ b/help/opie-sh/node11.html @@ -0,0 +1,77 @@ + + + + + +Usage + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: Input Dialog + Up: Fileviewer + Previous: Fileviewer +   Contents +
+
+ + +

+Usage +

+There are only two flags for the fileviewer. The first is ``-f'', which is used to both make opie-sh use the filbrowser, and to specify a file to show. If there is no file specified, opie-sh takes the file from the standard input. This allows you to do command | opie-sh -f to see the output of command in the file viewer. Opie-sh reads in the file until it sees an end of file character, and then displays the text, so its probably best not to display the output from a cat of /dev/ttySA0. You can send an eof by typing Ctr-d on the keyboard. The other option that the file viewer takes is the ``-t'' flag, which sets the title, just like for the other dialogs. If you do not specify the title, it defaults to the name of the file (which is null for stdin). Both of these examples have the same output: + +

+

+opie-sh -f filename -t "Title"
+
+cat filename | opie-sh -f -t "Title"
+
+ +

+

+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node12.html b/help/opie-sh/node12.html new file mode 100644 index 0000000..de47dd7 --- a/dev/null +++ b/help/opie-sh/node12.html @@ -0,0 +1,93 @@ + + + + + +Input Dialog + + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: Global Options + Up: Opie-sh Howto + Previous: Usage +   Contents +
+
+ + +

+Input Dialog +

+The input dialog ``-i'' is designed for getting more specific input from the user. It works by printing a string to stdin. The number of strings depends upon which type of input dialog you are using, of which there are three. If the user selects the built in ``Ok'' button on the dialog, the return code is 0, and if they select the built in ``x'', then it is -1, and no output is given. + +

+

+ +Subsections + + + +
+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node13.html b/help/opie-sh/node13.html new file mode 100644 index 0000000..348082a --- a/dev/null +++ b/help/opie-sh/node13.html @@ -0,0 +1,76 @@ + + + + + +Global Options + + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: Single line input + Up: Input Dialog + Previous: Input Dialog +   Contents +
+
+ + +

+Global Options +

+There are three options that are global to all input dialogs. They behave very much the same way that they do for the other dialogs that have them. The ``-g'' flag disables fullscreen, the same way that it does for the message dialog. Fullscreen is also implemented the same way that it is in the message dialog. The ``-L'' option takes a string, and uses that as a label for the input field. The ``-t'' option behaves the same way as it does with all the other dialogs, by setting the title of the dialog (and the fullscreen window, if you run it without the -g). Here is an example of all three: + +

+

+opie-sh -i -L "Label: " -t "Title" -g
+
+ +

+

+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node14.html b/help/opie-sh/node14.html new file mode 100644 index 0000000..5855981 --- a/dev/null +++ b/help/opie-sh/node14.html @@ -0,0 +1,71 @@ + + + + + +Single line input + + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: List input + Up: Input Dialog + Previous: Global Options +   Contents +
+
+ + +

+Single line input +

+The single line input is the simplest of all the input dialogs, and is started with the ``-s'' flag. It simply offers the user a box to enter a single line of text, and when they click ok, it outputs it to the console. It has no other flags than the global ones. This is also the default type of input for an input dialog, if none is selected. + +

+

+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node15.html b/help/opie-sh/node15.html new file mode 100644 index 0000000..85eb019 --- a/dev/null +++ b/help/opie-sh/node15.html @@ -0,0 +1,82 @@ + + + + + +List input + + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: Special flags + Up: Input Dialog + Previous: Single line input +   Contents +
+
+ + +

+List input +

+This input dialog lets the user choose one string from a pulldown list of strings, and is started with the ``-l'' flag. The string is output to the console. + +

+

+ +Subsections + + + +
+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node16.html b/help/opie-sh/node16.html new file mode 100644 index 0000000..0ed728c --- a/dev/null +++ b/help/opie-sh/node16.html @@ -0,0 +1,71 @@ + + + + + +Special flags + + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: File input + Up: List input + Previous: List input +   Contents +
+
+ + +

+Special flags +

+The list input has several flags that change its behavior. The first, and most important is the ``-F'' flag, which is how it gets its list of strings to offer to the user. This will be explained in its own section. The other flag that it excepts is ``-E'', which allows the user to enter a string other than one that is in the list. If run this way, it behaves much like a combination of the normal list input, and the single line input combined. + +

+

+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node17.html b/help/opie-sh/node17.html new file mode 100644 index 0000000..141b07f --- a/dev/null +++ b/help/opie-sh/node17.html @@ -0,0 +1,85 @@ + + + + + +File input + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: List box input + Up: List input + Previous: Special flags +   Contents +
+
+ + +

+File input +

+The list input dialog requires that you give it a file input, with the ``-F'' flag. If you do not specify a file, it will use standard input (note: if you specify ``-F'' without a filename, which isnt necessary, it must be the last argument. This will be fixed shortly). The format of this file is one entry per line, blank lines should be ignored. Using stdin is just like using stdin for the file viewer. + +

+Example input file: +

+item1
+item2
+item3
+item4
+
+ +

+Example command line: +

+opie-sh -i -l -L "Label" -t "Title" -F filename
+
+ +

+

+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node18.html b/help/opie-sh/node18.html new file mode 100644 index 0000000..62f44f6 --- a/dev/null +++ b/help/opie-sh/node18.html @@ -0,0 +1,68 @@ + + + + + +List box input + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: About this document ... + Up: Input Dialog + Previous: File input +   Contents +
+
+ + +

+List box input +

+This input dialog is designed to let the user select more than one option from a list of options, and it is started with the ``-b'' flag. It is run almost exactly the same way as the list input, except for two differences. First, the ``-E'' option does not work, so the user can only select from the list that you supply. Second, since it allows the user to select more than one option, its output can be a little different. If the user selects only one entry, the behavior is the same, but if the user selects more than one, each string that they selected is output to the console, one per line. +
+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node19.html b/help/opie-sh/node19.html new file mode 100644 index 0000000..d41595e --- a/dev/null +++ b/help/opie-sh/node19.html @@ -0,0 +1,79 @@ + + + + + +About this document ... + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Up: Opie-sh Howto + Previous: List box input +   Contents +
+
+ + +

+About this document ... +

+ Opie-sh Howto

+This document was generated using the +LaTeX2HTML translator Version 2002-1 (1.68) +

+Copyright © 1993, 1994, 1995, 1996, +Nikos Drakos, +Computer Based Learning Unit, University of Leeds. +
+Copyright © 1997, 1998, 1999, +Ross Moore, +Mathematics Department, Macquarie University, Sydney. +

+The command line arguments were:
+ latex2html opie-sh-howto.tex +

+The translation was initiated by on 2002-05-15 +

+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node2.html b/help/opie-sh/node2.html new file mode 100644 index 0000000..cd0df8a --- a/dev/null +++ b/help/opie-sh/node2.html @@ -0,0 +1,79 @@ + + + + + +Introduction + + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: What it is for + Up: Opie-sh Howto + Previous: Contents +   Contents +
+
+ + +

+Introduction +

+
+ +Subsections + + + +
+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node3.html b/help/opie-sh/node3.html new file mode 100644 index 0000000..8d16696 --- a/dev/null +++ b/help/opie-sh/node3.html @@ -0,0 +1,71 @@ + + + + + +What it is for + + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: What it can do + Up: Introduction + Previous: Introduction +   Contents +
+
+ + +

+What it is for +

+Opie-sh is designed to be a frontend to Opie that can be used from the console. This is especially usefull for creating interactive shell scripts, as it will use the Opie interface (which is presumably familiar to the user) instead of a text based interface (which can be confusing). It can also be convinient for prototyping an app that you want to write for Opie without actually bothering to break out the cross compiler. Opie-sh does not use an Opie specific libs, so you can just as easily use it with Qtopia. + +

+

+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node4.html b/help/opie-sh/node4.html new file mode 100644 index 0000000..0621292 --- a/dev/null +++ b/help/opie-sh/node4.html @@ -0,0 +1,70 @@ + + + + + +What it can do + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: Message Dialog + Up: Introduction + Previous: What it is for +   Contents +
+
+ + +

+What it can do +

+There are two main goals of Opie-sh: getting information from the user, and giving information to the user. These functions are implemented through three dialog types. A file dialog, an input dialog, and a message dialog. + +

+

+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node5.html b/help/opie-sh/node5.html new file mode 100644 index 0000000..c17af08 --- a/dev/null +++ b/help/opie-sh/node5.html @@ -0,0 +1,87 @@ + + + + + +Message Dialog + + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: Usage + Up: Opie-sh Howto + Previous: What it can do +   Contents +
+
+ + +

+Message Dialog +

+The message dialog can be used to both provide information and get information at the same time. However, the quality and quantity of this information is more limited than it is in the other two dialogs. + +

+

+ +Subsections + + + +
+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node6.html b/help/opie-sh/node6.html new file mode 100644 index 0000000..475c96c --- a/dev/null +++ b/help/opie-sh/node6.html @@ -0,0 +1,83 @@ + + + + + +Usage + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: General + Up: Message Dialog + Previous: Message Dialog +   Contents +
+
+ + +

+Usage +

+A message box works by opening a window with an icon, a message, and up to three buttons. You can tell what button the user pressed by checking the return code of opie-sh. To make opie-sh display a message box, you can use the flag ``-m''. So, opie-sh -m will display a message box with an information icon and an ``Ok'' button. + +

+

+ +Subsections + + + +
+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node7.html b/help/opie-sh/node7.html new file mode 100644 index 0000000..4495907 --- a/dev/null +++ b/help/opie-sh/node7.html @@ -0,0 +1,124 @@ + + + + + +General + + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: Buttons + Up: Usage + Previous: Usage +   Contents +
+
+ + +

+General +

+These flags modify what the message box looks like in general. + +

+The message is what tells the user what is going on, or asks them a question, it is specified with the ``-M'' flag, and there is no default. The message text can be formated with html tags, or as plain text. It is the most important part of the message dialog, so dont forget it. Examples: + +

+

+opie-sh -m -M "Here is a simple message"
+
+opie-sh -m -M "Here is a <br>multiline message"
+
+ +

+The title is what is displayed in the dialog box's title bar, and is specified with the ``-t'' flag. It can be a shortened version of the message, or the name of the program, and should only be a word or two. For example: ``Warning'' or ``Example App''. Example: + +

+

+opie-sh -m -t "Title"
+
+ +

+The ``-g'' flag is used to disable the ``fullscreen'' feature. It can be used if you dont want the dialog to cover up what else is running (for instance, if you are running the script from another, regular opie application), or if you are running the app with its own background (see the tips section). Without it, the dialog will have another fullscreen window drawn underneath it, with the same title as the dialog. Example: + +

+

+opie-sh -m -g
+
+ +

+

+ + +next + +up + +previous + +contents +
+ Next: Buttons + Up: Usage + Previous: Usage +   Contents + +
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node8.html b/help/opie-sh/node8.html new file mode 100644 index 0000000..9264660 --- a/dev/null +++ b/help/opie-sh/node8.html @@ -0,0 +1,76 @@ + + + + + +Buttons + + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: Icons + Up: Usage + Previous: General +   Contents +
+
+ + +

+Buttons +

+You can specify up to three buttons to appear on the bottom of the dialog. If you do not specify any buttons, there will be a single ``Ok'' button for the user to press. To specify the text of a button, use ``-n'', where n is the number of the button whose text you want to specify, starting with 0, and ending at 2. If you do not specify the text of a button, it will not be displayed. The number of the button the user presses is the return code of the program (if the user presses either of the built-in buttons on the top of the dialog, you will get a return code of -1). For example, the following will display a message box with two buttons, ``Ok'' and ``Cancel''. If the user presses ``Ok'', the return code is 0, if they press ``Cancel'', it is 1: + +

+

+opie-sh -m -0 "Ok" -1 "Cancel"
+
+ +

+

+
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/node9.html b/help/opie-sh/node9.html new file mode 100644 index 0000000..b047cf9 --- a/dev/null +++ b/help/opie-sh/node9.html @@ -0,0 +1,121 @@ + + + + + +Icons + + + + + + + + + + + + + + + + + + + +next + +up + +previous + +contents +
+ Next: Fileviewer + Up: Usage + Previous: Buttons +   Contents +
+
+ + +

+Icons +

+There are three icons that you can display with a message box: information, warning, and error. These are designed to help inform the user what type of message you are giving them. + +

+An information icon is specified with the ``-I'' flag, and should be used for outputing non-critical information to the user, or asking them a simple question. It is also the default icon, and will be used if you do not specify another one. Example: + +

+

+opie-sh -m -I
+
+ +

+A warning icon is specified with the ``-w'' flag, and should be used for problems that the user should know about, but that will not necessarily cause the program to stop working. For example, if the program cannot find a configureation file, you might pop up a warning, notifying the user that the default configuration will be used. This is also usefull for asking the user if they want to continue doing something that might damage the system (editing rc scripts, for instance). Example: + +

+

+opie-sh -m -w
+
+ +

+An error icon is specified with the ``-e'' flag, and should be used for problems that will cause the program to stop running, or otherwise do the wrong thing. It should be used sparingly, as it signifies that something is seriously wrong. Example: + +

+

+opie-sh -m -e
+
+ +

+

+ + +next + +up + +previous + +contents +
+ Next: Fileviewer + Up: Usage + Previous: Buttons +   Contents + +
+ +2002-05-15 +
+ + diff --git a/help/opie-sh/opie-sh-howto.css b/help/opie-sh/opie-sh-howto.css new file mode 100644 index 0000000..d1824af --- a/dev/null +++ b/help/opie-sh/opie-sh-howto.css @@ -0,0 +1,30 @@ +/* Century Schoolbook font is very similar to Computer Modern Math: cmmi */ +.MATH { font-family: "Century Schoolbook", serif; } +.MATH I { font-family: "Century Schoolbook", serif; font-style: italic } +.BOLDMATH { font-family: "Century Schoolbook", serif; font-weight: bold } + +/* implement both fixed-size and relative sizes */ +SMALL.XTINY { font-size : xx-small } +SMALL.TINY { font-size : x-small } +SMALL.SCRIPTSIZE { font-size : smaller } +SMALL.FOOTNOTESIZE { font-size : small } +SMALL.SMALL { } +BIG.LARGE { } +BIG.XLARGE { font-size : large } +BIG.XXLARGE { font-size : x-large } +BIG.HUGE { font-size : larger } +BIG.XHUGE { font-size : xx-large } + +/* heading styles */ +H1 { } +H2 { } +H3 { } +H4 { } +H5 { } + +/* mathematics styles */ +DIV.displaymath { } /* math displays */ +TD.eqno { } /* equation-number cells */ + + +/* document-specific styles come next */ diff --git a/help/opie-sh/opie-sh-howto.html b/help/opie-sh/opie-sh-howto.html new file mode 100644 index 0000000..19ed36b --- a/dev/null +++ b/help/opie-sh/opie-sh-howto.html @@ -0,0 +1,117 @@ + + + + + +Opie-sh Howto + + + + + + + + + + + + + + + + + +next +up +previous + +contents +
+ Next: Contents +   Contents +
+
+ +

Opie-sh Howto

+

Thomas F. Stephens

+

+
+ + + + + +
+
+ +2002-05-15 +
+ + -- cgit v0.9.0.2