Permalink
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...
1 parent d3a9fe9 commit 72f549af6331ebee34ae70d97a7f8e52298470d3 @kreuter kreuter committed Mar 17, 2011
Showing with 388 additions and 87 deletions.
  1. +5 −4 buildscripts/packager.py
  2. +28 −0 debian/bsondump.1
  3. +19 −5 debian/mongo.1
  4. +27 −4 debian/mongodump.1
  5. +29 −8 debian/mongoexport.1
  6. +55 −16 debian/mongofiles.1
  7. +41 −15 debian/mongoimport.1
  8. +28 −5 debian/mongorestore.1
  9. +60 −9 debian/mongos.1
  10. +4 −1 debian/mongosniff.1
  11. +92 −20 debian/mongostat.1
View
@@ -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,26 +893,27 @@ 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
%{_bindir}/mongofiles
%{_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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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"
Oops, something went wrong.

0 comments on commit 72f549a

Please sign in to comment.