db2bak.8 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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 DB2BAK 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. db2bak - Directory Server script for making a backup of the database
  20. .SH SYNOPSIS
  21. db2bak [archivedir] [\-Z serverID] [\-q] [\-h]
  22. .SH DESCRIPTION
  23. Creates a backup of the database. This script can be executed while the server is running or stopped.
  24. .SH OPTIONS
  25. A summary of options is included below:
  26. .TP
  27. .B \fBarchivedir\fR
  28. The full path to the directory to store the backup.
  29. .TP
  30. .B \fB\-Z\fR \fIServer Identifier\fR
  31. The server ID of the Directory Server instance. If there is only
  32. one instance on the system, this option can be skipped.
  33. .TP
  34. .B \fB\-q\fR
  35. .br
  36. Quiet mode. Reduces output of task.
  37. .TP
  38. .B \fB\-h\fR
  39. .br
  40. Display the usage.
  41. .SH EXAMPLE
  42. .TP
  43. db2bak \-Z instance2
  44. Makes a backup of the entire database for 'instance2', and stores it in the default server instance backup directory.
  45. .TP
  46. db2bak /LDAP/backups/20130305
  47. Creates a backup of the database and stores it in specified location.
  48. .SH DIAGNOSTICS
  49. Exit status is zero if no errors occur. Errors result in a
  50. non-zero exit status and a diagnostic message being written
  51. to standard error.
  52. .SH AUTHOR
  53. db2bak was written by the 389 Project.
  54. .SH "REPORTING BUGS"
  55. Report bugs to https://fedorahosted.org/389/newticket.
  56. .SH COPYRIGHT
  57. Copyright \(co 2013 Red Hat, Inc.