ctys-groups

August, 2010

NAME

ctys-groups - lists groups from groups DB and groups caches

SYNTAX

ctys-groups


   [-c]
   [-d <level>]
   [-D <deepness-level>]
   [-e [<group-list>|<path-list>]]
   [-F]
   [-h]
   [-H <help-options>]
   [-l]
   [-m <1|2|3|4|5|5x|6|7|7u|8|8u>]
   [-S]
   [-V]
   [-X]
   [<group-list>]

DESCRIPTION

ctys-groups lists and displays groups from groups DB and groups caches. This tool utilizes ctys-vhost and adds some usability to the more detailed interface parameters.

The display can be applied for specific groups, subtrees, or for nested groups. Also a tree-view based on the UNIX command tree is included, which supports the listing of components and subtrees from the variable CTYS_GROUPS_PATH.

The output format of each group entry for default short-listing is:

  <size-kbytes> <#hosts>/<#includes> <#total> <group-filename>

For additional information of groups syntax refer to 'GroupResolution'.

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

OPTIONS

ctys-groups

-c

List cached groups the output format is:

  <filesize> <lines=members> <group-cache-file-path>

-d <level>: Debug.

-D <deepness-level>: Display structure of groups with the given level of resursion deepness.

-e [<group-list>|<path-list>]: Edit one or multiple groups by Emacs. When no argument is provided the CTYS_GROUPS_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_GROUPS_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_GROUPSEDIT. Currently preconfigured editors/starters are: Emacs, gvim, vim, konqueror, and nautilus.

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

-h: Print help.

-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 group definitions.

  <filesize> <lines=members> <group-name>

-m <1|2|3|4|5|5x|6|7|7u|8|8u>

List group members in different formats.

1 listing
2 listing
3 listing
4 callable for cut-and-paste
5 callable for cut-and-paste
5x callable for cut-and-paste with absolute overall indexes for groups and hosts,
6 listing of contained remote accounts in EMail format
7 account list for machine processing
7u account list for machine processing, with stripped redundancies.
8 host list for machine processing
8u host list for machine processing, with stripped redundancies.

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

-V: Version.

-X: Terse.

ARGUMENTS

[<group-list>]

An optional list of groups to be displayed only, if not provided all present groups from directories within the variable CTYS_GROUPS_PATH are scanned and displayed. For additional information refer to the S-OPTION-OF-CTYS-VHOST. The format of <group-list> is:

  <group-list> =: <group-name>[(%| )<group-list>]

The seperator is here slightly different from the "ctys-vhost" option. For ctys-groups optionally the common suboptions-argument seperator "%" or the common UNIX arguments seperator "SPACE" could be used as seperator.

The usage of the listed <group-names> is as follows:

name
The name is expected to be a group name, so search is performed for a file of name "name".

name/
The name is expected to be a directory name, so search is performed for a subdirectory within the CTYS_GROUPS_PATH. All files within that subtree are listed.

name01/name02/name03/
The path is expected to be a subdirectory pathname, so search is performed for a subdirectory-path within the CTYS_GROUPS_PATH. All files within that subtree are listed.

/name01/name02/name03/
The path is expected to be an absolute directory pathname, so search is performed within the subtree of given path only. All files within that subtree are listed.

/name01/name02/name03/name
The name is expected to be an absolute filename, so test is performed for that file only.

The nested containment hierarchy by "include" is expanded before output in any case. The following example lists the desktop/ and scan/ directories.

  ctys-groups  scan/ desktops/

EXIT-VALUES

0: OK:: Result is valid.
1: NOK:: Erroneous parameters.
2: NOK:: Missing an environment element like files or databases.

AUTHOR

Written and maintained by Arno-Can Uestuensoez:

Maintenance:	<<acue_sf1 (a) sourceforge net>>
Homepage:	<https://arnocan.wordpress.com>
Sourceforge.net:	<http://sourceforge.net/projects/ctys>
Project moved from Berlios.de to OSDN.net:	<https://osdn.net/projects/ctys>
Commercial:	<https://arnocan.wordpress.com>

COPYRIGHT

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.