~ubuntu-branches/ubuntu/oneiric/ncbi-tools6/oneiric

« back to all changes in this revision

Viewing changes to doc/man/entrcmd.1

  • Committer: Bazaar Package Importer
  • Author(s): Aaron M. Ucko
  • Date: 2008-07-14 19:43:15 UTC
  • mfrom: (2.1.12 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080714194315-ed44u9ek7txva2rz
Tags: 6.1.20080302-3
tools/readdb.c: enable madvise()-based code on all glibc (hence all
Debian) systems, not just Linux.  (Closes: #490437.)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH ENTRCMD 1 2001-10-03 NCBI "NCBI Tools User's Manual"
2
 
.SH NAME
3
 
entrcmd \- non-interactive command line interface for Entrez
4
 
.SH SYNOPSIS
5
 
.B entrcmd
6
 
[\|\fB\-\fP\|]
7
 
[\|\fB\-c\fP\|]
8
 
[\|\fB\-d\fP\ \fIstr\fP\|]
9
 
[\|\fB\-e\fP\ \fIstr\fP\|]
10
 
[\|\fB\-f\fP\|]
11
 
[\|\fB\-g\ F\fP\|]
12
 
[\|\fB\-h\fP\|]
13
 
[\|\fB\-i\fP\ \fIstr\fP\|]
14
 
[\|\fB\-l\fP\ \fIstr\fP\|]
15
 
[\|\fB\-n\fP\ \fIfilename\fP\|]
16
 
[\|\fB\-o\fP\ \fIfilename\fP\|]
17
 
\fB\-p\fP\ \fIstr\fP
18
 
[\|\fB\-r\fP\|]
19
 
[\|\fB\-s\fP\|]
20
 
[\|\fB\-t\fP\ \fIstr\fP\|]
21
 
[\|\fB\-u\fP\ \fIstr\fP\|]
22
 
[\|\fB\-w\fP\ \fIstr\fP\|]
23
 
[\|\fB\-x\fP\ \fIstr\fP\|]
24
 
[\|\fB\-y\fP\ \fIN\fP\|]
25
 
.SH DESCRIPTION
26
 
\fBentrcmd\fP is a non-interactive command-line interface which allows
27
 
a user to perform a series of neighboring and output operations, based
28
 
upon an initial set of UIDs or a boolean expression which describes a
29
 
set of UIDs.  Alternatively, it can be used to display an
30
 
alphabetically sorted list of terms near an initial term.
31
 
.SH OPTIONS
32
 
A summary of options is included below.
33
 
.TP
34
 
\fB\-\fP
35
 
Print usage message
36
 
.TP
37
 
\fB\-c\fP
38
 
\&'Check' WWW output Forms
39
 
.TP
40
 
\fB\-d\fP\ \fIstr\fP
41
 
Initial database (default = m)
42
 
.TP
43
 
\fB\-e\fP\ \fIstr\fP
44
 
Boolean expression
45
 
.TP
46
 
\fB\-f\fP
47
 
For WWW output, use Forms
48
 
.TP
49
 
\fB\-g\ F\fP
50
 
Do not use WWW-style encoding for special input characters
51
 
.TP
52
 
\fB\-h\fP
53
 
Print detailed help.  Requires, but ignores, \fB\-p\fP\ \fIstr\fP
54
 
.TP
55
 
\fB\-i\fP\ \fIstr\fP
56
 
Comma-delimited list of files to import for named UID list
57
 
.TP
58
 
\fB\-l\fP\ \fIstr\fP
59
 
Taxonomy lookup string
60
 
.TP
61
 
\fB\-n\fP\ \fIfilename\fP
62
 
On-the-fly neighboring from \fIfilename\fP
63
 
.TP
64
 
\fB\-o\fP\ \fIfilename\fP
65
 
Output file (default = stdout)
66
 
.TP
67
 
\fB\-p\fP\ \fIstr\fP
68
 
Program of commands
69
 
.TP
70
 
\fB\-r\fP
71
 
Get sequences from ID Repository
72
 
.TP
73
 
\fB\-s\fP
74
 
Display status report
75
 
.TP
76
 
\fB\-t\fP\ \fIstr\fP
77
 
Produce a list of terms
78
 
.TP
79
 
\fB\-u\fP\ \fIstr\fP
80
 
Comma-delimited list of UIDs
81
 
.TP
82
 
\fB\-w\fP\ \fIstr\fP
83
 
Produce WWW/HTML formatted output, using \fIstr\fP (/htbin is
84
 
recommended) as the directory prefix for linked hypertext items.
85
 
.TP
86
 
\fB\-x\fP\ \fIstr\fP
87
 
Name of export file for named UID list
88
 
.TP
89
 
\fB\-y\fP\ \fIN\fP
90
 
Complexity:
91
 
.RS
92
 
.PD 0
93
 
.IP 1
94
 
bioseq only
95
 
.IP 2
96
 
bioseq set
97
 
.IP 3
98
 
nuc-prot set (default)
99
 
.PD
100
 
.RE
101
 
.SH AUTHOR
102
 
The National Center for Biotechnology Information.