diff options
author | Matthew Kent <mkent@magoazul.com> | 2009-11-01 23:48:25 -0800 |
---|---|---|
committer | Matthew Kent <mkent@magoazul.com> | 2009-11-03 00:09:50 -0800 |
commit | add11b903f962219796f217e05bbeeef9e37f350 (patch) | |
tree | 4ceacc67404eefb50437d3da23763ac3927adb23 /chef/distro/common/man/man1 | |
parent | 9789b3973be8f3f3c49ac76a31f156d0520f30c7 (diff) | |
download | chef-add11b903f962219796f217e05bbeeef9e37f350.tar.gz |
CHEF-676: Update init scripts after packaging 0.7.14.
Move man pages to a common directory.
Diffstat (limited to 'chef/distro/common/man/man1')
-rw-r--r-- | chef/distro/common/man/man1/chef-indexer.1 | 42 | ||||
-rw-r--r-- | chef/distro/common/man/man1/chef-server.1 | 108 |
2 files changed, 150 insertions, 0 deletions
diff --git a/chef/distro/common/man/man1/chef-indexer.1 b/chef/distro/common/man/man1/chef-indexer.1 new file mode 100644 index 0000000000..e6dea91883 --- /dev/null +++ b/chef/distro/common/man/man1/chef-indexer.1 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. +.TH CHEF-INDEXER: "1" "August 2009" "chef-indexer 0.7.8" "User Commands" +.SH NAME +chef-indexer: \- Runs the search index process. +.SH SYNOPSIS +.B chef-indexer +\fI(options)\fR +.SH DESCRIPTION +.TP +chef-indexer requires that the stompserver be started but at this time the stompserver package does not install a startup script, let alone start the daemon. I am working with the package maintainer for stompserver to include a startup script. +\fB\-c\fR, \fB\-\-config\fR CONFIG +The configuration file to use +.TP +\fB\-d\fR, \fB\-\-daemonize\fR +Daemonize the process +.TP +\fB\-g\fR, \fB\-\-group\fR GROUP +Group to change gid to before daemonizing +.TP +\fB\-l\fR, \fB\-\-log_level\fR LEVEL +Set the log level (debug, info, warn, error, fatal) +.TP +\fB\-L\fR, \fB\-\-logfile\fR LOGLOCATION +Set the log file location, defaults to STDOUT \- recommended for daemonizing +.TP +\fB\-u\fR, \fB\-\-user\fR USER +User to change uid to before daemonizing +.TP +\fB\-v\fR, \fB\-\-version\fR +Show chef version +.TP +\fB\-h\fR, \fB\-\-help\fR +Show this message +.SH "SEE ALSO" +Full documentation for Chef and chef-indexer is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home. +.SH AUTHOR +Chef was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community. +This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man. Permission is granted +to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + +On Debian systems, the complete text of the Apache 2.0 License can be found in +/usr/share/common-licenses/Apache-2.0. diff --git a/chef/distro/common/man/man1/chef-server.1 b/chef/distro/common/man/man1/chef-server.1 new file mode 100644 index 0000000000..fa5eb71d7e --- /dev/null +++ b/chef/distro/common/man/man1/chef-server.1 @@ -0,0 +1,108 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man. +.TH CHEF-SERVER "1" "August 2009" "chef-server" "User Commands" +.SH NAME +chef-server \- Start the Chef Server merb application slice. +.SH SYNOPSIS +.B chef-server +[\fIuGdcIpPhmailLerkKX\fR] [\fIargument\fR] +.SH DESCRIPTION +The Chef Server is a Merb application slice. Both chef-server and chef-server-slice packages should be installed. This man page was generated for merb and generated for chef-server. +The default listen port is 4000. At a minimum, chef-server should be started with \-c2 so one process starts for the webui (4000) and one process starts for openid (4001). +.TP +\fB\-u\fR, \fB\-\-user\fR USER +This flag is for having chef-server run as a user other than the one currently logged in. Note: if you set this you must also provide a \fB\-\-group\fR option for it to take effect. +.TP +\fB\-G\fR, \fB\-\-group\fR GROUP +This flag is for having chef-server run as a group other than the one currently logged in. Note: if you set this you must also provide a \fB\-\-user\fR option for it to take effect. +.TP +\fB\-d\fR, \fB\-\-daemonize\fR +This will run a single chef-server in the background. +.TP +\fB\-N\fR, \fB\-\-no\-daemonize\fR +This will allow you to run a cluster in console mode +.TP +\fB\-c\fR, \fB\-\-cluster\-nodes\fR NUM_MERBS +Number of merb daemons to run for chef-server. At least 2 are required to run, the second is for openid (runs on port 4001). +.TP +\fB\-I\fR, \fB\-\-init\-file\fR FILE +File to use for initialization on load, defaults to config/init.rb +.TP +\fB\-p\fR, \fB\-\-port\fR PORTNUM +Port to run chef-server on, defaults to 4000. Additional nodes (\-c) listen on incrementing port numbers. +.TP +\fB\-o\fR, \fB\-\-socket\-file\fR FILE +Socket file to run chef-server on, defaults to [Merb.root]/log/merb.sock. This is for web servers, like thin, that use sockets.Specify this *only* if you *must*. +.TP +\fB\-s\fR, \fB\-\-socket\fR SOCKNUM +Socket number to run chef-server on, defaults to 0. +.TP +\fB\-n\fR, \fB\-\-name\fR NAME +Set the name of the application. This is used in the process title and log file names. +.TP +\fB\-P\fR, \fB\-\-pid\fR PIDFILE +PID file, defaults to [Merb.root]/log/merb.main.pid for the master process and[Merb.root]/log/merb.[port number].pid for worker processes. For clusters, use %s to specify where in the file chef-server should place the port number. For instance: \fB\-P\fR myapp.%s.pid +.TP +\fB\-h\fR, \fB\-\-host\fR HOSTNAME +Host to bind to (default is 0.0.0.0). +.HP +\fB\-m\fR, \fB\-\-merb\-root\fR /path/to/approot The path to the Merb.root for the app you want to run (default is current working directory). +.TP +\fB\-a\fR, \fB\-\-adapter\fR ADAPTER +The rack adapter to use to run chef-server (default is mongrel)[mongrel, emongrel, thin, ebb, fastcgi, webrick] +.TP +\fB\-R\fR, \fB\-\-rackup\fR FILE +Load an alternate Rack config file (default is config/rack.rb) +.TP +\fB\-i\fR, \fB\-\-irb\-console\fR +This flag will start chef-server in irb console mode. All your models and other classes will be available for you in an irb session. +.TP +\fB\-S\fR, \fB\-\-sandbox\fR +This flag will enable a sandboxed irb console. If your ORM supports transactions, all edits will be rolled back on exit. +.TP +\fB\-l\fR, \fB\-\-log\-level\fR LEVEL +Log levels can be set to any of these options: debug < info < warn < error < fatal (default is info) +.TP +\fB\-L\fR, \fB\-\-log\fR LOGFILE +A string representing the logfile to use. Defaults to [Merb.root]/log/merb.[main].log for the master process and [Merb.root]/log/merb[port number].logfor worker processes +.TP +\fB\-e\fR, \fB\-\-environment\fR STRING +Environment to run Merb under [development, production, testing] (default is development) +.HP +\fB\-r\fR ['RUBY CODE'| FULL_SCRIPT_PATH] +.TP +\fB\-\-script\-runner\fR +Command\-line option to run scripts and/or code in the chef-server app. +.TP +\fB\-K\fR, \fB\-\-graceful\fR PORT or all +Gracefully kill chef-server proceses by port number. Use chef-server \fB\-K\fR all to gracefully kill all merbs. +.TP +\fB\-k\fR, \fB\-\-kill\fR PORT +Force kill one merb worker by port number. This will cause the worker tobe respawned. +.TP +\fB\-\-fast\-deploy\fR +Reload the code, but not yourinit.rb or gems +.TP +\fB\-X\fR, \fB\-\-mutex\fR on/off +This flag is for turning the mutex lock on and off. +.TP +\fB\-D\fR, \fB\-\-debugger\fR +Run chef-server using rDebug. +.TP +\fB\-V\fR, \fB\-\-verbose\fR +Print extra information +.TP +\fB\-C\fR, \fB\-\-console\-trap\fR +Enter an irb console on ^C +.TP +\-?, \fB\-H\fR, \fB\-\-help\fR +Show this help message +.SH "SEE ALSO" +Full documentation for Chef and chef-server is located on the Chef wiki, http://wiki.opscode.com/display/chef/Home. +.SH AUTHOR +Chef was written by Adam Jacob <adam@ospcode.com> of Opscode (http://www.opscode.com), with contributions from the community. +This manual page was written by Joshua Timberman <joshua@opscode.com> with help2man +for the Debian project (but may be used by others).. Permission is granted + to copy, distribute and / or modify this document under the terms of the Apache 2.0 License. + + On Debian systems, the complete text of the Apache 2.0 License can be found in + /usr/share/common-licenses/Apache-2.0. |