Documentation

The documentation below was written for version 1.1 of the File Canner application. For older versions of the software, the System Requirements, Installation and Basic Mode sections still apply. The remaining sections apply only to version 1.1.

System Requirements

File Canner can be installed and run on any computer that has Java Platform version 5 or later installed.

Installation

If you have downloaded the jar version of the software, simply move the file to a permanent location on your hard drive. No additional setup is needed. If you downloaded the zip version of the software, extract the files to a folder on your hard drive.

Running the Program

Once the software has been installed, it can be run very easily. If you installed the jar version, simply double click the jar file to run the program. If you installed the zip version, from your command prompt, run jar path/filecanner.class, where path is the relative path to the folder where you saved the class files.

Modes Overview

FileCanner has several modes for creating archive files. Below are instructions for each archive mode, taken from the Instructions page of the program. The basic mode for creating simple JAR type archives is the Basic Mode. To include subfolders, use Advanced Mode. To create a simple Zip file, use the Zip Mode.

Basic Mode

File Management

Files can be added to the JAR file by clicking Add File and selecting the file to be added. Files can be removed by highlighting the file and clicking Remove Selected.

Manifest Options

Manifest files are used to tell the JVM that is running the JAR file information about the file. An existing manifest can be specified by clicking Set Manifest File and selecting the file. If you want to have JavaCanner create a manifest file for you, you can set the main class and other available options.

Building the Jar File

When all the options have been selected, and you are ready to create the JAR file, click Create JAR, and select the destination for the file.

Advanced Mode

File Management

Files can be added to the JAR file by clicking Add File and selecting the file to be added. Files can be removed by highlighting the file and clicking Remove Selected.

Manifest Options

Manifest files are used to tell the JVM that is running the JAR file information about the file. An existing manifest can be specified by clicking Set Manifest File and selecting the file. If you want to have JavaCanner create a manifest file for you, you can set the main class and the root folder. The root folder is used to calculate the structure of subfolders. Files added that are not in subfolders will be put into the main folder in the archive.

Building the Jar File

When all the options have been selected, and you are ready to create the JAR file, click Create JAR, and select the destination for the file.

Zip Mode

File Management

Files can be added to the Zip file by clicking Add File and selecting the file to be added. Files can be removed by highlighting the file and clicking Remove Selected.

Manifest Options

The folder structure of the zip file you are creating is set to mirror the directory structure on the PC. Any file being added that is not in the root folder or one of it's subfolders will be placed in the root folder.

Building the Zip File

When all the options have been selected, and you are ready to create the ZIP file, click Create JAR, and select the destination for the file.