man page built with fixed ronn. #22

man/aptly.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "APTLY" "1" "March 2014" "" ""
+.TH "APTLY" "1" "April 2014" "" ""
 .
 .SH "NAME"
 \fBaptly\fR \- Debian repository management tool
@@ -10,7 +10,7 @@
 Common command format:
 .
 .P
-\fBaptly\fR [\fIglobal options\fR\.\.\.] \fIcommand\fR \fIsubcommand\fR [\fIoptions\fR\.\.\.] \fIarguments\fR
+\fBaptly\fR [\fIglobal options\fR\|\.\|\.\|\.] \fIcommand\fR \fIsubcommand\fR [\fIoptions\fR\|\.\|\.\|\.] \fIarguments\fR
 .
 .P
 aptly has integrated help that matches contents of this manual page, to get help, prepend \fBhelp\fR to command name:
@@ -86,11 +86,11 @@ follow dependency from binary package to source package
 .
 .TP
 \fBgpgDisableSign\fR
-don\'t sign published repositories with gpg(1), also can be disabled on per\-repo basis using \fB\-skip\-signing\fR flag when publishing
+don\(cqt sign published repositories with gpg(1), also can be disabled on per\-repo basis using \fB\-skip\-signing\fR flag when publishing
 .
 .TP
 \fBgpgDisableVerify\fR
-don\'t verify remote mirrors with gpg(1), also can be disabled on per\-mirror basis using \fB\-ignore\-signatures\fR flag when creating and updating mirrors
+don\(cqt verify remote mirrors with gpg(1), also can be disabled on per\-mirror basis using \fB\-ignore\-signatures\fR flag when creating and updating mirrors
 .
 .TP
 \fBdownloadSourcePackages\fR
@@ -134,7 +134,7 @@ version and architecture conditions combined\.
 When specified on command line, condition may have to be quoted according to shell rules, so that it stays single argument:
 .
 .P
-\fBaptly repo import percona stable \'mysql\-client (>= 3\.6)\'\fR
+\fBaptly repo import percona stable \(cqmysql\-client (>= 3\.6)\(cq\fR
 .
 .SH "GLOBAL OPTIONS"
 .
@@ -147,12 +147,8 @@ list of architectures to consider during (comma\-separated), default to all avai
 location of configuration file (default locations are /etc/aptly\.conf, ~/\.aptly\.conf)
 .
 .TP
-\-\fBcpuprofile\fR=
-write cpu profile to file
-.
-.TP
 \-\fBdep\-follow\-all\-variants\fR=false
-when processing dependencies, follow a & b if depdency is \'a|b\'
+when processing dependencies, follow a & b if depdency is \(cqa|b\(cq
 .
 .TP
 \-\fBdep\-follow\-recommends\fR=false
@@ -166,20 +162,8 @@ when processing dependencies, follow from binary to Source packages
 \-\fBdep\-follow\-suggests\fR=false
 when processing dependencies, follow Suggests
 .
-.TP
-\-\fBmeminterval\fR=100ms
-memory stats dump interval
-.
-.TP
-\-\fBmemprofile\fR=
-write memory profile to this file
-.
-.TP
-\-\fBmemstats\fR=
-write memory stats periodically to this file
-.
 .SH "CREATE NEW MIRROR"
-\fBaptly\fR \fBmirror\fR \fBcreate\fR \fIname\fR \fIarchive url\fR \fIdistribution\fR [\fIcomponent1\fR \.\.\.]
+\fBaptly\fR \fBmirror\fR \fBcreate\fR \fIname\fR \fIarchive url\fR \fIdistribution\fR [\fIcomponent1\fR \|\.\|\.\|\.]
 .
 .P
 Creates mirror \fIname\fR of remote repository, aptly supports both regular and flat Debian repositories exported via HTTP\. aptly would try download Release file from remote repository and verify its signature\.
@@ -308,7 +292,7 @@ Options:
 remove files that have been imported successfully into repository
 .
 .SH "COPY PACKAGES BETWEEN LOCAL REPOSITORIES"
-\fBaptly\fR \fBrepo\fR \fBcopy\fR \fIsrc\-name\fR \fIdst\-name\fR \fIpackage\-spec\fR \fB\.\.\.\fR
+\fBaptly\fR \fBrepo\fR \fBcopy\fR \fIsrc\-name\fR \fIdst\-name\fR \fIpackage\-spec\fR \fB\|\.\|\.\|\.\fR
 .
 .P
 Command copy copies packages matching \fIpackage\-spec\fR from local repo \fIsrc\-name\fR to local repo \fIdst\-name\fR\.
@@ -317,14 +301,14 @@ Command copy copies packages matching \fIpackage\-spec\fR from local repo \fIsrc
 Example:
 .
 .P
-$ aptly repo copy testing stable \'myapp (=0\.1\.12)\'
+$ aptly repo copy testing stable \(cqmyapp (=0\.1\.12)\(cq
 .
 .P
 Options:
 .
 .TP
 \-\fBdry\-run\fR=false
-don\'t copy, just show what would be copied
+don\(cqt copy, just show what would be copied
 .
 .TP
 \-\fBwith\-deps\fR=false
@@ -349,6 +333,14 @@ Options:
 \-\fBcomment\fR=
 any text that would be used to described local repository
 .
+.TP
+\-\fBcomponent\fR=main
+default component when publishing
+.
+.TP
+\-\fBdistribution\fR=
+default distribution when publishing
+.
 .SH "DELETE LOCAL REPOSITORY"
 \fBaptly\fR \fBrepo\fR \fBdrop\fR \fIname\fR
 .
@@ -368,8 +360,35 @@ Options:
 \-\fBforce\fR=false
 force local repo deletion even if used by snapshots
 .
+.SH "EDIT PROPERTIES OF LOCAL REPOSITORY"
+\fBaptly\fR \fBrepo\fR \fBedit\fR \fIname\fR
+.
+.P
+Command edit allows to change metadata of local repository: comment, default distribution and component\.
+.
+.P
+Example:
+.
+.P
+$ aptly repo edit \-distribution=wheezy testing
+.
+.P
+Options:
+.
+.TP
+\-\fBcomment\fR=
+any text that would be used to described local repository
+.
+.TP
+\-\fBcomponent\fR=
+default component when publishing
+.
+.TP
+\-\fBdistribution\fR=
+default distribution when publishing
+.
 .SH "IMPORT PACKAGES FROM MIRROR TO LOCAL REPOSITORY"
-\fBaptly\fR \fBrepo\fR \fBimport\fR \fIsrc\-mirror\fR \fIdst\-repo\fR \fIpackage\-spec\fR \fB\.\.\.\fR
+\fBaptly\fR \fBrepo\fR \fBimport\fR \fIsrc\-mirror\fR \fIdst\-repo\fR \fIpackage\-spec\fR \fB\|\.\|\.\|\.\fR
 .
 .P
 Command import looks up packages matching \fIpackage\-spec\fR in mirror \fIsrc\-mirror\fR and copies them to local repo \fIdst\-repo\fR\.
@@ -385,7 +404,7 @@ Options:
 .
 .TP
 \-\fBdry\-run\fR=false
-don\'t import, just show what would be imported
+don\(cqt import, just show what would be imported
 .
 .TP
 \-\fBwith\-deps\fR=false
@@ -404,7 +423,7 @@ Example:
 $ aptly repo list
 .
 .SH "MOVE PACKAGES BETWEEN LOCAL REPOSITORIES"
-\fBaptly\fR \fBrepo\fR \fBmove\fR \fIsrc\-name\fR \fIdst\-name\fR \fIpackage\-spec\fR \fB\.\.\.\fR
+\fBaptly\fR \fBrepo\fR \fBmove\fR \fIsrc\-name\fR \fIdst\-name\fR \fIpackage\-spec\fR \fB\|\.\|\.\|\.\fR
 .
 .P
 Command move moves packages matching \fIpackage\-spec\fR from local repo \fIsrc\-name\fR to local repo \fIdst\-name\fR\.
@@ -413,37 +432,37 @@ Command move moves packages matching \fIpackage\-spec\fR from local repo \fIsrc\
 Example:
 .
 .P
-$ aptly repo move testing stable \'myapp (=0\.1\.12)\'
+$ aptly repo move testing stable \(cqmyapp (=0\.1\.12)\(cq
 .
 .P
 Options:
 .
 .TP
 \-\fBdry\-run\fR=false
-don\'t move, just show what would be moved
+don\(cqt move, just show what would be moved
 .
 .TP
 \-\fBwith\-deps\fR=false
 follow dependencies when processing package\-spec
 .
 .SH "REMOVE PACKAGES FROM LOCAL REPOSITORY"
-\fBaptly\fR \fBrepo\fR \fBremove\fR \fIname\fR \fIpackage\-spec\fR \fB\.\.\.\fR
+\fBaptly\fR \fBrepo\fR \fBremove\fR \fIname\fR \fIpackage\-spec\fR \fB\|\.\|\.\|\.\fR
 .
 .P
-Commands removes packages matching \fIpackage\-spec\fR from local repository \fIname\fR\. If removed packages are not referenced by other repos or snapshots, they can be removed completely (including files) by running \'aptly db cleanup\'\.
+Commands removes packages matching \fIpackage\-spec\fR from local repository \fIname\fR\. If removed packages are not referenced by other repos or snapshots, they can be removed completely (including files) by running \(cqaptly db cleanup\(cq\.
 .
 .P
 Example:
 .
 .P
-$ aptly repo remove testing \'myapp (=0\.1\.12)\'
+$ aptly repo remove testing \(cqmyapp (=0\.1\.12)\(cq
 .
 .P
 Options:
 .
 .TP
 \-\fBdry\-run\fR=false
-don\'t remove, just show what would be removed
+don\(cqt remove, just show what would be removed
 .
 .SH "SHOW DETAILS ABOUT LOCAL REPOSITORY"
 \fBaptly\fR \fBrepo\fR \fBshow\fR \fIname\fR
@@ -518,7 +537,7 @@ Options:
 show list of packages
 .
 .SH "VERIFY DEPENDENCIES IN SNAPSHOT"
-\fBaptly\fR \fBsnapshot\fR \fBverify\fR \fIname\fR [\fIsource\fR \.\.\.]
+\fBaptly\fR \fBsnapshot\fR \fBverify\fR \fIname\fR [\fIsource\fR \|\.\|\.\|\.]
 .
 .P
 Verify does depenency resolution in snapshot \fIname\fR, possibly using additional snapshots \fIsource\fR as dependency sources\. All unsatisfied dependencies are printed\.
@@ -537,10 +556,10 @@ $ aptly snapshot verify wheezy\-main wheezy\-contrib wheezy\-non\-free
 .IP "" 0
 .
 .SH "PULL PACKAGES FROM ANOTHER SNAPSHOT"
-\fBaptly\fR \fBsnapshot\fR \fBpull\fR \fIname\fR \fIsource\fR \fIdestination\fR \fIpackage\-name\fR \fB\.\.\.\fR
+\fBaptly\fR \fBsnapshot\fR \fBpull\fR \fIname\fR \fIsource\fR \fIdestination\fR \fIpackage\-name\fR \fB\|\.\|\.\|\.\fR
 .
 .P
-Command pull pulls new packages along with its dependencies to snapshot \fIname\fR from snapshot \fIsource\fR\. Pull can upgrade package version in \fIname\fR with versions from \fIsource\fR following dependencies\. New snapshot \fIdestination\fR is created as result of this process\. Packages could be specified simply as \'package\-name\' or as dependency \'package\-name (>= version)\'\.
+Command pull pulls new packages along with its dependencies to snapshot \fIname\fR from snapshot \fIsource\fR\. Pull can upgrade package version in \fIname\fR with versions from \fIsource\fR following dependencies\. New snapshot \fIdestination\fR is created as result of this process\. Packages could be specified simply as \(cqpackage\-name\(cq or as dependency \(cqpackage\-name (>= version)\(cq\.
 .
 .P
 Example:
@@ -560,15 +579,15 @@ Options:
 .
 .TP
 \-\fBdry\-run\fR=false
-don\'t create destination snapshot, just show what would be pulled
+don\(cqt create destination snapshot, just show what would be pulled
 .
 .TP
 \-\fBno\-deps\fR=false
-don\'t process dependencies, just pull listed packages
+don\(cqt process dependencies, just pull listed packages
 .
 .TP
 \-\fBno\-remove\fR=false
-don\'t remove other package versions when pulling package
+don\(cqt remove other package versions when pulling package
 .
 .SH "DIFFERENCE BETWEEN TWO SNAPSHOTS"
 \fBaptly\fR \fBsnapshot\fR \fBdiff\fR \fIname\-a\fR \fIname\-b\fR
@@ -594,10 +613,10 @@ Options:
 .
 .TP
 \-\fBonly\-matching\fR=false
-display diff only for matching packages (don\'t display missing packages)
+display diff only for matching packages (don\(cqt display missing packages)
 .
 .SH "MERGES SNAPSHOTS"
-\fBaptly\fR \fBsnapshot\fR \fBmerge\fR \fIdestination\fR \fIsource\fR [\fIsource\fR\.\.\.]
+\fBaptly\fR \fBsnapshot\fR \fBmerge\fR \fIdestination\fR \fIsource\fR [\fIsource\fR\|\.\|\.\|\.]
 .
 .P
 Merge merges several \fIsource\fR snapshots into one \fIdestination\fR snapshot\. Merge happens from left to right\. Packages with the same name\-architecture pair are replaced during merge (package from latest snapshot on the list wins)\. If run with only one source snapshot, merge copies \fIsource\fR into \fIdestination\fR\.
@@ -619,7 +638,7 @@ $ aptly snapshot merge wheezy\-w\-backports wheezy\-main wheezy\-backports
 \fBaptly\fR \fBsnapshot\fR \fBdrop\fR \fIname\fR
 .
 .P
-Drop removes information about snapshot\. If snapshot is published, it can\'t be dropped\.
+Drop removes information about snapshot\. If snapshot is published, it can\(cqt be dropped\.
 .
 .P
 Example:
@@ -641,11 +660,60 @@ Options:
 \-\fBforce\fR=false
 remove snapshot even if it was used as source for other snapshots
 .
+.SH "PUBLISH LOCAL REPOSITORY"
+\fBaptly\fR \fBpublish\fR \fBrepo\fR \fIname\fR [\fIprefix\fR]
+.
+.P
+Command publishes current state of local repository ready to be consumed by apt tools\. Published repostiories appear under rootDir/public directory\. Valid GPG key is required for publishing\.
+.
+.P
+It is not recommended to publish local repositories directly unless the repository is for testing purposes and changes happen frequently\. For production usage please take snapshot of repository and publish it using publish snapshot command\.
+.
+.P
+Example:
+.
+.IP "" 4
+.
+.nf
+
+$ aptly publish repo testing
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Options:
+.
+.TP
+\-\fBcomponent\fR=
+component name to publish
+.
+.TP
+\-\fBdistribution\fR=
+distribution name to publish
+.
+.TP
+\-\fBgpg\-key\fR=
+GPG key ID to use when signing the release
+.
+.TP
+\-\fBkeyring\fR=
+GPG keyring to use (instead of default)
+.
+.TP
+\-\fBsecret\-keyring\fR=
+GPG secret keyring to use (instead of default)
+.
+.TP
+\-\fBskip\-signing\fR=false
+don\(cqt sign Release files with GPG
+.
 .SH "PUBLISH SNAPSHOT"
 \fBaptly\fR \fBpublish\fR \fBsnapshot\fR \fIname\fR [\fIprefix\fR]
 .
 .P
-Command publish publishes snapshot as Debian repository ready to be consumed by apt tools\. Published repostiories appear under rootDir/public directory\. Valid GPG key is required for publishing\.
+Command publishes snapshot as Debian repository ready to be consumed by apt tools\. Published repostiories appear under rootDir/public directory\. Valid GPG key is required for publishing\.
 .
 .P
 Example:
@@ -685,7 +753,7 @@ GPG secret keyring to use (instead of default)
 .
 .TP
 \-\fBskip\-signing\fR=false
-don\'t sign Release files with GPG
+don\(cqt sign Release files with GPG
 .
 .SH "LIST OF PUBLISHED REPOSITORIES"
 \fBaptly\fR \fBpublish\fR \fBlist\fR
@@ -729,7 +797,7 @@ $ aptly publish drop wheezy
 \fBaptly\fR \fBdb\fR \fBcleanup\fR
 .
 .P
-Database cleanup removes information about unreferenced packages and removes files in the package pool that aren\'t used by packages anymore
+Database cleanup removes information about unreferenced packages and removes files in the package pool that aren\(cqt used by packages anymore
 .
 .P
 Example:
@@ -737,11 +805,23 @@ Example:
 .P
 $ aptly db cleanup
 .
+.SH "RECOVER DB AFTER CRASH"
+\fBaptly\fR \fBdb\fR \fBrecover\fR
+.
+.P
+Database recover does its best to recover database after crash\. It is recommended to backup DB before running recover\.
+.
+.P
+Example:
+.
+.P
+$ aptly db recover
+.
 .SH "HTTP SERVE PUBLISHED REPOSITORIES"
 \fBaptly\fR \fBserve\fR
 .
 .P
-Command serve starts embedded HTTP server (not suitable for real production usage) to serve contents of public/ subdirectory of aptly\'s root that contains published repositories\.
+Command serve starts embedded HTTP server (not suitable for real production usage) to serve contents of public/ subdirectory of aptly\(cqs root that contains published repositories\.
 .
 .P
 Example: