SUBFIND

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
ENVIRONMENT
FILES
EXAMPLES
AUTHOR
REPORTING BUGS
COPYRIGHT
SEE ALSO

NAME

subfind - program to search/find/change NOAH database record

SYNOPSIS

subfind [OPTIONS] [field matches]

DESCRIPTION

subfind is an administration program that is used in a command line shell by an administrator to search or alter the NOAH Document Management System Database residing on the current server. All access to the database is through the program knowing where the database file hierarchy is (noah.config file) and not through the http protocol.

There may be a wrapper script in /usr/bin with noah- prefix that calls this program in the correct run directory.

Why would an administrator need to interrogate the NOAH database?
One good example might be when an individual leaves the organization and he/she was working on a number of documents that a new or existing person will be taking on. What you want to do is quickly change the OWNER fields of a group of files (or all files) from the old username to the new username.

OPTIONS

-f FIELD=CONTENT ... : find FIELD names equal to CONTENT
-f FIELD~CONTENT ... : find FIELD names with CONTENT
-r field=NEW_CONTENT : replace FIELD with NEW_CONTENT
-w                   : write changes! (else it’s a test!)
-list                : list valid fieldnames
-database database : default is default
-v                   : verbose level 1
-vv                  : verbose level 2
-h                   : quick help (usage)
-help                : verbose help (this file)

-f FIELD=CONTENT
Find a FIELD equal to CONTENT.

You can have as many of these argument pairs as you want.

The field is generally UPPERCASE and you can get a list of available FIELDS with the -list option.

Each additional -f argument pairs narrows the search of the find, that is to say each pair is AND function to search.

-f FIELD~CONTENT
Find a FIELD approximately equal to CONTENT.

Basically, this is a search in the FIELD for the CONTENT being present (like searching for a word in a field).

-r FIELD=NEW_CONTENT
Once you have found the records you want, the -r option specifies which fields you want to alter with new content.

Note that no data is actually altered until you also include the -w option to write the changes.

Note also that some fields are not writable such as DIR and FILENO.

-l
List available fields for -r and -f.

-w
Write out changes.

-database DATABASE
Defaults to default but if you want to change it to a different database name you can do so with this command.

-v
Print more verbose messages to screen to tell you what it is thinking ...

-vv
Print even more verbose messages to screen to tell you what it really is thinking ...

-h
short usage help

-help
This help document.

ENVIRONMENT

This program is found in the admin directory and expects to be run from there.

In a Debian distribution, this program has a link to the wrapper program in the admin directory typically /usr/lib/noah/admin and the link name has a noah- prefix and is found in /usr/bin.

FILES

/usr/bin/subfind

This is a link to wrapper

/usr/lib/noah/admin/wrapper

This is a generic bash shell wrapper to start the program in the admin directory.

/usr/lib/noah/admin/subfind

This is the actual executable called by the wrapper.

/usr/lib/noah/database.config

This is typically a link to /etc/noah/database.config in a Debian release.

dindex.tab :F index.tab

These two file types are the index files in the database that subfind works on when searching and changing the fields. Note that these .tab files exist at all the leave ends of the directory structure. All together they form the total index of the database.

EXAMPLES

subfind -f OWNER=joeblow
Find database entries with field OWNER exactly equal to joeblow.

subfind -f OWNER=joeblow -f NAME~Marketing
Find database entries with field OWNER exactly equal to joeblow with the word Marketing found in the NAME of the documents or directories.

AUTHOR

Harold Blount - Nordicwind Inc. www.nordicwind.ca

REPORTING BUGS

http://noah.@nordicwind.ca

COPYRIGHT

This is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 or later <http://gnu.org/licenses/gpl.html>.

This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.