Документ взят из кэша поисковой машины. Адрес оригинального документа : http://www.eso.org/projects/dfs/team/man-webcheck.txt Дата изменения: Mon Jun 10 19:52:29 2002 Дата индексирования: Sun Apr 13 22:53:30 2008 Кодировка: Поисковые слова: comet hale-bopp

NAME
webcheck --- archive DFS Group document files

DESCRIPTION
Command line tool to archive, get a copy or check-out a document
file on a dedicated DFS Group repository.

It can be used only if three following conditions apply:
1) run with uid belonging to the 'dmd_df' group (gid=202)
2) if 'dmd_df' is not the default group, being able to chgrp to it.
3) have read/write access to the DFS shared disk: /home/dataflow/bin/QAtools
or /export/diskri/dataflow/bin/QAtools
(this is the disk where the SNIFF repository is located)
Please, ask your system administrator for support.

Webcheck is to run at least on following hosts: usg0, arcus1, arcus2, dfs1 and dfs2 (Solaris);
seg1, dfs4 and arcdev1 (HP-UX).

Each time a file is checked-out by a given DFS Group member,
a lock is set, disabling all other DFS Group members to
check it out again and thus modify it.

Following file categories can be archived in the repository:
* stable/complete DFS Group document issues
* DFS Group To-Do lists
* DFS Group schedules
* DFS Group Release Notes (to be delivered for any new software release)
* web pages which can contribute to the DFS Group website

All archived files are accessible from the DFS Group website.
Only exception is about sources of documents (i.e. documents archived
via the -docsrc argument), which can only be retrieved via webcheck.

Depending on the file category and the fact the file is archived for the
'first' time, publishing on the DFS Group website is automatic or will
require a manual intervention from the DFS QA manager.

Only 'stable and complete versions' of documents written by DFS Group
members must be archived via webcheck. Webcheck is not meant
to support working/living versions or document drafts.

The file name is verified and must then be compliant with DFS Group
rules related to the file category.

USAGE
webcheck -in -xxx filename Archive a file.
webcheck -get -xxx filename Get a copy of an archived file
(without setting a lock).
webcheck -out -xxx filename Check-out an archived file
(and set a lock).
webcheck -l -xxx [searchpatern] List the DFS repository content.

where -xxx specifies ONE (and only one) of following file categories:
-todo To-Do list file.
-rel Release Note file.
-sched schedule file.
-page web page.
-docsrc SOURCES of a document to be configuration
controlled (WORD or Latex format, preferably).
-docread READABLE copy of a document to be configuration
controlled.

ARGUMENT SYNONYMS
-l --> -list
-in --> -i
-out --> -o
-get --> -g
-todo --> -t
-rel --> -r or -n (like release or note)
-sched --> -s
-page --> -p or -w (like page or web)
-docread --> -R or -read (like readable)
-docsrc --> -S or -src (like sources)


filename is mandatory with -in, -get and -out arguments.

Any file archived with a new specific name (i.e. name not already
existing in the DFS repository) is considered as 'archived for
the first time'.
A file archived for the first time is not automatically published on
the DFS Group web, but the DFS Group QA manager (and, for -docsrc,
the DMD secretary, too) automatically receives a related notification
and may then decide to publish it.
Exception is for any new READABLE document archived for the first time
(-docread): such document is automatically published and accessible at:
http://www.eso.org/projects/dfs/team/DFS-system.html

Any file already archived and published on the web can be
checked-out, modified locally and re-archived: the updated
version will then automatically be updated on the web.


FILE NAMING RULES
Every file must be named with rules depending on its category.
Deviations may lead the file to be rejected by webcheck.

-todo filename:
must start with one of the DFS Group projects standard abbreviations
(see: http://www.eso.org/projects/dfs/team/abbreviations.html)
followed by a dash (-) character,
than ends with '-to-do-open.txt' or '-to-do-close.txt'

-sched filename:
must start one of the DFS Group standard abbreviations
(see: http://www.eso.org/projects/dfs/team/abbreviations.html),
followed by the '-sched-' string, rest of filename being free.
Authorized file extensions are: GIF, JPG and TXT

-page filename:
must start with one of the DFS Group standard abbreviations
(see: http://www.eso.org/projects/dfs/team/abbreviations.html)
followed by a dash (-) character, rest of filename being free.
If not, the file is archived anyway, but in a trash directory.
Authorized file extensions are: PDF, HTML, PS, GIF, JPG and TXT

-rel filename:
must start with one of the DFS Group standard abbreviations
(see: http://www.eso.org/projects/dfs/team/abbreviations.html)
followed by a dash (-) character.
If not, the file is archived anyway, but in a trash directory.
Filename must also contain the release number '-i', '-i_j' or '-i_j_k'
(where i, j and k are digits from 0 to 9).
Other additional informative strings are allowed.
Authorized file extension is: TXT (even mandatory).

-docsrc filename:
must strictly be compliant with DFS Group naming rules for documents
(see: http://www.eso.org/projects/dfs/team/ESO-doc-proc.html#name)
for instance 'PROJ-TYPE-ESO-PSC-chrono-Vi.ext'
Authorized file extensions are: DOC, TAR and TGZ.

-docread filename:
must strictly be compliant with DFS Group naming rules for documents
(see: http://www.eso.org/projects/dfs/team/ESO-doc-proc.html#name)
for instance 'PROJ-TYPE-ESO-PSC-chrono-Vi.ext'
Authorized file extensions are: HTML, PS, PDF, TAR and TGZ.
If extension is TAR or TGZ, webcheck untars the file and look for an
'index.html' file to automatically publish the document on the web.

Please notice: once archived, a file is renamed as 'filename-archived' (on your local host).


OPERANDS
filename must 'stricly' be consistent with naming
conventions defined for DFS Group documents (see
http://www.eso.org/projects/dfs/team/ESO-doc-proc.html#name)

Tar files are allowed for docread and docsrc documents only:
otherwise, webcheck handles one file at a time.
Creating tar archive via the 'gtar' command is recommended.

GNU compressed files are allowed whatever the file category is.


OPTIONS
[searchpatern] is allowed when using the -l argument only,
to limit number of entries which can be returned when listing
the DFS repository content.
This patern must follow the regular expression rules (man regexp
for details).
[searchpatern] can be used or not for any file category, but it is
mandatory when listing the web pages repository content (using -page
argument) or listing Release Notes (-rel).

EXAMPLES
webcheck -l -todo --> lists all To-Do lists already
archived in the repository.

webcheck -l -docread MAN-ESO-19000
--> returns all existing readable documents
whose name contains the 'MAN-ESO-19000'
patern

webcheck -in -sched VST-sched.gif --> archive the 'VST-sched.gif' file

webcheck -get -docread VLT-MAN-ESO-19000-1781-V24.pdf
--> get a copy of the readable file named
VLT-MAN-ESO-19000-1781-V24.pdf


TIPS TO AUTOMATICALLY OPEN A READABLE DOCUMENT FROM NETSCAPE
In order to automatically open a PostScript file from Netscape,
please, configure your web browser as following:
* select the 'Edit>Preferences...' menu item.
* select the 'Navigator>Applications' category.
* in the 'Description' box, verify a 'Postscript Document' entry
already exists. If so, select it and click on 'Edit'.
* If not, click on 'New'.
* Enter 'application/postscript' as MIMEType.
* Enter 'ai,eps,ps' as Suffixes.
* Select 'Handled By>Application'.
* Enter your path to the ghostview executable: should be similar to
/usr/server/X11/bin/ghostview %s
* Verify such path via the 'which' command.

For PDF, same sequence except:
* Enter 'application/pdf' as MIMEType
* Enter 'pdf' as Suffixes
* Select 'Handled By>Application'
* Enter your path to the acroread executable: should be similar to
/usr/server/bin/acroread %s