setup-ds.pl.8 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. .\" Hey, EMACS: -*- nroff -*-
  2. .\" First parameter, NAME, should be all caps
  3. .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
  4. .\" other parameters are allowed: see man(7), man(1)
  5. .TH SETUP-DS.PL 8 "May 18, 2008"
  6. .\" Please adjust this date whenever revising the manpage.
  7. .\"
  8. .\" Some roff macros, for reference:
  9. .\" .nh disable hyphenation
  10. .\" .hy enable hyphenation
  11. .\" .ad l left justify
  12. .\" .ad b justify to both left and right margins
  13. .\" .nf disable filling
  14. .\" .fi enable filling
  15. .\" .br insert line break
  16. .\" .sp <n> insert n+1 empty lines
  17. .\" for manpage-specific macros, see man(7)
  18. .SH NAME
  19. setup\-ds.pl \- Set up an instance of Directory Server
  20. .SH SYNOPSIS
  21. .B setup-ds.pl
  22. [\fI--options\fR] \fI-- \fR[\fIargs\fR]
  23. .SH DESCRIPTION
  24. Set up a Directory Server instance. Creates the configuration
  25. files for an instance of Directory Server based on a few parameters
  26. like the hostname, port number, and directory manager information.
  27. Can be run in interactive mode with different levels of verbosity, or
  28. in silent mode with parameters supplied in a .inf format file or
  29. on the command line.
  30. .PP
  31. .\" TeX users may be more comfortable with the \fB<whatever>\fP and
  32. .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
  33. .\" respectively.
  34. .SH OPTIONS
  35. A summary of options is included below:
  36. .TP
  37. .B \fB\-\-help\fR
  38. This message
  39. .TP
  40. .B \fB\-\-version\fR
  41. Print the version and exit
  42. .TP
  43. .B \fB\-\-debug\fR
  44. Turn on debugging
  45. .TP
  46. .B \fB\-\-silent\fR
  47. Use silent setup \- no user input
  48. .TP
  49. .B \fB\-\-file\fR=\fIname\fR
  50. Use the file 'name' in .inf format to supply the default answers
  51. .TP
  52. .B \fB\-\-keepcache\fR
  53. Do not delete the temporary .inf file generated by this program
  54. .TP
  55. .B \fB\-\-logfile\fR
  56. Log setup messages to this file \- otherwise, a temp file will be used
  57. .PP
  58. For all options, you can also use the short name e.g. \fB\-h\fR, \fB\-d\fR, etc. For the \fB\-d\fR argument,
  59. specifying it more than once will increase the debug level e.g. \fB\-ddddd\fR
  60. .PP
  61. args:
  62. You can supply default .inf data in this format:
  63. .IP
  64. section.param=value
  65. .PP
  66. e.g.
  67. .IP
  68. General.FullMachineName=foo.example.com
  69. .PP
  70. or
  71. .IP
  72. "slapd.Suffix=dc=example, dc=com"
  73. .PP
  74. Values passed in this manner will override values in an .inf file given with the \fB\-f\fR argument.
  75. .br
  76. .SH AUTHOR
  77. setup-ds.pl was written by the Fedora Directory Server Project.
  78. .SH "REPORTING BUGS"
  79. Report bugs to http://bugzilla.redhat.com.
  80. .SH COPYRIGHT
  81. Copyright \(co 2008 Red Hat, Inc.
  82. .br
  83. This manual page was written by Michele Baldessari <[email protected]>,
  84. for the Debian project (but may be used by others).
  85. .br
  86. This is free software. You may redistribute copies of it under the terms of
  87. the Directory Server license found in the LICENSE file of this
  88. software distribution. This license is essentially the GNU General Public
  89. License version 2 with an exception for plug-in distribution.