1> \help connect
\connect -s SERVER [-d DATABASE] [-au] [-su NAME] [-u USER] [-ap] [-sp NAME] [-p PASSWORD]
This command is used to establish a connection to a database.
Options:
-s SERVER specifies server name in a folder provided by the $connections variable
-d DATABASE sets the database name to switch into upon connect
-au asks for user name
-su NAME reads user name from the secure storage
-u USER sets the user name
-ap asks for password
-sp NAME reads password from the secure storage
-p PASSWORD sets the password
This command also accepts a single server name as an argument.
1> \help grep
\grep [OPTION ...] PATTERN [FILE ...]
\grep [OPTION ...] [-e PATTERN | -f FILE] [FILE ...]
\grep searches the named input FILEs, or standard input if no files are named, for lines containing a match to the given PATTERN. By default, \grep prints the matching lines.
Options:
-c Suppress normal output; instead print a count of matching lines for each input file. With the -r option, count non-matching lines.
-e PATTERN
Use PATTERN as the pattern. This can be used to specify multiple search patterns.
-f FILE
Obtain patterns from FILE, one per line. This can be used to protect a pattern beginning with a hyphen (-).
-H Print the file name for each match. This is the default when there is more than one file to search.
-h Suppress the prefixing of file names on output. This is the default when there is only one file to search.
-i Ignore case distinctions in the input files.
-L Suppress normal output; instead print the name of each input file from which no output would normally have been printed.
-l Suppress normal output; instead print the name of each input file from which output would normally have been printed.
-n Prefix each line of output with the 1-based line number within its input file.
-r Read all files under each directory recursively.
-v Invert the sense of matching, to select non-matching lines.
Notes:
If both -H and -h are specified, headers are not displayed. If both -L and -l are specified, -L takes precedence.
1>
|
50 KB
We may want to have a HelpDocsFormat API for use within our Command implementations. The user adds all the description, parameters and descriptions, then the class will format everything according to one specification.
A formatter that formats man page similar to UNIX man page presentation is now available. All of commands implemented by me have adopted this format (listed below). I will covert those commands implemented by other people to this new format next week.
Here is the list of commands that have been converted to the new man page formatter:
cp, describe, export, grep, gunzip, gzip, import, list, mkdir, mv, rename,
rm, rmdir, scp, sendmail, syncdir, tail, tar, touch, unzip, zip
The source code of commands listed above have been reverted back to SVN r25271 to recover the original man page contents. SVN r25272 removed some information from the original contents and we wanted to get those information back. In addition, the following changes have been done:
(a) Removed L10N from the original man page description.
(b) Incorporated changes made after revision 25272.
(c) Adopted newly implemented man page formatter.
Checked in as SVN r25325.
A formatter that formats man page similar to UNIX man page presentation is now available. All of commands implemented by me have adopted this format (listed below). I will covert those commands implemented by other people to this new format next week.
Here is the list of commands that have been converted to the new man page formatter:
cp, describe, export, grep, gunzip, gzip, import, list, mkdir, mv, rename,
rm, rmdir, scp, sendmail, syncdir, tail, tar, touch, unzip, zip
The source code of commands listed above have been reverted back to SVN r25271 to recover the original man page contents. SVN r25272 removed some information from the original contents and we wanted to get those information back. In addition, the following changes have been done:
(a) Removed L10N from the original man page description.
(b) Incorporated changes made after revision 25272.
(c) Adopted newly implemented man page formatter.
Checked in as SVN r25325.
Converted the following commands to adopt new man page format:
alias, ask, autocommit, cat, cd, change, clear, commit, connect, disconnect,
echo, edit, exec, go, help, history, ls, more, open, pwd,
reconnect, rollback, run, sql-history, set, sleep, source, ssh, tee, unalias,
unset.
ADS 11.0 branch, SVN r25344
Converted the following commands to adopt new man page format:
alias, ask, autocommit, cat, cd, change, clear, commit, connect, disconnect,
echo, edit, exec, go, help, history, ls, more, open, pwd,
reconnect, rollback, run, sql-history, set, sleep, source, ssh, tee, unalias,
unset.
ADS 11.0 branch, SVN r25344
As mentioned in issue #6963, the man page of each command now has 3 mandatory sections (NAME, SYNOPSIS, DESCRIPTION), which were verified there.
Additionally, by closing this issue, regression tests were added for the newer commands csv2x & session regarding various help messages as noted in issues: #6793, #6837, #6963, #7082.
As mentioned in issue #6963, the man page of each command now has 3 mandatory sections (NAME, SYNOPSIS, DESCRIPTION), which were verified there.
Additionally, by closing this issue, regression tests were added for the newer commands csv2x & session regarding various help messages as noted in issues: #6793, #6837, #6963, #7082.
Issue #6388 |
Closed |
Fixed |
Resolved |
Completion |
No due date |
Fixed Build ADS-11.0.0 branch/r25344 |
No time estimate |
1 issue link |
relates to #6963
Issue #6963Review fluid man page conventions |
We may want to have a HelpDocsFormat API for use within our Command implementations. The user adds all the description, parameters and descriptions, then the class will format everything according to one specification.