diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cheatsheet.svg | 4 | ||||
| -rw-r--r-- | doc/howto-publish-a-release.md | 34 | ||||
| -rw-r--r-- | doc/ranger.1 | 31 | ||||
| -rw-r--r-- | doc/ranger.pod | 26 | ||||
| -rw-r--r-- | doc/rifle.1 | 4 |
5 files changed, 70 insertions, 29 deletions
diff --git a/doc/cheatsheet.svg b/doc/cheatsheet.svg index f8a97bff..3794a2da 100644 --- a/doc/cheatsheet.svg +++ b/doc/cheatsheet.svg @@ -4059,7 +4059,7 @@ sodipodi:role="line">ranger cheatsheet</tspan></text> <a id="a5535" - xlink:href="http://ranger.github.io" + xlink:href="https://ranger.github.io" style="fill:#0000ff" transform="translate(10,-296.00002)"> <text @@ -4073,7 +4073,7 @@ sodipodi:role="line" x="230" y="567.36218" - style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:15px;line-height:100%;font-family:Sans;-inkscape-font-specification:'Sans, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start;fill:#0000ff">http://ranger.github.io</tspan></text> + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:15px;line-height:100%;font-family:Sans;-inkscape-font-specification:'Sans, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start;fill:#0000ff">https://ranger.github.io</tspan></text> </a> <text xml:space="preserve" diff --git a/doc/howto-publish-a-release.md b/doc/howto-publish-a-release.md index 9b6e1dfe..572a2eb7 100644 --- a/doc/howto-publish-a-release.md +++ b/doc/howto-publish-a-release.md @@ -1,3 +1,26 @@ +Prepare the "stable" branch +--------------------------- +Before you can do anything else, you need to decide what should be included in +the new version. + +**Bugfix releases** bump the third number of the version, e.g. 1.9.0 -> 1.9.1. +They may include bugfix commits that you `git cherry-pick`ed from the master +branch into the stable branch, or you can just do a fast-forward merge of +master into stable, if there were only bugfix commits since the last major +version. You can also add minor new features that are very likely not causing +any bugs. However, there should be absolutely **no** backward-incompatible +changes, like: + +- renamed or removed settings, commands or python functions +- renamed, removed or reordered function arguments +- change in syntax of configuration files or in API of configuration scripts + +New settings are okay, just make sure a sane default value is defined. + +**Major releases** bump the second number of the version, e.g. 1.9.2 -> 1.10.0 +and are necessary if you introduce any breaking changes, like the ones +mentioned in the list above. + Test everything ---------------- * [ ] `make test` @@ -13,7 +36,9 @@ Make a release commit * [ ] `make man` * [ ] Write changelog entry * [ ] Think of a witty commit message -* [ ] Tag signed release +* [ ] Commit +* [ ] Tag the signed release with `git tag -a <commit-id>`, using the same + commit message as annotation * [ ] Push release and tag Make snapshot and test again @@ -28,9 +53,11 @@ Update the website * [ ] Add the new version as `ranger-stable.tar.gz` * [ ] Add the new version as `ranger-X.Y.Z.tar.gz` * [ ] Update both signatures `gpg --local-user 0x00FB5CDF --sign --detach-sign <file>` -* [ ] Update the changelog * [ ] Update the man page -* [ ] Rerun `boobies.py` + * [ ] run `make manhtml` in ranger's repository + * [ ] copy the generated `doc/ranger.1.html` to the `ranger.github.io` repository +* [ ] Rebuild the website, see `README.md` in https://github.com/ranger/ranger.github.io +* [ ] Commit & push the website Make a PyPI release ------------------- @@ -43,7 +70,6 @@ Announce the update ------------------- * [ ] To the mailing list * [ ] In the arch linux forum -* [ ] Write a news entry on savannah Change back to before --------------------- diff --git a/doc/ranger.1 b/doc/ranger.1 index ab47de61..6358e1d6 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.9.0" "2018-01-28" "ranger manual" +.TH RANGER 1 "ranger-1.9.1" "2018-05-08" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -267,7 +267,7 @@ typing \fI"<tagname>\fR. By default, only text files are previewed, but you can enable external preview scripts by setting the option \f(CW\*(C`use_preview_script\*(C'\fR and \f(CW\*(C`preview_files\*(C'\fR to true. .PP -This default script is \fI~/.config/ranger/scope.sh\fR. It contains more +This default script is \fI\f(CI%rangerdir\fI/data/scope.sh\fR. It contains more documentation and calls to the programs \fIlynx\fR and \fIelinks\fR for html, \&\fIhighlight\fR for text/code, \fIimg2txt\fR for images, \fIatool\fR for archives, \&\fIpdftotext\fR for PDFs and \fImediainfo\fR for video and audio files. @@ -463,7 +463,7 @@ sample plugins in the \fI/usr/share/doc/ranger/examples/\fR directory, including hello-world plugin that describes this procedure. .SH "KEY BINDINGS" .IX Header "KEY BINDINGS" -Key bindings are defined in the file \fIranger/config/rc.conf\fR. Check this +Key bindings are defined in the file \fI\f(CI%rangerdir\fI/config/rc.conf\fR. Check this file for a list of all key bindings. You can copy it to your local configuration directory with the \-\-copy\-config=rc option. .PP @@ -800,6 +800,13 @@ this pattern will hide all files that start with a dot or end with a tilde. .Vb 1 \& set hidden_filter ^\e.|~$ .Ve +.IP "hint_collapse_threshold [int]" 4 +.IX Item "hint_collapse_threshold [int]" +The key hint lists up to this size have their sublists expanded. +Otherwise the submaps are replaced with \*(L"...\*(R". +.IP "hostname_in_titlebar [bool]" 4 +.IX Item "hostname_in_titlebar [bool]" +Show hostname in titlebar? .IP "idle_delay [integer]" 4 .IX Item "idle_delay [integer]" The delay that ranger idly waits for user input, in milliseconds, with a @@ -932,9 +939,6 @@ combination, e.g. \*(L"oN\*(R" to sort from Z to A. .IP "status_bar_on_top [bool]" 4 .IX Item "status_bar_on_top [bool]" Put the status bar at the top of the window? -.IP "hostname_in_titlebar [bool]" 4 -.IX Item "hostname_in_titlebar [bool]" -Show hostname in titlebar? .IP "tilde_in_titlebar [bool]" 4 .IX Item "tilde_in_titlebar [bool]" Abbreviate \f(CW$HOME\fR with ~ in the titlebar (first line) of ranger? @@ -1421,6 +1425,9 @@ being bound despite the corresponding line being removed from the user's copy of the configuration file. This behavior may be disabled with an environment variable (see also: \fB\s-1ENVIRONMENT\s0\fR). Note: All other configuration files only read from one source; i.e. default \s-1OR\s0 user, not both. +\&\fIrc.conf\fR and \fIcommands.py\fR are additionally read from \fI/etc/ranger\fR if they +exist for system-wide configuration, user configuration overrides system +configuration which overrides the default configuration. .PP When starting ranger with the \fB\-\-clean\fR option, it will not access or create any of these files. @@ -1533,13 +1540,13 @@ provided along with the source code. \&\s-1GNU\s0 General Public License 3 or (at your option) any later version. .SH "LINKS" .IX Header "LINKS" -.IP "Download: <http://ranger.github.io/ranger\-stable.tar.gz>" 4 -.IX Item "Download: <http://ranger.github.io/ranger-stable.tar.gz>" +.IP "Download: <https://ranger.github.io/ranger\-stable.tar.gz>" 4 +.IX Item "Download: <https://ranger.github.io/ranger-stable.tar.gz>" .PD 0 -.IP "The project page: <http://ranger.github.io/>" 4 -.IX Item "The project page: <http://ranger.github.io/>" -.IP "The mailing list: <http://savannah.nongnu.org/mail/?group=ranger>" 4 -.IX Item "The mailing list: <http://savannah.nongnu.org/mail/?group=ranger>" +.IP "The project page: <https://ranger.github.io/>" 4 +.IX Item "The project page: <https://ranger.github.io/>" +.IP "The mailing list: <https://savannah.nongnu.org/mail/?group=ranger>" 4 +.IX Item "The mailing list: <https://savannah.nongnu.org/mail/?group=ranger>" .IP "\s-1IRC\s0 channel: #ranger on freenode.net" 4 .IX Item "IRC channel: #ranger on freenode.net" .PD diff --git a/doc/ranger.pod b/doc/ranger.pod index ee869393..9fb4cf0d 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -174,7 +174,7 @@ typing I<"<tagnameE<gt>>. By default, only text files are previewed, but you can enable external preview scripts by setting the option C<use_preview_script> and C<preview_files> to true. -This default script is F<~/.config/ranger/scope.sh>. It contains more +This default script is F<%rangerdir/data/scope.sh>. It contains more documentation and calls to the programs I<lynx> and I<elinks> for html, I<highlight> for text/code, I<img2txt> for images, I<atool> for archives, I<pdftotext> for PDFs and I<mediainfo> for video and audio files. @@ -364,7 +364,7 @@ hello-world plugin that describes this procedure. =head1 KEY BINDINGS -Key bindings are defined in the file F<ranger/config/rc.conf>. Check this +Key bindings are defined in the file F<%rangerdir/config/rc.conf>. Check this file for a list of all key bindings. You can copy it to your local configuration directory with the --copy-config=rc option. @@ -791,6 +791,15 @@ this pattern will hide all files that start with a dot or end with a tilde. set hidden_filter ^\.|~$ +=item hint_collapse_threshold [int] + +The key hint lists up to this size have their sublists expanded. +Otherwise the submaps are replaced with "...". + +=item hostname_in_titlebar [bool] + +Show hostname in titlebar? + =item idle_delay [integer] The delay that ranger idly waits for user input, in milliseconds, with a @@ -951,10 +960,6 @@ combination, e.g. "oN" to sort from Z to A. Put the status bar at the top of the window? -=item hostname_in_titlebar [bool] - -Show hostname in titlebar? - =item tilde_in_titlebar [bool] Abbreviate $HOME with ~ in the titlebar (first line) of ranger? @@ -1507,6 +1512,9 @@ being bound despite the corresponding line being removed from the user's copy of the configuration file. This behavior may be disabled with an environment variable (see also: B<ENVIRONMENT>). Note: All other configuration files only read from one source; i.e. default OR user, not both. +F<rc.conf> and F<commands.py> are additionally read from F</etc/ranger> if they +exist for system-wide configuration, user configuration overrides system +configuration which overrides the default configuration. When starting ranger with the B<--clean> option, it will not access or create any of these files. @@ -1670,11 +1678,11 @@ GNU General Public License 3 or (at your option) any later version. =over -=item Download: L<http://ranger.github.io/ranger-stable.tar.gz> +=item Download: L<https://ranger.github.io/ranger-stable.tar.gz> -=item The project page: L<http://ranger.github.io/> +=item The project page: L<https://ranger.github.io/> -=item The mailing list: L<http://savannah.nongnu.org/mail/?group=ranger> +=item The mailing list: L<https://savannah.nongnu.org/mail/?group=ranger> =item IRC channel: #ranger on freenode.net diff --git a/doc/rifle.1 b/doc/rifle.1 index 755ac959..ad32e4f4 100644 --- a/doc/rifle.1 +++ b/doc/rifle.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "RIFLE 1" -.TH RIFLE 1 "rifle-1.9.0" "2018-01-25" "rifle manual" +.TH RIFLE 1 "rifle-1.9.1" "05.03.2018" "rifle manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l |
