Re: man pages
David Nebauer <[email protected]>
| Newsgroups | gmane.text.refdb.devel |
|---|---|
| Message-ID | <[email protected]> |
Hi Markus, Markus Hoenicka wrote: >refdb-backup >and refdb-restore are currently dummies. Would you mind writing these >man pages? I guess you're the one who really knows what these tools >do. > > I've been incommunicado for three weeks and am now catching up. I'd already written the refdb-backup and refdb-restore manpages. They have been, in fact, added to the refdb debian packages I've been building. For your convenience I've attached them to this message. In the next week or so I'll post updated Debian packages. Regards, David.
refdb-backup.1
(text/plain, 2.2 KB)
.\" Hey, EMACS: -*- nroff -*- .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp <n> insert n+1 empty lines .\" for manpage-specific macros, see man(7) .TH "refdb-backup" "1" "February 26, 2005" "David Nebauer" "" .SH "NAME" refdb-backup \- RefDB tool: back up RefDB references, notes and styles .SH "SYNOPSIS" \fBrefdb-backup\fR [\fB-h\fR] [\fB-u\fR \fIuser\fR] [\fB-w\fR \fIpwd\fR] [\fB-f\fR \fIformat\fR] [\fB-d\fR \fIdir\fR] [\fB-s\fR] .SH "DESCRIPTION" RefDB is a free and portable reference and notes database as well as a bibliography application that serves a similar purpose for SGML, XML, and LaTeX documents as \fIReference Manager\fR or \fIEndNote\fR do for word processor documents. .PP refdb-backup is a tool for backing up RefDB references, notes and styles. A gzipped tarfile of the form \(aqrefdb_backup_YYYYMMDD_HHMM.tar.gz\(aq is created. .PP While users can restore data from the backup archive manually, it is expressly designed to restored by the companion tool \fIrefdb-restore\fR. .SH "OPTIONS" .TP \fB-d\fR \fIdir\fR directory in which to place backup file (default: current directory) .TP \fB-f\fR \fIformat\fR references storage format (\(aqris\(aq (default)|\(aqrisx\(aq) .TP \fB-h\fR print help and exit .TP \fB-s\fR silent, no screen feedback .TP \fB-u\fR \fIuser\fR username for RefDB clients (refdba, refdbc) not required if clients are configured for automatic access .TP \fB-w\fR \fIpwd\fR password for RefDB clients (refdba, refdbc) not required if clients are configured for automatic access .SH "SEE ALSO" \fBrefdb-restore\fR (1). .SH "AUTHOR" RefDB was written by Markus Hoenicka <[email protected]>. .PP This manual page was written by David Nebauer <[email protected]> for the Debian project (but may be used by others).
refdb-restore.1
(text/plain, 2.1 KB)
.\" Hey, EMACS: -*- nroff -*- .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation .\" .ad l left justify .\" .ad b justify to both left and right margins .\" .nf disable filling .\" .fi enable filling .\" .br insert line break .\" .sp <n> insert n+1 empty lines .\" for manpage-specific macros, see man(7) .TH "refdb-restore" "1" "February 26, 2005" "David Nebauer" "" .SH "NAME" refdb-restore \- RefDB tool: restore RefDB references, notes and styles .SH "SYNOPSIS" \fBrefdb-restore\fR [\fB-h\fR] [\fB-u\fR \fIuser\fR] [\fB-w\fR \fIpwd\fR] backup-archive .SH "DESCRIPTION" RefDB is a free and portable reference and notes database as well as a bibliography application that serves a similar purpose for SGML, XML, and LaTeX documents as \fIReference Manager\fR or \fIEndNote\fR do for word processor documents. .PP refdb-restore is a tool for restoring RefDB references, notes and styles. The backup archive must have been created by the companion tool \fIrefdb-backup\fR. .PP Before performing the restore all reference databases must be removed (archived) from /var/lib/refdb/db/. The system database in that directory (\(aqrefdb\(aq) must be recreated from the sql dump (see \fIManual\fR). .SH "OPTIONS" .TP \fB-h\fR print help and exit .TP \fB-u\fR \fIuser\fR username for RefDB clients (refdba, refdbc) not required if clients are configured for automatic access .TP \fB-w\fR \fIpwd\fR password for RefDB clients (refdba, refdbc) not required if clients are configured for automatic access .SH "SEE ALSO" \fBrefdb-restore\fR (1). .PP \fIManual\fR </usr/share/doc/refdb/manual/> .br \fITutorial\fR </usr/share/doc/refdb/tutorial/> .SH "AUTHOR" RefDB was written by Markus Hoenicka <[email protected]>. .PP This manual page was written by David Nebauer <[email protected]> for the Debian project (but may be used by others).