swvi

Package: WA2L/edrc 1.5.57
Section: General Commands (1)
Updated: 03 April 2013
Index Return to Main Contents

 

NAME

swvi - edit/create the software inventory file

 

SYNOPSIS

edrc/bin/swvi [ -h ]

swvi [ -a ][ -r ]

 

AVAILABILITY

WA2L/edrc

 

DESCRIPTION

With swvi and sw_report it is very easy to create a software inventory of a system without manually maintaining extra lists that document this.

With the swvi command the "software inventory file" is created or edited. This file ( ..sw_inventory ) contains the information about the software installed in a certain directory.

A "software inventory file" can be created by everyone having the permissions to write into the directory where the software is installed to. So the task to maintain the "software inventory file" and finally the software inventory of a system is not only dependent of the system administrator which has the root password.

This "software inventory files" spread over many directories on the system are collected with the sw_report command to generate either a plain ASCII- or a CSV report of all installed software.

To place this information into the same directory as the software is installed has the advantage that it is moved/copied if the directory containing the software is moved/copied to an other location. Furthermore it is more likely updated then a manually maintained list residing on some documentation server.

To create a new "software inventory file" you have to change to the directory where the software is installed and call the swvi command. An interactive dialog will query you information needed. All information except the SOFTWARE, VERSION, INST_USER and INST_GROUP fields are optional.

If there is already an existing ..sw_inventory file in the directory, the current file is loaded into vi for editing.

If a second software is installed into the same directory (what is often the case for /usr/local ) you can invoke swvi -a to append a new record to the file answering the interactive dialog.

Be aware that using the -a option will ensure that only one identical SOFTWARE, VERSION pair exists in one ..sw_inventory file.

The "software inventory file" is created with the permissions '644' and the user/group of the creating user. If the 'root' user invokes swvi the user/group setting of the overlying directory are set to ensure that the software owner (= the user ID that has been used to install the software) is able to modify the ..sw_inventory file in the future.

The following fields will be queried (see also output of swvi -h ):

* = required entries

SOFTWARE*
Software name

VERSION*
Software version

INST_USER*
Installation user

INST_GROUP*
Installation group

RUN_USER
User under which the software is started

RUN_GROUP
Group under which the software is started

CFG_DIR
Configuration directories spaces separated

VAR_DIR
Var directories separated with spaces

LICENSE
License (e.g.: GNU, 5 LTU, ...)

LIC_MGMT
License management (file, server, ...)

WEB
Source of information on Internet

DOC
Where to find documentation

INST_SRC
Installation Source (SW Path, CD-Name, ...

PRODUCT
Product (Application) that uses the software

INSTANCE
Application instance (e.g.: PRODUCTION, TEST, Online, Reporting, ....)

COMMENT
Additional comments

 

OPTIONS

''
create a new ..sw_inventory file if it does not exist in the current directory or load an existing ..sw_inventory file into vi for editing.

-h
usage message.

-a
add a new record to an existing ..sw_inventory file using the interactive dialog.

-r
remove (clear) the contents of an already existing ..sw_inventory file. This option is rarely used in manual invocation, but is useful if you perform automated installations. For automated installations see also apply2sw_inventory(1).

 

EXIT STATUS

0
no error.

1
no write permission to current working directory.

2
operating system not supported. See osid(3) if you get this error.

4
usage displayed.

5
command aborted with Ctrl+C.

 

FILES

..sw_inventory
"software inventory file" containing all software information of software installed in the directory where created.

etc/exrc
settings for the vi / vim editor.

 

SEE ALSO

edrcintro(1), sw_report(1), sw_inventory(4), apply2sw_inventory(1), fields2swvi(3), vi(1), duvi(1)

 

NOTES

To see how to document (label) data and other directories efficiently, see duvi(1).

You might hear the argument, that maintaining a software inventory that way is not needed at all, due to the fact that the operating system provides this information via the built in software package management mechanism. But from experience, this is not sufficient for the most systems. Many software is distributed in a variety of formats, and I personally know not a single system administrator which creates for *each* piece of software that is installed a software package that is recognized by the operating system (rpm for Linux, SW-Depots for HP-UX, pkg for Solaris, ...).
But at latest, when the date of migrating the system (and all installed software and applications) to a newer one comes, the big worries/questions/issues/no-go's/show-stoppers, however you like to name it, about not knowing what is installed on the current system and a not up-to-date software inventory, will come up. And this is one moment where the usage swvi and sw_report really pays back.

 

BUGS

-

 

AUTHOR

swvi was developed by Christian Walther. Send suggestions and bug reports to wa2l@users.sourceforge.net .

 

COPYRIGHT

Copyright © 2013 by Christian Walther

This is free software; see edrc/doc/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


 

Index

NAME
SYNOPSIS
AVAILABILITY
DESCRIPTION
OPTIONS
EXIT STATUS
FILES
SEE ALSO
NOTES
BUGS
AUTHOR
COPYRIGHT

This document was created by man2html using the manual pages.
Time: 00:14:26 GMT, March 08, 2025