Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Man page updates, pakager.py fixes, maybe SERVER-1968

* packager.py had a bug that left the man pages out of the .deb
  packages.
  • Loading branch information...
commit 72f549af6331ebee34ae70d97a7f8e52298470d3 1 parent d3a9fe9
@kreuter kreuter authored
View
9 buildscripts/packager.py
@@ -612,7 +612,7 @@ def write_debian_rules_file(path, spec):
# THE FOLLOWING LINE IS INTENTIONALLY COMMENTED.
\t# scons
#docbook-to-man debian/mongodb.sgml > mongodb.1
-\tls debian/*.1 > debian/mongodb.manpages
+\tls debian/*.1 > debian/@@PACKAGE_NAME@@.manpages
\ttouch $@
@@ -893,6 +893,7 @@ def write_rpm_spec_file(path, spec):
%defattr(-,root,root,-)
#%doc README GNU-AGPL-3.0.txt
+%{_bindir}/bsondump
%{_bindir}/mongo
%{_bindir}/mongodump
%{_bindir}/mongoexport
@@ -900,19 +901,19 @@ def write_rpm_spec_file(path, spec):
%{_bindir}/mongoimport
%{_bindir}/mongorestore
%{_bindir}/mongostat
-%{_bindir}/bsondump
# FIXME: uncomment when mongosniff is back in the package
#%{_bindir}/mongosniff
+%{_mandir}/man1/bsondump.1*
%{_mandir}/man1/mongo.1*
%{_mandir}/man1/mongodump.1*
%{_mandir}/man1/mongoexport.1*
%{_mandir}/man1/mongofiles.1*
%{_mandir}/man1/mongoimport.1*
+%{_mandir}/man1/mongorestore.1*
+%{_mandir}/man1/mongostat.1*
# FIXME: uncomment when mongosniff is back in the package
#%{_mandir}/man1/mongosniff.1*
-%{_mandir}/man1/mongostat.1*
-%{_mandir}/man1/mongorestore.1*
%files server
%defattr(-,root,root,-)
View
28 debian/bsondump.1
@@ -0,0 +1,28 @@
+.TH BSONDUMP "1" "March 2011" "10gen" "MongoDB Database"
+.SH NAME
+bsondump \- print BSON documents as JSON
+.SH DESCRIPTION
+usage: bsondump [options] <bson filename>
+options:
+.TP
+\fB\-\-help\fR
+produce help message
+.TP
+\fB\-v\fR [ \fB\-\-verbose\fR ]
+be more verbose (include multiple times for more
+verbosity e.g. \fB\-vvvvv\fR)
+.TP
+\fB\-\-objcheck\fR
+validate object before inserting
+.TP
+\fB\-\-filter\fR arg
+filter to apply before inserting
+.TP
+\fB\-\-type\fR arg (=json)
+type of output: json,debug
+.SH "COPYRIGHT"
+.PP
+Copyright 2011 10gen
+.SH "SEE ALSO"
+For more information, please refer to the MongoDB wiki, available at
+http://www.mongodb.org.
View
24 debian/mongo.1
@@ -1,4 +1,3 @@
-.\" Documentation for the MongoDB shell
.TH MONGO "1" "June 2009" "10gen" "Mongo Database"
.SH "NAME"
mongo \- the Mongo command\-line tool
@@ -48,14 +47,29 @@ do not connect to mongod
.B \-\-eval SCRIPT
evaluate JavaScript
.TP
-.B \-u USERNAME
+.B \-\-shell
+run the shell after executing files
+.TP
+.B \-\-quiet
+be less chatty
+.TP
+.B \-\-version
+show version information
+.TP
+.B \-\-verbose
+increase verbosity
+.TP
+.B \-\-ipv6
+enable IPv6 support (disabled by default)
+.TP
+.B \-u|\-\-username USERNAME
specify user to log in as
.TP
-.B \-pPASSWORD
-specify password of user (notice there is no space)
+.B \-p|\-\-password PASSWORD
+specify password of user
.SH "COPYRIGHT"
.PP
-Copyright 2007\-2009 10gen
+Copyright 2007\-2011 10gen
.SH "SEE ALSO"
For more information, please refer to the MongoDB wiki, available at http://www.mongodb.org.
.SH "AUTHOR"
View
31 debian/mongodump.1
@@ -1,4 +1,3 @@
-.\" Documentation for the MongoDB dump tool
.TH MONGODUMP "1" "June 2009" "10gen" "Mongo Database"
.SH "NAME"
mongodump \- the Mongo dump tool
@@ -16,20 +15,44 @@ show usage information
.B \-h, \-\-host HOST
server to connect to (default HOST=localhost)
.TP
+.B\-\-port arg
+server port. Can also use \-\-host hostname:port
+.TP
+.B \-\-ipv6
+enable IPv6 support (disabled by default)
+.TP
+.B \-u|\-\-username USERNAME
+specify user to log in as
+.TP
+.B \-p|\-\-password PASSWORD
+specify password of user (notice there is no space)
+.TP
.B \-d, \-\-db DATABASE
database to use
.TP
.B \-c, \-\-c COLLECTION
collection to use
.TP
-.B \-o, \-\-out FILE
-output file, if not specified, stdout is used
+.B \-o, \-\-out DIRECTORY
+output directory or - for stdout.
.TP
.B \-\-dbpath PATH
directly access mongod data files in this path, instead of connecting to a mongod instance
+.TP
+.B \-\-directoryperdb
+if dbpath specified, each db is in a separate directory
+.TP
+.B \-\-query
+JSON query filter
+.TP
+.B \-\-oplog
+Use oplog for point-in-time snapshotting
+.TP
+.B \-\-repair
+try to recover a crashed database (needs \-\-dbpath)
.SH "COPYRIGHT"
.PP
-Copyright 2007\-2009 10gen
+Copyright 2007\-2011 10gen
.SH "SEE ALSO"
For more information, please refer to the MongoDB wiki, available at http://www.mongodb.org.
.SH "AUTHOR"
View
37 debian/mongoexport.1
@@ -1,4 +1,3 @@
-.\" Documentation for the MongoDB shell
.TH MONGOEXPORT "1" "June 2009" "10gen" "Mongo Database"
.SH "NAME"
mongoexport \- the Mongo export tool
@@ -19,32 +18,54 @@ export documents from test.test1 in CSV format
.B \-\-help
show usage information
.TP
+.B \-v, \-\-verbose
+be more verbose (include multiple times for more verbosity
+e.g. \-vvvvv)
+.TP
.B \-h, \-\-host HOST
server to connect to (default HOST=localhost)
.TP
+.B\-\-port arg
+server port. Can also use \-\-host hostname:port
+.TP
+.B \-\-ipv6
+enable IPv6 support (disabled by default)
+.TP
+.B \-u|\-\-username USERNAME
+specify user to log in as
+.TP
+.B \-p|\-\-password PASSWORD
+specify password of user
+.TP
+.B \-\-dbpath PATH
+directly access mongod data files in this path, instead of connecting to a mongod instance
+.TP
+.B \-\-directoryperdb
+if dbpath specified, each db is in a separate directory
+.TP
.B \-d, \-\-db DATABASE
database to use
.TP
.B \-c, \-\-c COLLECTION
collection to use
.TP
-.B \-q, \-\-query QUERY
-query filter
-.TP
.B \-f, \-\-fields FIELDS
comma\-separated list of field names
.TP
+.B \-\-fieldFile FILE
+file with fields names \- 1 per line
+.TP
+.B \-\-query
+JSON query filter
+.TP
.B \-\-csv
export to CSV instead of JSON
.TP
.B \-o, \-\-out FILE
output file, if not specified, stdout is used
-.TP
-.B \-\-dbpath PATH
-directly access mongod data files in this path, instead of connecting to a mongod instance
.SH "COPYRIGHT"
.PP
-Copyright 2007\-2009 10gen
+Copyright 2007\-2011 10gen
.SH "SEE ALSO"
For more information, please refer to the MongoDB wiki, available at http://www.mongodb.org.
.SH "AUTHOR"
View
71 debian/mongofiles.1
@@ -1,13 +1,32 @@
-.\" Documentation for the MongoDB dump tool
.TH MONGOFILES "1" "June 2009" "10gen" "Mongo Database"
.SH "NAME"
mongofiles \- a simple GridFS interface
.SH "SYNOPSIS"
-\fBmongofiles [\fIOPTIONS\fR]\fR
+\fBmongofiles [\fIOPTIONS\fR] \fICOMMAND\fR \fIFILENAME\fR\fR
.SH "DESCRIPTION"
.PP
\fBmongofiles\fR
is used to list, get, and insert files in the database.
+.TP
+Commands:
+.TP
+.B list
+list all files. FILENAME is an optional prefix which listed filenames
+must begin with.
+.TP
+.B search
+search all files. FILENAME is a substring which listed
+filenames must contain.
+.TP
+.B put
+add a file with filename FILENAME
+.TP
+.B get
+get a file with filename FILENAME
+.TP
+.B delete
+delete all files with filename FILENAME
+
.SH "EXAMPLES"
.TP
.B mongofiles list
@@ -23,29 +42,49 @@ retrieves photo.jpg from test.fs.files and saves it locally
.B \-\-help
show usage information
.TP
+.B \-v, \-\-verbose
+be more verbose (include multiple times for more verbosity
+e.g. \-vvvvv)
+.TP
.B \-h, \-\-host HOST
-mongo host to which to connect
+server to connect to (default HOST=localhost)
.TP
-.B \-d, \-\-db DB
-database to use (default DB=test)
+.B\-\-port arg
+server port. Can also use \-\-host hostname:port
.TP
-.B \-c, \-\-collection COLLECTION (default COLLECTION=fs.files)
-collection to use
+.B \-\-ipv6
+enable IPv6 support (disabled by default)
.TP
-.B \-\-command [list\||\|search\||\|put\||\|get]
-execute a command
+.B \-u|\-\-username USERNAME
+specify user to log in as
.TP
-.B \-\-file FILE
-filename for get or put
+.B \-p|\-\-password PASSWORD
+specify password of user
.TP
-.B list
-list all files. takes an optional filename. the file has to start with the filename
+.B \-\-dbpath PATH
+directly access mongod data files in this path, instead of connecting to a mongod instance
.TP
-.B search
-search all files for something that contains the string
+.B \-\-directoryperdb
+if dbpath specified, each db is in a separate directory
+.TP
+.B \-d, \-\-db DATABASE
+database to use
+.TP
+.B \-c, \-\-c COLLECTION
+collection to use (some commands, default COLLECTION=fs.files)
+.TP
+.B \-l, \-\-local FILENAME
+local filename for put|get (default is to use the same name as the
+FILENAME)
+.TP
+.B \-t, \-\-type arg
+MIME type for put (default is to omit)
+.TP
+.B \-r, \-\-replace
+Remove other files with the same name after PUT
.SH "COPYRIGHT"
.PP
-Copyright 2007\-2009 10gen
+Copyright 2007\-2011 10gen
.SH "SEE ALSO"
For more information, please refer to the MongoDB wiki, available at http://www.mongodb.org.
.SH "AUTHOR"
View
56 debian/mongoimport.1
@@ -1,4 +1,3 @@
-.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1.
.TH MONGOIMPORT "1" "January 2010" "10gen" "Mongo Database"
.SH "NAME"
mongoimport \- the Mongo import tool
@@ -12,30 +11,44 @@ is a tool to import a MongoDB collection from JSON, CSV, or TSV. The query can b
.\".TP
.\".B mongoimport -d test -c test1 --csv -f "name,num"
.\"import documents from test.test1 in CSV format
-.SS "OPTIONS"
+.SH "OPTIONS"
.TP
-\fB\-\-help\fR
+.B \-\-help
show usage information
.TP
+.B \-v, \-\-verbose
+be more verbose (include multiple times for more verbosity
+e.g. \-vvvvv)
+.TP
.B \-h, \-\-host HOST
server to connect to (default HOST=localhost)
.TP
-.B \-d, \-\-db DATABASE
-database to use
+.B\-\-port arg
+server port. Can also use \-\-host hostname:port
.TP
-.B \-c, \-\-c COLLECTION
-collection to use (some commands)
+.B \-\-ipv6
+enable IPv6 support (disabled by default)
+.TP
+.B \-u|\-\-username USERNAME
+specify user to log in as
+.TP
+.B \-p|\-\-password PASSWORD
+specify password of user
.TP
.B \-\-dbpath PATH
-directly access mongod data files in this path,
-instead of connecting to a mongod instance
+directly access mongod data files in this path, instead of connecting to a mongod instance
.TP
-.B \-v, \-\-verbose
-be more verbose (include multiple times for more
-verbosity e.g. \fB\-vvvvv\fR)
+.B \-\-directoryperdb
+if dbpath specified, each db is in a separate directory
.TP
-.B \-f, \-\-fields NAMES
-comma seperated list of field names e.g. \fB\-f\fR name,age
+.B \-d, \-\-db DATABASE
+database to use
+.TP
+.B \-c, \-\-c COLLECTION
+collection to use
+.TP
+.B \-f, \-\-fields FIELDS
+comma\-separated list of field names
.TP
.B \-\-fieldFile FILE
file with fields names \- 1 per line
@@ -54,9 +67,22 @@ drop collection first
.TP
.B \-\-headerline
CSV,TSV only \- use first line as headers
+.TP
+.B \-\-upsert
+insert or update objects that already exist
+.TP
+.B \-\-upsertFields ARG
+comma-separated fields for the query part of the upsert. You should
+make sure this is indexed
+.TP
+.B \-\-stopOnError
+stop importing at first error rather than continuing
+.TP
+.B \-\-jsonArray
+load a json array, not one item per line. Currently limited to 4MB.
.SH "COPYRIGHT"
.PP
-Copyright 2007\-2009 10gen
+Copyright 2007\-2011 10gen
.SH "SEE ALSO"
For more information, please refer to the MongoDB wiki, available at http://www.mongodb.org.
.SH "AUTHOR"
View
33 debian/mongorestore.1
@@ -1,4 +1,3 @@
-.\" Documentation for the MongoDB dump tool
.TH MONGORESTORE "1" "June 2009" "10gen" "Mongo Database"
.SH "NAME"
mongorestore \- the Mongo restoration tool
@@ -16,20 +15,44 @@ show usage information
.B \-h, \-\-host HOST
server to connect to (default HOST=localhost)
.TP
+.B\-\-port arg
+server port. Can also use \-\-host hostname:port
+.TP
+.B \-\-ipv6
+enable IPv6 support (disabled by default)
+.TP
+.B \-u|\-\-username USERNAME
+specify user to log in as
+.TP
+.B \-p|\-\-password PASSWORD
+specify password of user (notice there is no space)
+.TP
.B \-d, \-\-db DATABASE
database to use
.TP
.B \-c, \-\-c COLLECTION
collection to use
.TP
-.B \-\-dir PATH
-directory from which to restore
-.TP
.B \-\-dbpath PATH
directly access mongod data files in this path, instead of connecting to a mongod instance
+.TP
+.B \-\-directoryperdb
+if dbpath specified, each db is in a separate directory
+.TP
+.B \-\-objcheck
+validate object before inserting
+.TP
+.B \-\-filter arg
+filter to apply before inserting
+.TP
+.B \-\-drop
+drop each collection before import
+.TP
+.B \-\-oplogReplay
+replay oplog for point-in-time restore
.SH "COPYRIGHT"
.PP
-Copyright 2007\-2009 10gen
+Copyright 2007\-2011 10gen
.SH "SEE ALSO"
For more information, please refer to the MongoDB wiki, available at http://www.mongodb.org.
.SH "AUTHOR"
View
69 debian/mongos.1
@@ -1,4 +1,3 @@
-.\" Documentation for the MongoDB dump tool
.TH MONGOS "1" "June 2009" "10gen" "Mongo Database"
.SH "NAME"
mongos \- the Mongo sharding server
@@ -22,18 +21,70 @@ starts three servers to set up sharding
.B \-\-help
show usage information
.TP
-.B \-\-port N
-port on which to listen
+.B \-h, \-\-help
+show this usage information
.TP
-.B \-\-configdb DATABASE+
-one or more databases to use as the configuration databases
+.B \-\-version
+show version information
.TP
-.B \-v+
-verbosity
+.B \-f, \-\-config arg
+configuration file specifying additional options
+.TP
+.B \-v, \-\-verbose
+be more verbose (include multiple times for more verbosity
+e.g. -vvvvv)
+.TP
+.B \-\-quiet quieter output
+.TP
+.B \-\-port arg specify port number
+.TP
+.B \-\-bind_ip arg
+comma separated list of ip addresses to listen on - all local ips by
+default
+.TP
+.B \-\-logpath arg
+log file to send write to instead of stdout - has to be a file, not
+directory
+.TP
+.B \-\-logappend
+append to logpath instead of over-writing
+.TP
+.B \-\-pidfilepath arg
+full path to pidfile (if not set, no pidfile is created)
+.TP
+.B \-\-keyFile arg
+private key for cluster authentication (only for replica sets)
+.TP
+.B \-\-unixSocketPrefix arg
+alternative directory for UNIX domain sockets (defaults to /tmp)
+.TP
+.B \-\-fork
+fork server process
+
+.SH "SHARDING OPTIONS"
+.TP
+.B \-\-configdb arg
+1 or 3 comma separated config servers
+.TP
+.B \-\-test
+just run unit tests
+.TP
+.B \-\-upgrade
+upgrade meta data version
+.TP
+.B \-\-chunkSize arg
+maximum amount of data per chunk
+.TP
+.B \-\-ipv6
+enable IPv6 support (disabled by default)
+.TP
+.B \-\-jsonp
+allow JSONP access via http (has security implications)
.SH "COPYRIGHT"
.PP
-Copyright 2007\-2009 10gen
+Copyright 2007\-2011 10gen
.SH "SEE ALSO"
-For more information, please refer to the MongoDB wiki, available at http://www.mongodb.org.
+For more information, please refer to the MongoDB wiki, available at
+http://www.mongodb.org.
.SH "AUTHOR"
Kristina Chodorow
View
5 debian/mongosniff.1
@@ -21,9 +21,12 @@ print a short help message.
.TP
.B <port0>
These parameters are used to filter sniffing. By default, only port 27017 is sniffed.
+.TP
+.B \-\-help
+show usage information
.SH "COPYRIGHT"
.PP
-Copyright 2007\-2009 10gen
+Copyright 2007\-2011 10gen
.SH "SEE ALSO"
For more information, please refer to the MongoDB wiki, available at http://www.mongodb.org.
.SH "AUTHOR"
View
112 debian/mongostat.1
@@ -1,39 +1,111 @@
-.\" Documentation for the MongoDB shell
.TH MONGOSTAT "1" "March 2010" "10gen" "Mongo Database"
.SH "NAME"
mongostat \- view statistics on a running mongod instance
.SH "SYNOPSIS"
-\fBmongostat [\fIOPTIONS\fR]
+\fBmongostat [\fIOPTIONS\fR] [\fISLEEP TIME\fR]
.SH "DESCRIPTION"
.PP
\fBmongostat\fR
-prints statistics on a running mongod instance.
+prints statistics on a running mongod instance. [\fISLEEP TIME\fR] is
+time to wait (in seconds) between calls to servers
.SH "OPTIONS"
.TP
-.B \-\-help
-show usage information
+.B \-\-help
+produce help message
.TP
-.B \-h, \-\-host HOST
-mongo host to connect to (use "left,right" for pairs)
-\" .TP
-\" .B \-\-port PORT
-\" port to connect to (default PORT=27017)
+.B \-v, \-\-verbose
+be more verbose (include multiple times for more verbosity
+e.g. \-vvvvv)
.TP
-.B \-d, \-\-db ARG
-db to use
+.B \-h, \-\-host arg
+mongo host to connect to ( <set name>/s1,s2 for sets)
.TP
-.B \-c, \-\-collection ARG
-collection to use (some commands)
+.B \-\-port arg
+server port. Can also use \-\-host hostname:port
.TP
-.B \-u, \-\-username USERNAME
-specify user to log in as
+.B \-\-ipv6
+enable IPv6 support (disabled by default)
.TP
-.B \-p, \-\-password PASSWORD
-specify password of user (notice there is no space)
+.B \-u, \-\-username arg
+username
+.TP
+.B \-p, \-\-password arg
+password
+.TP
+.B \-\-noheaders
+don't output column names
+.TP
+.B \-n, \-\-rowcount arg
+number of stats lines to print (0 for indefinite)
+.TP
+.B \-\-http
+use http instead of raw db connection
+.TP
+.B \-\-discover
+discover nodes and display stats for all
+.TP
+.B \-\-all
+all optional fields
+.SH "FIELDS"
+.TP
+.B inserts
+# of inserts per second
+.TP
+.B query
+# of queries per second
+.TP
+.B update
+# of updates per second
+.TP
+.B delete
+# of deletes per second
+.TP
+.B getmore
+# of get mores (cursor batch) per second
+.TP
+.B command
+# of commands per second
+.TP
+.B flushes
+# of fsync flushes per second
+.TP
+.B mapped
+amount of data mmaped (total data size) megabytes
+.TP
+.B visze
+virtual size of process in megabytes
+.TP
+.B res
+resident size of process in megabytes
+.TP
+.B faults
+# of pages faults per sec (linux only)
+.TP
+.B locked
+percent of time in global write lock
+.TP
+.B idx
+percent of btree page misses (sampled)
+.TP
+.B qr
+queue lengths for clients waiting (read|write)
+.TP
+.B ar
+active clients (read|write)
+.TP
+.B netIn
+network traffic in - bits
+.TP
+.B netOut
+network traffic out - bits
+.TP
+.B conn
+number of open connections
.SH "COPYRIGHT"
.PP
-Copyright 2010 10gen
+Copyright 2011 10gen
.SH "SEE ALSO"
-For more information, please refer to the MongoDB wiki, available at http://www.mongodb.org.
+For more information, please refer to the MongoDB wiki, available at
+http://www.mongodb.org.
.SH "AUTHOR"
Eliot Horowitz
Please sign in to comment.
Something went wrong with that request. Please try again.