#75 Missing manpages

closed-fixed
3
2010-05-23
2010-05-04
quadrispro
No

Hi,

Each binary in /usr/bin, /usr/sbin, /bin, /sbin or /usr/games should have a manual page and bristol misses manpages.

I'm attaching the manpage file for the bristol command, it would be much appreciated if you would write the other ones.

Thanks.

Discussion

  • quadrispro

    quadrispro - 2010-05-04
     
  • quadrispro

    quadrispro - 2010-05-04
    • priority: 5 --> 3
     
  • Andrew C

    Andrew C - 2010-05-04

    startBristol -v -h is more or less the man page for bristol.
    But I get what your saying. Updating the manpage of bristol/startBristol with the output of startBristol -v - h wouldn't be a bad idea. But for the brighton command, I doubt that there is much use of the command outside of the startBristol script.

    Andrew.

     
  • Nick Copeland

    Nick Copeland - 2010-05-04

    I think the manual page will have to be the same for each binary - that is not unusual. The two bristol and brighton binaries are not intended to be used outside of the startBristol script and there are arguments that for this reason the should not actually be placed in /usr/bin.

    Will work with the file you gave me and fill out the rest of the options for the startBristol script.

     
  • Nick Copeland

    Nick Copeland - 2010-05-04
    • assigned_to: nobody --> ncopeland
    • labels: --> Interface (example)
     
  • Nick Copeland

    Nick Copeland - 2010-05-04

    Updated manpage

     
  • Nick Copeland

    Nick Copeland - 2010-05-04

    Updated manpage

     
  • Nick Copeland

    Nick Copeland - 2010-05-04

    That was a pretty old source manfile you had - from 2003.

    I have updated it to be current and reworked the toplevel Makefile.am to include install/uninstall of this page. It remains a single page called bristoll.1 - brighton.1 and startBristol.1 and symlinks to it.

    Not sure why sfdc put the bristol.1 file up there twice - I only did one upload, perhaps it is an issue with duplicate names?

    Regards, nick.

     
  • Nick Copeland

    Nick Copeland - 2010-05-13

    Delivered a fully updated manpage with 0.60.3, now uploaded. Each of the options has text describing its function, some naturally in more depth than others. The only missing section is on the command line interface which will be reviewed at a later date.

    There is only one actual manual page, bristol.1, brighton.h and startBristol.1 are symbolic links to the same page.

     
  • Nick Copeland

    Nick Copeland - 2010-05-13
    • status: open --> pending-fixed
     
  • Nick Copeland

    Nick Copeland - 2010-05-13

    Just as well this was not closed. The Makefile.am did not contain the correst DESTDIR definition for the manual page so would fail on fakeroot builds. The corrected Makefile.am is attached here:

    bristol-0.60.3/Makefile.am

    Based on feedback from Simon and from here the case will presently be closed.

     
  • Nick Copeland

    Nick Copeland - 2010-05-13

    Corrected Makefile.am for 0.60.3 man page location

     
  • quadrispro

    quadrispro - 2010-05-16
    • status: pending-fixed --> open-fixed
     
  • quadrispro

    quadrispro - 2010-05-16

    Please apply the following patch to compress the manpages and install them into the right path.

    Author: Alessio Treglia <quadrispro@ubuntu.com>
    Description: Install manpages into the correct destination path.
    Forwarded: yes
    Bug: https://sourceforge.net/tracker/?func=detail&atid=803734&aid=2996403&group_id=157415
    ---
    Makefile.am | 9 +++++----
    Makefile.in | 9 +++++----
    2 files changed, 10 insertions(+), 8 deletions(-)

    --- bristol.orig/Makefile.am
    +++ bristol/Makefile.am
    @@ -6,9 +6,10 @@ ACLOCAL_AMFLAGS=-I m4
    bristoldir=${BRISTOL_DIR}

    install-man:
    - $(INSTALL) -d $(mandir)/man1
    - $(INSTALL) -m 644 $(srcdir)/bristol.1 $(mandir)/man1/
    - cd $(mandir)/man1 && ln -sf bristol.1 brighton.1 && ln -sf bristol.1 startBristol.1
    + $(INSTALL) -d $(DESTDIR)$(mandir)/man1
    + $(INSTALL) -m 644 $(srcdir)/bristol.1 $(DESTDIR)$(mandir)/man1/
    + gzip -9fn $(DESTDIR)$(mandir)/man1/bristol.1
    + cd $(DESTDIR)$(mandir)/man1 && ln -sf bristol.1.gz brighton.1.gz && ln -sf bristol.1.gz startBristol.1.gz

    installdb:
    mkdir -p -m 755 $(DESTDIR)$(bristoldir)
    @@ -29,7 +30,7 @@ uninstall: uninstall-recursive uninstall
    rm -rf $(DESTDIR)$(bristoldir)/memory
    rm -rf $(DESTDIR)$(bristoldir)/bitmaps
    rm -rf $(DESTDIR)$(bristoldir)
    - rm -rf $(mandir)/man1/bristol.1 $(mandir)/man1/brighton.1 $(mandir)/man1/startBristol.1
    + rm -rf $(DESTDIR)$(mandir)/man1/bristol.1 $(DESTDIR)$(mandir)/man1/brighton.1 $(DESTDIR)$(mandir)/man1/startBristol.1

    EXTRA_DIST=include bitmaps memory COPYING COPYING.GPL bristol.1

    --- bristol.orig/Makefile.in
    +++ bristol/Makefile.in
    @@ -653,9 +653,10 @@ uninstall-info: uninstall-info-recursive

    install-man:
    - $(INSTALL) -d $(mandir)/man1
    - $(INSTALL) -m 644 $(srcdir)/bristol.1 $(mandir)/man1/
    - cd $(mandir)/man1 && ln -sf bristol.1 brighton.1 && ln -sf bristol.1 startBristol.1
    + $(INSTALL) -d $(DESTDIR)$(mandir)/man1
    + $(INSTALL) -m 644 $(srcdir)/bristol.1 $(DESTDIR)$(mandir)/man1/
    + gzip -9fn $(DESTDIR)$(mandir)/man1/bristol.1
    + cd $(DESTDIR)$(mandir)/man1 && ln -sf bristol.1.gz brighton.1.gz && ln -sf bristol.1.gz startBristol.1.gz

    installdb:
    mkdir -p -m 755 $(DESTDIR)$(bristoldir)
    @@ -676,7 +677,7 @@ uninstall: uninstall-recursive uninstall
    rm -rf $(DESTDIR)$(bristoldir)/memory
    rm -rf $(DESTDIR)$(bristoldir)/bitmaps
    rm -rf $(DESTDIR)$(bristoldir)
    - rm -rf $(mandir)/man1/bristol.1 $(mandir)/man1/brighton.1 $(mandir)/man1/startBristol.1
    + rm -rf $(DESTDIR)$(mandir)/man1/bristol.1 $(DESTDIR)$(mandir)/man1/brighton.1 $(DESTDIR)$(mandir)/man1/startBristol.1
    # Tell versions [3.59,3.63) of GNU make to not export all variables.
    # Otherwise a system limit (for SysV at least) may be exceeded.
    .NOEXPORT:

     
  • Nick Copeland

    Nick Copeland - 2010-05-16

    Fantastic, many thanks - will apply the patch for the next release.

     
  • Nick Copeland

    Nick Copeland - 2010-05-16

    The code you are downloading does not have the patch for the manpages, naturally.

     
  • Nick Copeland

    Nick Copeland - 2010-05-22

    The manpage is now up to date and changes have been applied to the install processes as per the issues documented here. Pending closure

     
  • Nick Copeland

    Nick Copeland - 2010-05-22
    • status: open-fixed --> pending-fixed
     
  • Nick Copeland

    Nick Copeland - 2010-05-23

    distributed 0.60.4 with up to date manpage and corrected install procedures. Closed.

     
  • Nick Copeland

    Nick Copeland - 2010-05-23
    • status: pending-fixed --> closed-fixed
     

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks