Next: ALIS - BIBLIOTEKSSYSTEM Up: No Title Previous: Udseende og forklaring

OPSÆTNING AF MANUALSIDER

Kort beskrivelse: Når man har lavet et program, som man mener at andre kan have glæde af, bør man lave en manualside om programmet.

Det følgende eksempel viser skelettet til en manualside. Manualsider skal formatteres med nroff, som er et (gammelt) formateringsprogram. De vigtigste nroff kommandoer i forbindelse med manualsider er

Bemærk: Alle dot-kommandoer skal starte i første kolonne på en linje.

Kommandoen mycmd er beskrevet i en manualside-fil som ser således ud:


    .TH mycmd 1imsor 24/10-89
    .SH NAME
    mycmd \- perform a new and wonderfull command
    .SH SYNOPSIS
    .B mycmd 
    [ -f <file> ]
    .SH DESCRIPTION
    .PP
    .B Mycmd 
    make wonders on any file. You will hardly 
    recognice your file again.
    .br
    A lot of random numbers and the size of the input file 
    is written on stdout.
    .SH OPTIONS
    -f <file> takes input from <file>, otherwise 
    input is taken from stdin.
    .SH FILES
    mycmd.log         Log of what has happenend
    .SH "SEE ALSO"
    Yourcmd(1imsor), nroff(1), vi(1)
    .SH DIAGNOSTICS
    No return value
    .SH BUGS
    The output of mycmd is often useless
    .SH AUTHOR
    Indiana Jones jr.

For at følge de almindelige konventioner for manualsider, kan man prøve at bruge de samme overskrifter, som allerede bliver brugt i UNIX manualen. I eksemplet er nogle af de mest almindelige brugt.

I dette tilfælde ligger manualsiden i en fil ved navn mycmd.1. For at se layout af den nye manualside skal man skrive


    vip:/usv2/nn $ nroff -man mycmd.1 | more

Når man er tilfreds med indhold og udseende, kontakter man en superbruger, som placerer din manualside så andre kan få glæde af den.


mr@imm.dtu.dk