upgradednformat.8 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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 UPGRADEDNFORMAT 8 "Mar 5, 2013"
  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. upgradednformat - Directory Server script for upgrading the DN format
  20. .SH SYNOPSIS
  21. upgradednformat \-n backendname \-a database_directory [\-Z serverID] [\-N] [\-h]
  22. .SH DESCRIPTION
  23. Updates older-style DN syntaxes to RFC 4514-style DN syntaxes for migrated databases. This is usually needed after migrating from an older version of Directory Server. This script must be run while the server is stopped.
  24. .SH OPTIONS
  25. A summary of options is included below:
  26. .TP
  27. .B \fB\-n\fR \fIBackend Name\fR
  28. The name of the LDBM database to reindex. Example: userRoot
  29. .TP
  30. .B \fB\-a\fR \fIDatabase directory\fR
  31. The full path to the database directory.
  32. .TP
  33. .B \fB\-Z\fR \fIServer Identifier\fR
  34. The server ID of the Directory Server instance. If there is only
  35. one instance on the system, this option can be skipped.
  36. .TP
  37. .B \fB\-N\fR
  38. Only checks whether any DNs in the database need to be updated.
  39. .TP
  40. .B \fB\-h\fR
  41. .br
  42. Display the usage.
  43. .SH EXAMPLE
  44. .TP
  45. upgradednformat \-n userRoot \-a /var/lib/dirsrv/slapd-instance2/db \-Z instance2
  46. .SH DIAGNOSTICS
  47. Exit status is zero if no errors occur. Errors result in a
  48. non-zero exit status and a diagnostic message being written
  49. to standard error.
  50. .SH AUTHOR
  51. upgradednformat was written by the 389 Project.
  52. .SH "REPORTING BUGS"
  53. Report bugs to https://fedorahosted.org/389/newticket.
  54. .SH COPYRIGHT
  55. Copyright \(co 2013 Red Hat, Inc.