man page should include examples

[Rory McCann]

Binary package hint: unrtf

The man page for unrtf is quite terse. It should have an Example section showing how to use it.

The Synopsis section just says:

       unrtf [options] [file...]

       Options: [--nopict] [--html] [--text] [--vt] [--latex] [--ps] [--wpml] [--help] [--version]

Since unrtf is a programme that converts RTF files to other formats, one naturally thinks that there should be 2 files on the command line. However the synopsis doesn't show that. It was only after using it that I realised the output came out on the stdout.

ProblemType: Bug
Architecture: i386
Date: Fri Nov 27 09:33:31 2009
DistroRelease: Ubuntu 9.10
Package: unrtf 0.19.3-1.1
ProcEnviron:
 PATH=(custom, user)
 LANG=en_IE.UTF-8
 SHELL=/bin/bash
ProcVersionSignature: Ubuntu 2.6.31-15.50-generic
SourcePackage: unrtf
Uname: Linux 2.6.31-15-generic i686
XsessionErrors:
 (gnome-settings-daemon:1841): GLib-CRITICAL **: g_propagate_error: assertion `src != NULL' failed
 (gnome-settings-daemon:1841): GLib-CRITICAL **: g_propagate_error: assertion `src != NULL' failed
 (nautilus:2067): Eel-CRITICAL **: eel_preferences_get_boolean: assertion `preferences_is_initialized ()' failed
 (polkit-gnome-authentication-agent-1:2136): GLib-CRITICAL **: g_once_init_leave: assertion `initialization_value != 0' failed
 (gnome-panel:1940): Gtk-WARNING **: gtk_widget_size_allocate(): attempt to allocate widget with width -5 and height 24