\*(n) -List   (1) manpage
\*(n) -List
1
  • NAME
      (n) -List - list (possibly) interesting things
  • SYNOPSIS
      (n) -List [ option ... ] list-name
      (n) -List -List [ option ... ]
      (n) -List -Help
  • DESCRIPTION
      The (n) -List command is used to list information. There are a number of possible list-name s, as follows (abbreviations as for command line options):
      Administrators

      List the administrators of a project.
      Change_Details

      List full information about a change in large format.
      Change_Files

      List all files in a change. The verbose version includes details such as the action being taken, the edit number of the file, and whether it's being moved. The terse version only lists the files names (and omits removed files), this is useful for shell scripts and interfacing with build tools.
      Change_File_History

      This listing shows the history of each file in the change.  It includes each delta number (so that you may reproduce it) and brief description, of each change which affected each file.
      Change_History

      List the history of a change.
      Changes

      List the changes of a project. The verbose version includes details such as the state of the change and it's brief description.  The terse version lists only the change numbers, which is good for shell scripts.
      Default_Change

      List the default change for the current user.
      Default_Project

      List the default project for the current user.
      Developers

      List the developers of a project.
      Integrators

      List the integrators of a project.
      List_List

      List all lists available.
      Locks

      List all currently active locks.
      Outstanding_Changes

      List all changes not yet completed.
      All_Outstanding_Changes

      List all changes not yet completed, for all projects.
      Project_Files

      List all files in the baseline of a project. The verbose version includes details such as the action being taken, the edit number of the file. The terse version only lists the files names (and omits removed files), this is useful for shell scripts and interfacing with build tools. If a change number is given, files included in the change are omitted from the list (giving the change's perspective on what the project files are).
      Project_History

      List the integration history of a project.
      Projects

      List all projects.
      Project_Aliases

      List all project aliases.
      Reviewers

      List the reviewers of a project.
      State_File_Name

      Prints the absolute path of the project's or change's state file. Useful for cookbooks and makefiles.
      Users_Changes

      List of changes owned by the current user.
      Version

      List version of a project or change. This includes the major and minor version number, and the previous version number if available. The list of copyright years is also printed.

      Most of these lists are available from other (n) functions. Many (n) functions provide more specific lists.
  • OPTIONS
      The following options are understood:
      -Change number
      This option may be used to specify a particular change within a project. When no -Change option is specified, the AEGIS_CHANGE environment variable is consulted. If that does not exist, the user's $HOME/.aegisrc file is examined for a default change field (see aeuconf(5) for more information). If that does not exist, when the user is only working on one change within a project, that is the default change number. Otherwise, it is an error.
      -Help

      This option may be used to obtain more information about how to use the (n) program.
      -List

      This option may be used to obtain a list of suitable subjects for this command. The list may be more general than expected.
      -PAGer
      The output of listings and help is piped through the pager command given in the PAGER environment variable (or more if not set). This is the default if the command is in the foreground, and the output is a TTY. This option may be used to override any preference specified in the aeuconf(5) file.
      -No_PAGer

      This option may be used to ensure that the output of listings and help is not piped through a pager command. This is the default if the command is in the background, or if the output is not a TTY. This option may be used to override any preference specified in the aeuconf(5) file.
      -Page_Length number

      This option may be used to set the page length of listings. The default, in order of preference, is obtained from the system, from the LINES environment variable, or set to 24 lines.
      -Page_Width number

      This option may be used to set the page width of listings and error messages. The default, in order of preference, is obtained from the system, from the COLS environment variable, or set to 79 characters.
      -Project name
      This option may be used to select the project of interest. When no -Project option is specified, the AEGIS_PROJECT environment variable is consulted. If that does not exist, the user's $HOME/.aegisrc file is examined for a default project field (see aeuconf(5) for more information). If that does not exist, when the user is only working on changes within a single project, the project name defaults to that project. Otherwise, it is an error.
      -TERse

      This option may be used to cause listings to produce the bare minimum of information. It is usually useful for shell scripts.
      -UNFormatted

      This option may be used with most listings to specify that the column formatting is not to be performed. This is useful for shell scripts.
      -Verbose
      This option may be used to cause (n) to produce more output. By default (n) only produces output on errors. When used with the -List option this option causes column headings to be added.


      All options may be abbreviated; the abbreviation is documented as the upper case letters, all lower case letters and underscores (_) are optional. You must use consecutive sequences of optional letters.

      All options are case insensitive, you may type them in upper case or lower case or a combination of both, case is not important.

      For example: the arguments "-project, "-PROJ" and "-p" are all interpreted to mean the -Project option. The argument "-prj" will not be understood, because consecutive optional characters were not supplied.

      Options and other command line arguments may be mixed arbitrarily on the command line, after the function selectors.


      The GNU long option names are understood. Since all option names for (n) are long, this means ignoring the extra leading '-'. The "--option=value" convention is also understood.
  • RECOMMENDED ALIAS
      The recommended alias for this command is
      
      csh% alias ael '(n) -l \!* -v'
      sh$ ael(){(n) -l "$@" -v}
  • ERRORS
      It is an error if
      the list name given is unknown.





















  • EXIT STATUS
      The
      (n)
      command will exit with a status of 1 on any error.
      The
      (n)
      command will only exit with a status of 0 if there are no errors.
  • ENVIRONMENT VARIABLES
      See
      aegis(1)
      for a list of environment variables
      which may affect this command.


  • SEE ALSO
      aedb(1)
      begin development of a change (listing option)
      aeib(1)
      begin integration of a change (listing option)
      aer(1)
      report generator
      aerpass(1)
      pass review of a change (listing option)
      aeuconf(5)
      user configuration file format
      aels(1)
      annotated directory listing























  • COPYRIGHT
      (n) version (V)


      Copyright (C) (Y) Peter Miller;
      All rights reserved.



      The (n) program comes with ABSOLUTELY NO WARRANTY;
      for details use the '(n) -VERSion License' command.
      This is free software
      and you are welcome to redistribute it under certain conditions;
      for details use the '(n) -VERSion License' command.


  • AUTHOR
      l r l.
      Peter Miller;E-Mail:;millerp@canb.auug.org.au
      /\/\*;WWW:;http://www.canb.auug.org.au/~millerp/

Current Users: 34 © 1999-2006 Linux.com.hk PenguinSoft
All trademarks and copyrights on this page are owned by their respective companies. Linux is a trademark of Linus Torvalds.