Introduction

Redax Enterprise Server is a command-line application. If you are used to the Microsoft Windows or Apple Mac OS X operating system, you may not be familiar with running command-line tools. This appendix shows you all you need to get started.

Note: You can refer to the Getting Started With Command Line Applications for additional information on using command-line applications.

Windows

To run Redax Enterprise Server in Windows, you need to open a Command Prompt window.

In Windows 7 & higher:

  • Click Start>Programs>Accessories>Command Prompt

The Command Prompt window opens.

Some basic commands

At the command prompt, you type each command, and press the Enter key to execute it. You can use the mouse to select text to copy or cut to the clipboard, but you cannot position the cursor with it. The command line is completely keyboard driven. Navigation keys are shown below:

Key Action
Backspace Delete previous character
right arrow Move right one character
left arrow Move left one character
up arrow Recall previous command
Tab File or directory name autocomplete (Win XP only)
Enter Execute command

In addition to running programs, you have many commands to navigate and maintain the system. Two important ones are cd and dir.

Changing directories

Use the cd command to change directories. For example, to change to the directory that Redax Enterprise Server is located in, type:

cd “\Appligent\RedaxServer\”

The command prompt changes to:

C:\Appligent\RedaxServer>

to show you where you are. Note the quotation marks. They are only necessary if you have spaces in your path or file  names. We use them here for illustration.

To move back one subdirectory level, use the shortcut of two periods (..)

C:\Appligent\RedaxServer>cd ..

Don’t forget to press the Enter key after every command. You will now be in this directory:

C:\Appligent>

Move back to RedaxServer:

C:\Appligent>cd RedaxServer

Listing the contents of a directory

Use the dir command to list the contents of a directory:

C:\Appligent\RedaxServer>dir

The computer responds with a listing of all the contents of the RedaxServer directory. If the directory contents fly by too fast to read, do this:

C:\Appligent\RedaxServer>dir /p

The /p switch tells DOS to display one page at a time. Press the Enter key to see the next page. To see the contents of all the subdirectories at the same time, type:

C:\Appligent\RedaxServer>dir /s

This displays the contents of RedaxServer and all the subdirectories under it.

Running Redax Enterprise Server

To run Redax Enterprise Server, type the commands on the command line as shown in other sections of this manual and press Enter. In the next example, we’ve truncated the command prompt path for clarity. A simple command would be:

C:\path\>redaxserver -redact -o \files\output.pdf  Samples\input.pdf

This processes the sample file and replaces it. Note we provide the relative path to the input and output files so that Redax Enterprise Server knows where to find them. The safest way to specify files is to use the full path:

C:\path\>redaxserver -redact -o c:\Appligent\RedaxServer\files\output.pdf c:\Appligent\RedaxServer\Samples\input.pdf

Type (or copy and paste) the entire command on one line, even though we had to break it up to fit on this page. If you do not specify the correct path, you will get a “file not found” error.

Now, refer to the rest of this User Guide for details about using Redax Enterprise Server.

Mac OS X

To run Redax Enterprise Server on the Macintosh, you need to open a terminal window. In the Applications folder:

  1. Open the Utilities folder.
  2. Double-click the Terminal application

The Terminal window opens.

Some basic commands

At the command prompt, you type each command, and press the Return key to execute it. You can use the mouse to select text to copy or cut to the clipboard, but you cannot position the cursor with it. The command line is completely keyboard driven. Navigation keys are shown below:

Key Action
Backspace Delete previous character
right arrow Move right one character
left arrow Move left one character
up arrow Recall previous command
Tab File or directory name autocomplete
Return Execute command

In addition to running programs, you have many commands to navigate and maintain the system. Two important ones are cd and ls.

Changing directories

Use the cd command to change directories. For example, to change to the directory that Redax Enterprise Server is located in, type:

[yourcomputer:~]user% cd /Applications/Appligent/RedaxServer

The command prompt changes to:

[yourcomputer:Applications/Appligent/RedaxServer]user%

to show you where you are. yourcomputer is the name of your computer, and user is your user name.

To move back one level, use the shortcut of two periods:

[yourcomputer:Applications/Appligent/RedaxServer]user% cd ..

Don’t forget to press the Return key after every command. You will now be in this directory:

[yourcomputer:Applications/Appligent]user%

Move back to RedaxServer:

[yourcomputer:Applications/Appligent]user% cd RedaxServer

Listing the contents of a directory

Use the ls command to list the contents of a directory.

[yourcomputer:Applications/Appligent/RedaxServer]user% ls

The computer responds with a listing of all the contents of the RedaxServer directory.

To see the contents of all the subdirectories at the same time, type:

[yourcomputer:Applications/Appligent/RedaxServer]user% ls -R

The -R switch displays the contents of RedaxServer and all the subdirectories under it. Note that these switches are case sensitive. You must use a capital ‘R.’

Running Redax Enterprise Server

To run Redax Enterprise Server, type the commands on the command line as shown in other sections of this manual and press Return. In the next example, we’ve truncated the command prompt path for clarity. A simple command would be:

[/path/]user% ./redaxserver -redact -o ./files/output.pdf  ./Samples/input.pdf

This processes the sample file and replaces it. Note we provide the relative path to the input and output files so that Redax Enterprise Server knows where to find them. The safest way to specify files is to use the full path:

[/path/]user% ./redaxserver -redact -o /Applications/Appligent/RedaxServer/files/output.pdf /Applications/Appligent/RedaxServer/Samples/input.pdf

The ./ tells the computer that the RedaxServer command is in the current directory. Type the entire command on one line, even though we had to break it up to fit on this page. If you do not specify the correct path, you will get a “file not found” error.

Now, refer to the rest of this User Guide for details about using Redax Enterprise Server.