New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add man page #99

Merged
merged 7 commits into from Aug 26, 2018

Conversation

2 participants
@evertiro
Contributor

evertiro commented Aug 26, 2018

When I added the PPA for Gcolor3, I realized you don't currently have a man page. This is technically a requirement for Debian-based distros.

@Hjdskes

Hjdskes requested changes Aug 26, 2018 edited

Awesome, thanks! Can you also add a section "Files" like gnome-session's manpage? I.e.,

FILES
       $XDG_CONFIG_HOME/gcolor3/rgb.ini

              The colors you save will be stored in this file

Or something along those lines.

Perhaps you can also mention that the last selected color is printed to stdout. This was requested a long time ago by a user who wanted to use Gcolor3 in a script.

.TH GCOLOR3 "1" "August 26, 2018"
.
.SH NAME
gcolor3 \- color selection dialog

This comment has been minimized.

@Hjdskes

Hjdskes Aug 26, 2018

Owner

Please make this "a color selection dialog"

Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.
.SH BUGS
.SS "Reporting Bugs"

This comment has been minimized.

@Hjdskes

Hjdskes Aug 26, 2018

Owner

Please remove this line.

.TP
.BR \-\^\-help\-gtk
Show GTK+ options
.SS "GTK+ Options"

This comment has been minimized.

@Hjdskes

Hjdskes Aug 26, 2018

Owner

I viewed some man pages of other GNOME applications, and none included these. Can you please remove them?

This comment has been minimized.

@evertiro

evertiro Aug 26, 2018

Contributor

Only included them because --help did, but no problem!

.BI "\-\^\-display=" DISPLAY
X display to use
.
.SH COPYRIGHT

This comment has been minimized.

@Hjdskes

Hjdskes Aug 26, 2018

Owner

Is it common to include the full license in man pages?

This comment has been minimized.

@evertiro

evertiro Aug 26, 2018

Contributor

That's not the full license, it's the recommended subset of the GPL to include in a single file. The full license is MUCH longer.

Full license: https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
Reference for applying: https://www.gnu.org/licenses/gpl-2.0.en.html#SEC4

This comment has been minimized.

@Hjdskes

Hjdskes Aug 26, 2018

Owner

You're right, I used the wrong term. I meant whether it's common to include this subset in the manpage instead of just the name of the license, or anything at all.

meson.build Outdated
@@ -43,6 +43,8 @@ config_h.set('UNUSED', '__attribute__ ((unused))')
configure_file(output: 'config.h',
configuration: config_h)
install_man('man/gcolor3.1')

This comment has been minimized.

@Hjdskes

Hjdskes Aug 26, 2018

Owner

Can you please move the man page to the data folder? No need for a separate folder.

This comment has been minimized.

@Hjdskes

Hjdskes Aug 26, 2018

Owner

When you do, please move the install_man line to data/meson.build as well.

evertiro added some commits Aug 26, 2018

@evertiro

This comment has been minimized.

Contributor

evertiro commented Aug 26, 2018

@Hjdskes all changes made and questions responded to!

@Hjdskes

This comment has been minimized.

Owner

Hjdskes commented Aug 26, 2018

Thanks :) I checked a few popular man pages (i.e., vim, bash, man itself) and none include (a subset of) the license. Can you switch that to just an AUTHORS section instead? You can make it "Jente Hidskes and contributors".

@evertiro

This comment has been minimized.

Contributor

evertiro commented Aug 26, 2018

Done

@Hjdskes

Awesome, thanks!

@Hjdskes Hjdskes merged commit 2409198 into Hjdskes:master Aug 26, 2018

@evertiro

This comment has been minimized.

Contributor

evertiro commented Aug 26, 2018

You're helping me, I'll help you... with that tiny addition, it's valid for Debian/Ubuntu!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment