                                TiLP, version 4.72
				Copyright 1999-2001 by R. Lievin (roms)
				English documentation





Remark: This documentation is written for the Linux and the Windows 9x/Me & Windows NT4/2000/XP version. Specific topics due to the platform type are showed with [].


How to start ?
--------------

For the command line parameters, see the manpage (man TiLP) [Linux] or the Manpage.txt file [Win32].

Once the program launched, you have a menubar, a toolbar and three windows: the information window in the bottom, the local files window (PC files) to the right and the calculator files window to the left.
On the right window, you can make a little menu appear by right-clicking on a file.


The menubar:
------------

It contains all the functions of the program. A part of these functions are available in the toolbar. The others are more specific. Description of the different menus:

* File|Convert AMS to ROM image: use this function to convert a FLASH upgrade into a TOM image direcly ueable by an emulator. Remark: the converted ROM will not have a boot block (TI89/92+).
* File|Unzip: for unzipping archives. By default, archive is extracted in a directory such as '/archive_name/'.
* File|Untar: for untarring archives (only .tgz or .tar.gz).
* File|Unpack: converts a PAK (old TiLP file format, obsolete now) file into several files.
* File|Group File Manager: launch a mini-application you can use for viewing/grouping/ungrouping TI files.
* File|Save config: save the current configuration in a plain text file (~/.tilp [Linux] or tilp.ini [Win32]). The general options are saved (see below) as well as the hardware and calculator options. THe format of this file is described in the manpage [Linux] or in the 'Manpage.txt' file [Win32]. This file can be manually edited.
* File|Reload config: reloads the stored configuration.
* File|Default: configuration like the first run.
* File|Quit: no comments !!!


* Setup|General: this command give you a box in which you can configure several parameters such as:
	- the size of the left window,
	- the sort order for the two window, 
	- the path mode (full/local): the path mode shows whether a variable must be sended in the current folder (local path) of the calculator or in its folder of origin (full path), 
	- the confirmation whenever a file is destroyed, 
	- if you want diplay the hidden files (files beginning by a dot '.'),
	- the use of the extended group file format: it allows you keep the attribute of the archive (archived or locked variables) whenever you send a variable or a backup previously receveived with TiLP. Works only with TI89/92+. 
	- the file type checking. Used only when sending a TI File Format file. There are 3 possible values which are 'restrictive', 'middle' or 'none'. The 'none' value disables any file checking (dangerous, must be used carefully !). The 'restrictive' value allows you to transfer only a TIxx file type to a TIxx calculator. The 'middle' value allows you to transfer a TIxx file to some other calculators (a 82 file on a TI85 for instance but you can not send a 82 file on a TI92 !).
* Setup|Screen capture: you can choose the image format: XPM (UNIX) or PCX (RLE compressed). You have also the ability to choose whether you want a full screen or a clipped screen. Useful for a TI89 and ASM programming.
* Setup|Font: allows you to choose the font type used in the right window. Not implemented yet. For personnal display.
* Setup|Hardware&calc: you can choose:
	- the cable type to use: Grey TIGraphLink cable or AVRlink, home-made parallel link cable, home-made serial link cable or Black TIGraphLink cable, fastAVRlink, TIEmulator virtual link, VTi virtual link, TI/PC USB Link (TPUlink) or Blue TIGraphLink USB (not supported yet).
	- some options: Linux users can choose to use the 'tidev kernel module' or my 'tipar/tiser' kernel modules for handling home-made link cables (the only solution which avoid to be root for the moment).
	Windows users can use the DLPortIO driver for the homemade link cables. Remark: the DLPortIO driver is compulsory for the Windows NT4/2000 platform. Nethertheless, you can use it under Windows9x even.
	- the I/O port according to your previous choice of cable. If you have a serial port card with some strange addresses, you can also give directly the port address. For linux users, it is necessary (for the moment) to be root for using homemade link cables.
	- the calculator type. All calcs are supported excepted the TI73 for the moment. 

* Setup|Delay: you can adjust the delay value. Not used by the Grey TI Graph Link and the (fast)AVRlink. This value is the time which separates the transmission of two bits. It is not advisable to modify this value but it may be necessary in some cases. Decrease this value increases the speed transmission but decreases the reliablity. Used only for the parallel ans serial/BlackLink cables.
* Setup|Timeout: you can modify the time after an error occured.
* Setup|Link speed: for adjusting the baud rate of your fastAVRlink (the fastAVRlink must be accorded to this baud rate via the Avrlink Setup Utility).
* Setup|Probe I/O ports: this will display a dialog box. TiLP will try to automatically detect your parallel and serial devices. At end, it will display the list.
* Setup|Probe link type: implemented but not activated yet (mouse hang-up).
* Setup|Probe calc type: this function tries to detect your calculator type. This assumes that your cable is correctly plugged and you have chosen the right port.


* Function1|Ready: test if the calculator is ready.
* Function1|Terminal&Remote: places the calculator in remote control or terminal mode (for TI89/92/92+ only).
* Function|Screendump: make a screen capture of the calculator screen in the choosed image format.
* Function1|Directory list: make a directory listing.
* Function1|Send backup: restore the calculator content.
* Function1|Receive backup: get a backup of your calculator content. TI89/92+ users: variable attributes are stored that is to say an archived variable will still be archived when backup is restored.
* Function1|Send variable: send a variable to the calculator. One or more variables can be sended. 
* Function|Receive variable: receive a variable to the calculator. One or more variables can be received. If one variable is selected, it is saved in a single file.  If several variables are selected, they are saved in a single group file. To receive several variables in several files, they must be transmitted one by one. Or else, you should use the Ungroup command.


* Function2|Send FLASH: you can send either a freeFLASH application either an Operating System (AMS, Advanced Mathematic Software). TI89 only for the moment.
Before using this function, it is strongly recommended for Windows users to close all applications and to turn off the screen saver.
* Function2|Get ID: this function replys the ID-list of your calc. It works only with FLASHed TI89.
* Functions2|ROM dump: get a ROM image of the calculator. Works only on calculators equipped with FARGO. Should be extended to other calcs soon.
* Functions2|ROM version: displays the ROM version of the calc (TI92 only).
* Functions2|Install FARGO: not fully implemented yet.


* Plugins|Options: tell to TiLP whether you want plug-ins (TiFFEP) to be loaded at startup or not.
* Plugins|Load: load all plug-ins.
* Plugins|List: display a box with a list of all available plug-ins (TiFFEP query).
Plug-ins allows you to edit any variable from any calculator. Actually, only the 89/92/92+ have a plug-in support. If you are interested by programming a plug-in then mail me.
These plug-ins are managed via the TiFFEP (Ti File Format Engine & Proxy), a powerful but independant library.


* Misc|Register files: register the TI files (*.92g for instance and others) in the Windows registry and associate TiLP with them. So, if you double-click on one or more TI files in the Explorer, TiLP is opened and send the file(s).
* Misc|Unregister files: unregister the files. Not implemented yet, sorry!
* Misc|External programs: the dialog box contains the place where TiLP can find a program for unzipping/untarring an archive. By default, the options fields are empty and TiLP uses its own command line parameters. If you fill these fields, TiLP will use your own options. Use them carefully !
Linux users: the default cmd line is 'unzip -o -d archive archive.zip' and 'tar xvzf archive.tar.gz'.
Windows users: the default program used for both operations is the WinZip CommandLine Add-On utility (~230 Kb) that you can find at http://www.winzip.com. It should be installed in C:\Program Files\WinZip\. Default command line is 'C:\Program Files\WinZip\wzunzip.exe -o -d archive.zip'.


* Help|Help: displays this help.
* Help|Manpage: display the Linux manpage.
* Help|ChangeLog: display the Changelog file that is to say the file which content the latest modifications brought about TiLP.
* Help|Wizard: relaunch the Configuration Wizard.
* Help|Thanks: displays the list of persons who have contributed to the TiLP project.
* Help|About: my copyright and the license agreement.

Remark: with the Grey TI Graph Link or the (fast)AVRlink, the transfer status box may show 100% whereas the transfer is in progress. It is due to buffering.


The toolbar:
------------

The toolbar take back a part of the menubar functions, but there is most specific functions:

* Mkdir: make a new directory in the current directory. You must provide a name.
* Trash: useful to delete some unused files. Beware, once deleted, you can not retrieve it any longer.
* Update: refresh the local files directory list.
* Help: this help.


The information window:
-----------------------

This window give you some informations about the variables and files in the 2 upper windows.


The local files window (right window):
--------------------------------------

This window displays all the variables of the calculator as well as some useful informations.
A popup menu is available whenever you use the right button of the mouse.


The calculator files window (left window):
------------------------------------------

This window displays the current directory and all files which contains. You can change the current directory, the sort order and so on.


The right-button menu:
----------------------

It appears whenever you click on a file of the right window with the right button of your mouse.
It contains most of the command placed in menus and some additionnals items.

* Edit|Cut: cut a selected file
* Edit|Copy: copy a selected file
* Edit|Paste: paste the cutted/copied file
* Edit|Move to parent dir: move the selected file to the parent directory
* Edit|Select All: select all files in the window
* Edit|Unselect all: unselect all files in the window

* File|Unzip: unzip the selected file(s)
* File|Untar: untar the selected file(s), only .tgz/.tar.gz files. 
* File|GFM|Group: group selected files into an unique file
* File|GFM|Ungroup: ungroup the selected file
* File|GFM|Open: display the TI file structure
* File|View: try to launch an application capable to view or edit the selected file. TiLP use the TiFFEP (under development) for this so it must be running.
* File|Rename: rename the selected file(s)
* File|Properties: display a lot of informations about the selected TI file (requires the TiFFEP server for this).
* File|Update: refresh the right window
* File|Make new dir: create a new directory
* File|Delete file: delete the selected file(s)

* Calc|Insert shell: launch an applicatio capable to insert a shell in the calculator (unavailable yet, via TiFFEP)

* Plugins: development in progress through the TiFFEP mechanism

* Console: launch a shell (bash [Linux] or DOS [Win32]). Type 'quit' for exiting

* Change drive: change the current drive letter [Win32].


Particular use of TiLP depending on the link type
------------------------------------------------------

* For the TIEmulator virtual link, the emulator must be started BEFORE TiLP.

* For the VTi virtual link, VTi must be launched BEFORE any operation. Next, launch TiLP. If you quit TiLP, VTi must be closed before launching TiLP again.

* For the fastAVRlink, think to adjust the baudrate value according to the internal settings of the fastAVRlink (which can be modified with the Avrlink Setup Utility).

* For the TI-GRAPH LINK USB: Win32 & Linux drivers are experimentals.


Particular use of TiLP depending on the calculator type
------------------------------------------------------------

* For the TI89, TI92 and TI92+, TiLP works as described above. No remarks.

* For the TI83, TI86, there is no ready, no remote control functions.

* For the TI82/TI85, some functions do not exist: ready, directory list. Others work differently: send/receive backup and send/receive variables.
The computer does not initiate the transfer and so, it works in listen mode.
For 'receive backup': click the button, the PC waits. Then, on the calc, send the backup.
For 'send backup': put the calc in receive mode then click the button.
For 'receive vars': click the button, the PC waits. Then, on the calc, send the backup.
For 'send vars': put the calc in receive mode then click the button.

NB: I hope this documentation helpful and exhaustive. Feel free to mail me for any critics, suggestions ...
Remark: TiLP support internationalization. So, if you want translate this
documentation in another language then mail me.

Author: R. Lievin.

(c) Copyright 1999-2001, Romain Lievin
web: http://lpg.ticalc.org/prj_tilp
mail: rlievin@mail.com

					END
					---
