From cafa438f800415af0f7ac7a9d5701a07e42da628 Mon Sep 17 00:00:00 2001 From: stomar Date: Thu, 20 Apr 2017 07:46:22 +0000 Subject: improve man pages * man/ruby.1, man/erb.1, man/goruby.1, man/irb.1: fix document title formatting and volume name, improve "REPORTING BUGS" section: fix mdoc formatting error (wrong macro for bullet list items), small rewordings. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58411 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- man/erb.1 | 12 +++++++----- man/goruby.1 | 2 +- man/irb.1 | 12 +++++++----- man/ruby.1 | 15 ++++++++------- 4 files changed, 23 insertions(+), 18 deletions(-) (limited to 'man') diff --git a/man/erb.1 b/man/erb.1 index f98a0273a5..46ee2fa2d4 100644 --- a/man/erb.1 +++ b/man/erb.1 @@ -1,6 +1,6 @@ .\"Ruby is copyrighted by Yukihiro Matsumoto . .Dd November 15, 2012 -.Dt ERB(1) "" "Ruby Programmers Reference Guide" +.Dt ERB \&1 "Ruby Programmer's Reference Guide" .Os UNIX .Sh NAME .Nm erb @@ -143,15 +143,17 @@ class. .Pp .Sh REPORTING BUGS .Bl -bullet -.Li Security vulnerabilities should be reported via an email to -.Aq security@ruby-lang.org . +.It +Security vulnerabilities should be reported via an email to +.Mt security@ruby-lang.org . Reported problems will be published after being fixed. .Pp -.Li And you can report other bugs and feature requests via the +.It +Other bugs and feature requests can be reported via the Ruby Issue Tracking System .Pq Lk https://bugs.ruby-lang.org/ . Do not report security vulnerabilities -via the system because it publishes the vulnerabilities immediately. +via this system because it publishes the vulnerabilities immediately. .El .Sh AUTHORS Written by Masatoshi SEKI. diff --git a/man/goruby.1 b/man/goruby.1 index 857874f070..47a015f34d 100644 --- a/man/goruby.1 +++ b/man/goruby.1 @@ -1,6 +1,6 @@ .\"Ruby is copyrighted by Yukihiro Matsumoto . .Dd November 15, 2012 -.Dt GORUBY(1) "" "Ruby Programmers Reference Guide" +.Dt GORUBY \&1 "Ruby Programmer's Reference Guide" .Os UNIX .Sh NAME .Nm goruby diff --git a/man/irb.1 b/man/irb.1 index fca410c999..9083fcdbe2 100644 --- a/man/irb.1 +++ b/man/irb.1 @@ -1,6 +1,6 @@ .\"Ruby is copyrighted by Yukihiro Matsumoto . .Dd November 15, 2012 -.Dt IRB(1) "" "Ruby Programmers Reference Guide" +.Dt IRB \&1 "Ruby Programmer's Reference Guide" .Os UNIX .Sh NAME .Nm irb @@ -159,15 +159,17 @@ Personal irb initialization. .Pp .Sh REPORTING BUGS .Bl -bullet -.Li Security vulnerabilities should be reported via an email to -.Aq security@ruby-lang.org . +.It +Security vulnerabilities should be reported via an email to +.Mt security@ruby-lang.org . Reported problems will be published after being fixed. .Pp -.Li And you can report other bugs and feature requests via the +.It +Other bugs and feature requests can be reported via the Ruby Issue Tracking System .Pq Lk https://bugs.ruby-lang.org/ . Do not report security vulnerabilities -via the system because it publishes the vulnerabilities immediately. +via this system because it publishes the vulnerabilities immediately. .El .Sh AUTHORS Written by Keiju ISHITSUKA. diff --git a/man/ruby.1 b/man/ruby.1 index 28a73e576a..f18513271d 100644 --- a/man/ruby.1 +++ b/man/ruby.1 @@ -1,7 +1,6 @@ .\"Ruby is copyrighted by Yukihiro Matsumoto . .Dd October 31, 2015 -.Dt RUBY(1) "" "Ruby Programmers Reference Guide" -.\".Dt RUBY 1 +.Dt RUBY \&1 "Ruby Programmer's Reference Guide" .Os UNIX .Sh NAME .Nm ruby @@ -641,15 +640,17 @@ Comprehensive catalog of Ruby libraries. .Pp .Sh REPORTING BUGS .Bl -bullet -.Li Security vulnerabilities should be reported via an email to -.Aq security@ruby-lang.org . -Reported problems will be published after they've been fixed. +.It +Security vulnerabilities should be reported via an email to +.Mt security@ruby-lang.org . +Reported problems will be published after being fixed. .Pp -.Li And you can report other bugs and feature requests via the +.It +Other bugs and feature requests can be reported via the Ruby Issue Tracking System .Pq Lk https://bugs.ruby-lang.org/ . Do not report security vulnerabilities -via the system because it publishes the vulnerabilities immediately. +via this system because it publishes the vulnerabilities immediately. .El .Sh AUTHORS Ruby is designed and implemented by -- cgit v1.2.3