@database show.guide @node Main "Show.guide" Show (c) A. Renard 1998, 1999. ============================== @{" What is it? " link "Introduction"} @{" Installation " link "Installation"} @{" Invocation " link "Invocation"} @{" Usage " link "Usage"} @{" XPK " link "XPK"} @{" Preferences " link "Preferences"} @{" Special Keys " link "Special keys"} @{" SendShowPort " link "SendShowPort"} @{" Notes " link "Notes"} @{" History " link "History"} @{" Author " link "Author"} @endnode @node "Introduction" What is it? =========== Show is a picture viewer for CyberGraphics systems. It can decode the next picture formats: Show040: -------- Reading : IFF,JPEG,PNG,GIF,BMP,PBM,PPM,PNM,PCX,XPM,TARGA,TIFF Writing : IFF,JPEG,PNG,GIF,BMP,PCX and RAW ShowPPC: -------- Reading : IFF,JPEG,PNG,GIF,BMP,PBM,PPM,PNM,PCX,XPM Writing : IFF,JPEG,PNG,GIF,BMP,PCX and RAW It open on a CyberGraphics screen (16/24bits) only. @endnode @node "Installation" Installation ============ Installation is very simple: Decompact the archive, say in ram disk. Once the archive decompacted, a) Goto the 'libs' directory and copy the libraries to 'LIBS:' b) If you want the catalog files, goto the 'locale' directory and copy the 'catalogs/#?' files to 'LOCALE:catalogs/". c) Goto the 'c' directory and copy the files in one of your path directories (for example 'C:'). That's all! @endnode @node "Invocation" Invocation ========== Show can be started from a shell or from Workbench. @{" Invocation from a shell " link "Shell invocation"} @{" Invocation from Workbench " link "Workbench invocation"} When starting, Show will by default put an Appicon on Workbench. The name of this Appicon will be 'Show.n' where 'n' is the 'port number'. In fact, you can invoque several times Show ; for each invocation, an unique port is created with a unique name: 'ShowPort.n'. The Appicon name reflect this. When invoked from Workbench or if no file name is given in the command line, Show stay put in memory, waiting for a command. You have several possibilities to send a command to Show: - Double-clicking the Appicon will bring up a load file-requester. - Dragging and dropping a picture icon on the Appicon will load or add the picture. - Using the command @{"SendShowPort" link "SendShowPort"}. However, since several people seem not like much the AppIcon method, there is still a possibility to disable this method. See @{"Shell invocation" link "Shell invocation"}. @endnode @node "Shell invocation" Invocation from a shell ======================= When you start Show from a shell, the arguments are: FILES, PREFSFILE=PF/K, MODEID=ID/K/N, PUBSCREEN=PS/K, WINDOWMODE=WM/S, LOOP=LP/S, NOERROR=NE/S, GETMODEID=GM/S, PROGRESS=PG/S, CRYPT=CR/S, PRESERVE=PR/S, OVERWARN=OW/S, CLICK=CL/S, MODIFYREQ=MR/S,BUFFREQ=BR/S, AUTOSIZE=AS/S, CENTERWIN=CW/S, LIST=LI/K, JPGQUAL=JQ/K/N, JPGGRAY=JG/S, JPGSIZE=JS/K/N, SLIDE=SL/S, SECONDS=SC/K/N, NOAPPICON/S FILES: - a mixture of filenames, patterns and directories: Example of pattern : RAM:T/#?30#?.tiff Example of directory : RAM:T (equivalent to RAM:T/#?). PREFSFILE=PF/K: - alternative prefs file to load at startup (default is ENV:Show.prefs). MODEID=ID/K/N: The screen mode (in decimal) if you want to open Show on a custom screen. PUBSCREEN=PS/K Open Show on public screen name given. If the screen is not found or is not of required type, Show open on the default public screen. WINDOWMODE=WM/S: Mode window, e.g. non-backdrop. Only for custom screens. On public screens, the mode is always windowmode! LOOP=LP/S: If you want endless loop in viewing. NOERROR=NE/S: If you do not want the errors being reported. GETMODEID=GM/S: Force the screenmode requester to appear before the program starts. PROGRESS=PG/S: Open the progress window when loading a picture. CRYPT=CR/S: Save files in crypted form. PRESERVE=PR/S: Preserve files dates. OVERWARN=OW/S: Open a confirmation requester when you attempt to overwrite a file. CLICK=CL/S: Click with the mouse in the main window load the next picture. MODIFYREQ=MR/S: Display a confirmation requester when you are about to lose the picture and the picture has been modified. BUFFREQ=BR/S: The file requesters are bufferized, i.e. the directories are not re-read each time the requester appear. AUTOSIZE=AS/S: The picture window is resized to the picture size (window-mode). CENTERWIN=CW/S: The picture window is centered in the screen (window-mode). LIST=LI/K: Take precedence over the FILES argument. When present, Show will read the list file given instead of reading images directly. The list file is made of lines of text, each of which is a path name. Example: Show ...(blahblah)... LIST RAM:mylist and the content of the file RAM:mylist is: WORK:pics/png/john.png WORK:pics/tif/blue_parrot.tif DATAS:mypics/eros/Regina.jpg ... JPGQUAL=JQ/K/N: JPEG save quality (default=80). JPGGRAY=JG/S: Load JPEG in grayscale. JPGSIZE=JS/K/N: JPEG picture sizing when loading (0=auto, 1=full, 2=1/2, 4=1/4, 8=1/8; default=1). SLIDE=SL/S: Mode slideshow. Each image is displayed n seconds before the next is loaded. The slideshow mode can be aborted (menu item). When an image is changed, the slide is paused. To resume it, save the image or go to another image. SECONDS=SC/K/N: You can decide how much time each image is displayed in slideshow mode. Changing the delay is possible (menu item). NOAPPICON/S: If set, Show behaves like in versions pre 2.3, that is: - No AppIcon is put on default public screen. - Where Show normally hide the display and wait for a command, the program simply exit instead. These options take precedence over the preferences saved. Of course, some of these options are mutually exclusive! So be logical... You can also invoque Show simply by typing 'Show' and a AppIcon will appear on the default public screen (see @{"Usage" link "Usage"}). @endnode @node "Workbench invocation" Invocation from Workbench: ========================== The tooltypes are the same than when starting from a shell except there are no 'LIST' or 'PATTERN'. You can use the shortcuts. IMPORTANT NOTE: --------------- For some of you who are using Opus Magellan, Toolmanager and the like: Don't set the open mode to 'Workbench' in the docks or buttons banks if you want to start Show with the prefs saved in the preferences window. Instead, set the mode to 'Shell'. That's because in 'Workbench' mode, you will obtain the preferences setting in the Workbench icon (tooltypes). @endnode @node "SendShowPort" SendShowPort ============ This command replace the old 'ShowZombie'. The syntax is very similar: FILES/K,ADD/K,LIST/K,PORT/K/N,QUIT/S,QUIET/S FILES/K: Send a LOAD command to Show. Give it the filenames/directories to load with or without pattern. ADD/K: Send an ADD command to Show. Give it the filenames/directories to add with or without pattern. LIST/K: Send a LIST command to Show. Give it the name of the list-file to load. PORT/K/N: To send commands only to the ShowPort specified. If no PORT argument is present, the commands are sent to the first port found. QUIT/S: Send a QUIT command to Show. QUIET/S: Do not report errors. SendShowPort has the 'p' bit set, which means you can make it resident: RESIDENT :/SendShowPort @endnode @node "Usage" Usage: ====== AppIcon and AppWindow --------------------- For each Show session, an Appicon is put on the default public screen (see @{"Invocation" link "Invocation"}). To load a picture, double-click or drop an icon on the Appicon. Now the main window open, displaying the picture. This window is an Appwindow, meaning that you can also drop an icon directly in this window for loading or adding a picture. Key shortcuts ------------- From now on, you can customize your keyboard shortcuts: click on the 'Preference/Key shortcuts/Redefine mode' menu item. A requester appear to help you to remember the way it work. Define your prefered shortcuts, then press the 'Help' key to open the preference window (see @{"Preferences" link "Preferences"}). Press 'Save'. Zooming ------- Now you can zoom in and out of the picture by different means: - Double-clicking in the window zoom in ; double-clicking while pressing a SHIFT key zoom out. - Selecting the corresponding menu-item. Scrolling --------- If the picture displayed is bigger than the window, you can scroll the picture by: - Pressing the cursors keys. The default step is 16 pixels wide. By pressing a qualifier key simultaneously with a cursor key, the scroll step will be different: - ALT : 1 pixel step. - SHIFT : 32 pixels step. - ALT+SHIFT : 64 pixels step. - CTRL : maximal scroll. - Clicking inside the window and moving the mouse. This is the Opaque Move. Release the left mouse button and the scrolling stop. Moving the window ----------------- If the prefs item 'Keyboard MoveWindow' is set, you can move the picture window by pressing the CTRL+ALT+cursor keys. Formatting the window title --------------------------- You can format yourself the infos displayed in the picture window title. Here are the format codes and there significations: - %N : Current picture number. - %T : Total number of pictures. - %n : Name of the file. - %w : Real width. - %h : Real height. - %d : Real depth. - %W : Display width. - %H : Display height. - %D : Display depth. - %s : File size in bytes. - %f : File format ('IFF', 'GIF', ... ). - %c : File comment. - %% : The character '%'. - %< : a '<' in case of being in watching mode, a space otherwise. - %m : a 'M' if the picture is memorized, a 'C' if memorized for composition, a space otherwise. Composing --------- Compose allow you to...compose several images in a big one. To achieve that, you have to 'memorize' the images first. So say you want to compose image1.jpg, image2.jpg, image3.jpg and image4.jpg: - a) load the images (!) - b) while each image is displayed, memorize it (menu 'Image/Memory/Memorize Image for composition') - c) compose (menu 'Image/Memory/Compose Memorized Images') Here you can choose the layout and the space between images. Press 'OK' to save it. Note: Pressing HELP in the main window help to remember some keyboard shortcuts while composing or cropping. The rest is, IMHO, straightforward. @endnode @node "Preferences" Preferences =========== @{" Screen " link "Preferences - Screen"} @{" Window " link "Preferences - Window"} @{" File Formats " link "Preferences - File Formats"} @{" Paths " link "Preferences - Paths"} @{" Evenments " link "Preferences - Evenments"} @{" Miscellaneous " link "Preferences - Miscellaneous"} The preferences are, by default, loaded from the file 'ENV:Show.prefs' and saved to the file 'ENVARC:Show.prefs', but you can load from and save in alternate files. The keys shortcuts are also saved in these files. In addition, each time the program exits, the positions of the windows opened in the program are saved in the file 'ENVARC:Show.win', included the position and size of the main window. So if the prefs items 'Automatic resizing' or 'Center window on screen' are not set, the size and/or the position of the main window remains the same next time Show is invoqued. @endnode @node "Preferences - Miscellaneous" Miscellaneous: -------------- Loop: If set, when you are viewing the last picture of the list and go to next picture, the first of the list is loaded and the cycle continue. Load progress window: If set, display a progress of the loading. Report errors: If set, display a requester each time an error occurs. Preserve files dates: If set, the datestamp of files being overwritten is left untouched. Overwrite warning: If set, display a requester asking you if you want overwrite the file or not. Click to next: If set, a mouse click in the picture window loads the next file. If not set, you have the opaque move facility, which allow you to move freely in the picture (in case the displayed picture is bigger than the window), and the double-click in the window which zoom in (or out with SHIFT key) the picture. Confirmation when image modified: If set, when you are going to lose the picture (for example by loading another one) and the picture was modified, a requester ask you a confirmation. Bufferized file requester: If set, the reqtools file requesters are bufferized, i.e. the directory is not re-read each time you open the requester. Save Windows Positions: If set, the different windows positions are saved upon exit in ENVARC:Show.win. Crypting: If you want to crypt your pictures. The pictures are crypted by the FEAL algorythm. A default password is set when the program start, but if you want to crypt with your own password, you can! @endnode @node "Preferences - Evenments" Evenments: ---------- Drop method: When you drop a picture file on the AppIcon or in the AppWindow, the picture is loaded (and the list is cleared first), added to the list or added and loaded. Open window: If set, when you drop files and the picture window is closed, the window is opened. Screen to front: If set, the screen on wich Show reside is put to the front. Watchdir method: Related to the menu item 'Watch dir'. Each time a file (or several files) is (are) detected in the directory, either the first file is loaded and the other added to the list (in this case the previous list is lost), either all the files are added to the list (in this case the previous list is preserved) or the files are added and the last file is loaded. Open window: If set, when a file is detected and the picture window is closed, the window is opened. Screen to front: If set, the screen on wich Show reside is put to the front. Watch delay: Delay in seconds between the detection and the action taken. @endnode @node "Preferences - Paths" Paths: ------ Here you decide the various default paths. I think it's self-explanatory :) @endnode @node "Preferences - Screen" Screen ------ Here you can choose the type of display for Show, either a custom screen or a public screen. Remember than only Cybergraphics screens with a depth of 16 or more are legals, so if no legal public screen is present, only the custom screen choices are present. You can also choose your prefered fonts for the requesters (fixed fonts only) and for the screen (custom screens only). @endnode @node "Preferences - Window" Window ------ Here you can set some prefs relating to the window-mode: Automatic resizing: If set, each time a picture is loaded, the picture window is resized appropriately to the picture size. Center window on screen: If set, each time a picture is loaded, the picture window is centered on the screen. Background: If set, you can choose a color for the window's background. If not set, the color will be black. Keyboard MoveWindow: If set, you can move the picture window by pressing simultaneously CTRL+ALT+. Window size method: Resizing the window do: - Nothing: Nothing special; the picture is simply re-centered in the window. - Zoom: Depending of the new size, the picture is zoomed appropriately. - Resize: The picture is resized. Warning: the resize method obviously modifies the picture! Lock aspect: Only pertinent if the window size method is set to 'Resize'. If set, the sizing respect the aspect ratio of the picture. Resizing from: You can decide the origin from which the resizing of the window is done, e.g. from one of the 4 corners or from the center. @endnode @node "Preferences - File Formats" File Formats ------------ Here are the preferences for the loading/saving of the pictures types. @endnode @node "XPK" XPK files ========= Files compacted/crypted with XPK are OK. You can even crypt your images from within the program. @endnode @node "Special keys" Special keys: ============= ESCAPE: hide (or quit if mode NOAPPICON). SHIFT+ESC: quit without request (except if the picture was modified). SPACE: go to next image. RETURN: go to next image (only if 2 or more images in mem). BACKSPACE: go to previous image. HELP: change miscellaneous preferences window or open a help request in compose and crop modes. DELETE: display current image infos. CURSORS: move (scroll) in the image or move the picture window. F1: increment (SHIFT=decrement) red by 5. F2: increment (SHIFT=decrement) green by 5. F3: increment (SHIFT=decrement) blue by 5. F6: increment (SHIFT=decrement) brightness by 5. F7: increment (SHIFT=decrement) contrast by 5. F8: increment (SHIFT=decrement) gamma by 5. @endnode @node "Notes" Notes: ====== - This program is totally FREE. :) - I'm NOT a programmer, so please forgive me if you find bugs! Anyway, your comments are always welcome; PLEASE email me if you have bugs reports, comments, encouragements, etc... - Translators are welcome!!! I **NEED** volunteers to translate Show. If you feel courageous enough, please contact me or send me directly a .ct file... @endnode @node "History" History ======= V2.11 - New: Loading/saving gauge window now works - at last! - :/ - Added some buttons in the 'Color Balance' window. V2.10 - New: Autocrop. - New: 'Change Comment' function. - New: 'Reset Zoom between Pictures' preference item. - New: Path & Evenments preference menus. - New: new codes for the window title formatting (see @{"Usage" link "Usage"}). - It seems that Show was not interacting well with MagicMenus. This is fixed - but the useless Amigakey image is back in the menus :( - Some other bugs fixed, as usual. V2.9 - Some bugs fixed. V2.8 - New picture formats: XPM and PPM,PBM,PNM (for ppc version). - New: Window's background color choice. - New: Slideshow delay in seconds and tenths. - New: Copy and Move menu items. - New: Sorting of the picture list. - Plus a few bugs fixed. V2.7 - New prefs_file format; use prefs4_prefs5 to convert your prefs_file. - New: Convolve Load/Save/Erase. - New: Saving of GIF pictures. - New: Loading/Saving of PCX pictures. - New: You can now save pictures in less than 24 bits (IFF,BMP,GIF,PCX) - Requires render.library. - New: Window prefs: you can now format yourself the window title (see @{"Usage" link "Usage"}). V2.6 - Extended keyboard selection - lower/uppercase are now treated differently. - New functions: 'Canvas Size' & 'Convolve'. - New misc. prefs: 'Save Windows Positions' toggle. - New window prefs: 'Resize From'. - Fixed some bugs. V2.5 - Preferences splitted in different windows. - Added window resize origin in prefs. - Some internals changes. V2.4 - Better handling of I/O errors. - The preferences now save the publicscreen name Show was opened on. - New command line arguments and tooltypes (see @{"Shell invocation" link "Shell invocation"}). - New prefsfile format (due to the items above). Use prefs3_prefs4 command to convert your prefsfiles. - Now you can also add files by drops methods and with SendShowPort. - MoveWindow by keyboard. - Closing the display will not lose pictures anymore (reopen by double-clicking the AppIcon). - AppIcon can be disabled (by requests). - Some others minor changes and bug fixes. V2.3 - Opaque move. - AppIcon and AppWindow. - The Zoom value is preserved between pictures. - New menuitems for managing main window in window mode. - Zoom in window by double-clicking. - Several scrolling steps are now possible. - ShowZombie replaced by SendShowPort. Zombie mode is now useless. V2.2 - Added IFF loading for Extra-Halfbrite,HAM, HAM8 and masked pictures. - Some PNG pictures were not displayed properly; fixed. - Added screen centering of the main window in window mode. - Added some infos in window title bar in window mode. - Added prefs option: zoom on resize. - New ShowZombie syntax. It can now load a listfile. V2.1 - just fixed some bugs. V2.0 - At last!! :/ Workbench/PublicScreens version (16/24 bits of course...). - You can now choose your prefered fonts in preferences. - ixemul.library is not needed anymore. - Corrected bad handling of file names on command line in certain situations (thanks to Andre Reichl). - Selection of a mixture of dirs/files in one shot in requester. - Bufferization of dir content in requester. - Loading/adding/saving of list files from within program. - Adding/removing files. - Modification of protections bits. - Watch directory. Watch for new files and display it automatically. - New sizing facilities. - Remember load path, lists path and watchdir path. - New prefs version. Use the command prefs2_prefs3 to convert. V1.18 - ShowZombie is now pure (you can make it resident). - Change : ESCAPE key now quit the program. - New Filetypes : IFF, GIF(PPC) and BMP(PPC) - Request user if image was modified. - Remember last save path. V1.17 - Alternative prefs files (loading/saving). - Mixture of filenames, dirs and patterns on command line. This means you can now select several files in a Opus lister, for example, and display them in one go. (suggestion from D.J. Nick) - Special keys to increment/decrement colors,brightness,contrast and gamma directly. See 'Special keys'. (suggestion from Franck Delhomme!) - PPC version: realtime effects adjustments. - Windows positions are now saved automatically before quitting. (suggestion from Andre Reichl) - You can now memorise images without they appear in the compose list. (suggestion from Andre Reichl) - New prefs file format. To convert your old prefsfile, use the command old2newprefs included!. V1.16 - PPC version. The JPG (load/save), PNG (load/save) and the effects are compiled for PPC for now. The modules 'ShowEffects.elf', 'ShowPng.elf' and 'ShowJpeg.elf' must reside in the same directory as ShowPPC. - ShowZombie bug fixed. Now you can pass a relative file-path; the path will be passed to Show in an absolute form (e.g. 'pics/mypic.jpg' --> 'DH0:data/misc/pics/mypic.jpg'). V1.15 - Mode slideshow - Mode Zombie - Some bugs fixes V1.14 - Show can now be started from WB. - Preferences grouped into a window. - While browsing the memorized pictures in the 'Goto memorized' window, you now see the images directly. V1.13 - Added the LIST/K argument in the command line. V1.12 - The grayscale images are now loaded/saved as grayscale in TIFF format - Added Gamma for PNG loading - More prefs are saved now V1.11 - Load and save TIFF images. - Now you can resize the picture freely. - New menu item: Gamma correction. - ATTENTION : ixemul.library is now needed! - ATTENTION : new prefs file format...sorry! :( @endnode @node "Author" Author ====== My name: Alain Renard. My email: al.renard@infoboard.be @endnode