scanwizard(1) scanwizard(1)
NAME
scanwizard - Creates customized transition impact reports
SYNOPSIS
scanwizard [config_file]
OPTIONS
config_file
Absolute or relative path name to a file containing the options to be
used when creating the transition impact report. List the options, one
per line, in the configuration file.
DESCRIPTION
The scanwizard utility is a command-line interactive utility for generating
reports on the possible transition impacts in source files when transition-
ing applications and scripts. The transition may be from another operating
system to HP-UX, from an earlier version of HP-UX to a later version of
HP-UX, or from the Solaris operating system to Linux. For information on
the available Software Transition Kits, check the URL
http://www.hp.com/go/STK.
The source files that can be scanned by scanwizard include shell scripts,
Makefiles, and programs written in C, C++, Fortran, and COBOL. A transi-
tion impact is identified when a source file contains commands, functions,
structures, header files, or other keywords that do not have the same
behavior or the same name on the destination and the source platform which
you are transitioning from. A transition impact statement describes the
differences in behavior and identifies possible solutions to resolve the
differences. Additionally, transition impacts may identify enhancements
that can be incorporated into the source code.
The scanwizard utility prompts for the information needed to create a tran-
sition impact report. Default answers are displayed inside square brackets
([]) and can be selected by pressing the enter or return key. At any
prompt, a question mark (?) can be entered to display additional informa-
tion on the available choices.
The following transition impact reports can be created by scanwizard:
o Summary transition impact report - Lists the total number of times a
transition impact was found in the source file(s) along with a short
synopsis of the transition impact.
o Detailed transition impact report - Lists the name of the source file,
the line number in the source file that triggered the transition impact,
the transition impact identifier type, and a short synopsis of the tran-
sition impact.
Use these reports to understand the scope of the transition from the source
platform to the destination platform, and to identify the lines of code
that might be affected by the transition. For more information on the
format of the output reports, see scansummary(1) and scandetail(1).
A default set of options used to create a transition impact report is pro-
vided in the file scanwizardrc. This file, referred to as a profile file,
contains system wide default options that can be used by any user. To use
the system wide profile file, scanwizardrc, invoke the scanwizard utility
without the config_file option.
Users may specify their own set of default options by creating a configura-
tion file named .scanwizardrc in their HOME directory. The options speci-
fied in this file are the same as the options specified on the scande-
tail(1) or scansummary(1) command line. The options should be entered one
per line in the user's .scanwizardrc file. An example of a user specific
configuration file, named sample_scanwizardrc, is available and it can be
copied to the user's HOME directory and modified as necessary to create the
user specific defaults.
Additionally, users may create a configuration file which specifies the
options for the scanwizard utility. The name for a user-defined configura-
tion file can be any valid filename and the name of the file is specified
on the scanwizard command line (i.e. the config_file option). For example,
users may have one set of options for scripts, a different set of options
for C source code, and another set of options for Fortran source code. In
this case, three configuration files would be created and the options would
be entered one per line in each of the files.
EXAMPLES
The following examples show different ways to invoke scanwizard. The exam-
ples neither show all possible user prompts nor show the exact text for a
prompt. An ellipsis (...) indicates that information is displayed to the
user but not included in the example.
Example 1 (using HP-UX STK)
Run scanwizard without any arguments. A .scanwizardrc file does not exist
in the user's home directory. If you accept the options from the system
wide profile file, scanwizard creates the impact transition report. If you
do not accept the options, scanwizard prompts you to enter the options, to
accept the options you entered, and then creates the transition impact
report.
$ scanwizard
...
Do you want to use predefined set of options? (y/n) [y] :
The profile file (/etc/opt/STK/config/scanwizardrc) contains
the following options:
...
Do you accept these options? (y/n) [n] :
...
Example 2
Run scanwizard without any arguments. A .scanwizardrc file exists in the
user's home directory, /home/user_1. If you accept the options from the
user's default configuration file, scanwizard creates the impact transition
report. If you do not accept the options, scanwizard prompts you to enter
the options, to accept the options you entered, and then creates the tran-
sition impact report.
$ scanwizard
...
The configuration file (/home/user_1/.scanwizardrc) contains
the following options:
...
Do you accept these options? (y/n) [n] :
...
Example 3
Run scanwizard using a configuration file named my_config_file. The
my_config_file file is in the current working directory.
$ scanwizard my_config_file
...
The configuration file (my_config_file) contains the following
options:
...
Do you accept these options? (y/n) [n] :
...
Example 4
Run scanwizard with the configuration file specified and do not accept the
options in the configuration file. Next, scanwizard will ask if you want to
use the predefined options from the system wide profile file.
$ scanwizard my_config_file
...
The configuration file (my_config_file) contains the following
options:
...
Do you accept these options? (y/n) [n] : n
...
Do you want to use predefined set of options? (y/n) [y] :
...
ENVIRONMENT VARIABLES
The following environment variable affects the execution of scanwizard:
STK_EDITOR
Determines the editor invoked when you view a customized transition
impact report. The name of the editor is included in the transition
impact report. Therefore, set this variable before running scanwizard.
FILES
/opt/STK HP-UX Software Transition
Kit
/opt/STKL Linux to HP-UX Software
Transition Kit
/opt/STKS Solaris to HP-UX Software
Transition Kit
/opt/STKSL Solaris to Linux Software
Transition Kit
/opt/STKT Tru64 UNIX to HP-UX
Software Transition kit
/opt/STK[L|S|T|SL]/examples/sample_scanwizardrc Example .scanwizardrc file
/etc/opt/STK[L|S|T|SL]/config/scanwizardrc Profile file containing
system wide defaults
$HOME/.scanwizardrc Configuration file contain-
ing user specified defaults
SEE ALSO
Commands: scandetail(1), scansummary(1)