.

NAME

ctys-macros - searches and list macros

SYNTAX

ctys-macros

   [-a]
   [-c]
   [-d <debug-level>*]
   [-D <deepness-level>]
   [-e [<macro-file-list>|<path-list>]]
   [-E]
   [-F]
   [-f <macro-file>]
   [-h]
   [-H <help-options>]
   [-l]
   [-N]
   [-S]
   [-V]
   [-X]
   [<macro-list>]

DESCRIPTION

ctys-macros searches within a macro file and lists the matched macros as requested. Therefore the standard path is searched for a macro file with the provided name or 'default'. The result could be filtered by adding an optional filter rule as argument.

Even though the options -S, D, and -F are already provided for display of subtrees, the actual evaluation in current version is proceeded within a flat search of the provided CTYS_MACRO_PATH.

The '-e' option provides by default for Emacs based edit (by gnome menue) , but could be adapted by configuration of CTYS_MACROSEDIT.

.

OPTIONS

ctys-macros

-a

Adds atoms to the displayed list.

-c

Adds combined to the displayed list.

-d <debug-level>

Same as ctys.

-D <deepness-level>

Display structure of macros with the given level of recursion deepness.

-e [<macro-file-list>|<path-list>]

Edit one or multiple groups by Emacs. When no argument is provided the CTYS_MACRO_PATH is evaluated and an Emacs instance is opened with all present directories. When a directory and/or group list - which is actually a file list - is provided, these are searched for the relative path provided, first from current directory, than by using each existing entry within CTYS_MACRO_PATH as a prefix. Absolute paths are just evaluated for providing a valid filename/pathname.

The default editor could be configured within the distribution specific configuration file by CTYS_MACROSEDIT. Currently preconfigured editors/starters are: Emacs, gvim, vim, konqueror, and nautilus.

-E

List expanded definitions. Sets implicitly the "-c" option.

-f <macro-file>

The basename of the macro file to be searched within the standard path list. DEFAULT:"default"

-F

Display file structure of groups with the given level in -D option.

-h|--help|-help

Print help, refer to "-H" for additional information.

-H <help-option>

The extended help option is based on system interfaces for display of manpages, PDF and HTML documents. This comprises the man pages and installed manuals.

For additional help refer to the documents or type ctys -H help.

-l

Lists available macro files within the standard searchpath. Each of this has to be fully self-contained file, which could be selected by usage of it's basename only. The selection order in case of multiple occurance is "first-wins".

-N

List non-expanded definitions, default is names only. The scope of display (atoms, combined) is not influenced.

-S

Display directory structure of groups with the given level of deepness in -D option.

-V

Version.

-X

Terse.

.

ARGUMENTS

[<macro-list>]

An optional list of macros to be displayed. The names are case sensitive and are expand completely.

.

EXIT-VALUES

0: OK:

Result is valid.

1: NOK:

Erroneous parameters.

2: NOK:

Missing an environment element like files or databases.

SEE ALSO

ctys executables

ctys-groups(1)

AUTHOR

Written and maintained by Arno-Can Uestuensoez:

COPYRIGHT

Copyright (C) 2008, 2009, 2010 Ingenieurbuero Arno-Can Uestuensoez

For BASE package following licenses apply,

• for software see GPL3 for license conditions,
• for documents see GFDL-1.3 with invariant sections for license conditions,

This document is part of the DOC package,

• for documents and contents from DOC package see
  'Creative-Common-Licence-3.0 - Attrib: Non-Commercial, Non-Deriv'
  
  
  with optional extensions for license conditions.

For additional information refer to enclosed Releasenotes and License files.