UPDATE-OTAGS(8) System administration commands UPDATE-OTAGS(8)NAME
update-otags - update system-wide tags tables
SYNOPSIS
update-otags
DESCRIPTION
update-otags runs otags on the system-wide installed OCaml files (in ocamlc -where). This makes it possible to use the tag-features of
vi/vim and Emacs to jump to the declarations of library functions in the system-wide installed .mli files to read the documentation that is
hopefully embedded in those files.
To use the system-wide tags table in Emacs, use M-x visit-tags-table <RET> /var/lib/otags/TAGS. To load it by default, customize tags-ta-
ble-list to contain /var/lib/otags (by using M-x customize-variable, for instance).
For vim use :set tags=/var/lib/otags/tags or add set tags=/var/lib/otags/tags to your .vimrc.
One would typically update the system-wide tags tables with a cron-job once per week or day.
FILES
/var/lib/otags/{TAGS,tags}
System-wide tags table for Emacs and vi/vim.
/usr/share/otags/hints
Directory for parsing hints. Packages that install files in non-standard syntax can install a parser hints file for otags in this
directory, see option -parser-hints in the otags(1) manual.
BUGS
Camlp4 (and therefore otags too) cannot parse all legal OCaml sources. Most notably, camlp4 dies on pervasives.mli (see bug #5495). There-
fore, none of the core library functions are tagged.
Various files in the system-wide OCaml directory are written in the revised syntax or require other syntax extensions. In principle these
files can all be properly tagged, but the dumb update-otags script tries to parse all files with the original syntax.
CREDITS
update-otags appeared first in Debian Etch (see Debian bug #341939). It has been added to the contrib directory with an improved man page
in otags 3.12.2.
AUTHOR
Hendrik Tews <otags at askra.de>
SEE ALSO otags(1)OTAGS January 2012 UPDATE-OTAGS(8)
Check Out this Related Man Page
update-service(8) System Manager's Manual update-service(8)NAME
update-service - add/remove a service to/from system-wide service supervision
SYNOPSIS
update-service --add|--remove service-directory [service-name]
update-service --list|--check [service-name]
DESCRIPTION
service-directory must be a directory to be used by supervise(8), service-name must not start with a dot, and must not contain a slash.
update-service adds or removes the service-directory to the system-wide service supervision provided through daemontools' svscan(8), lists
all registered system-wide services, or checks for a specific service-name whether it is registered.
When adding a service, and the service-directory resides in /etc/, update-service makes sure that the ./supervise/ subdirectories in the
service-directory, and the optional service-directory/log/, are symbolic links pointing into /var/lib/supervise/, unless they already are
symbolic links.
OPTIONS --add | -a
Add the service directory service-directory to the system-wide service supervision, under the name service-name. If service-name is
not specified, update-service will use the basename of service-directory. You can use the svc(8) program to control the newly added
service, and the svstat(8) program to query its status, e.g.:
# svstat /etc/service/service-name
--remove | -r
Remove the service directory service-directory, which has been added under the name service-name, from the system-wide service
supervision. If service-name is not specified, update-service will use the basename of service-directory. When removing the ser-
vice-directory, the exit command is sent to the corresponding supervise(8) process, telling it to take the service down and exit
afterwards. You can use the svc(8) and svstat(8) programs to control the removed service, or query its status, e.g.:
# svstat service-directory
--list | -l
If service-name is specified, update-service checks whether service-name is registered as system-wide service, prints a message and
exits non-zero if not, or prints the service-name and the directory it points to and exits zero if yes. If service-name is not
specified, it prints the names of all system-widely registered services, one per line.
--check | -c
The same as --list, but update-service doesn't print anything to standard out or standard error.
ENVIRONMENT
SVDIR The environment variable $SVDIR overrides the default services directory /etc/service/.
FILES
/etc/service/
SEE ALSO svc(8), svstat(8), svscan(8), svscanboot(8)AUTHOR
Gerrit Pape <pape@smarden.org>
update-service(8)