Hi Matt,

Matt Markfort wrote on Sun, Dec 28, 2014 at 12:23:08AM -0600:

> I am unable to find the port maintainer for ports/net/no-ip

There is none.  So if you are using it regularly and are willing
to maintain the port, feel free to step up.  In case you are
interested, please read the paragraph 2.1 "Overview" on

  http://www.openbsd.org/faq/ports/guide.html

in particular the last sentence.

> and I'd like for this man page to be added to the port.

The proper way to do that is to

 - create a directory files/
 - create the file files/noip2.8 inside
 - do something like
     ${INSTALL_MAN} ${FILESDIR}/noip2.8 ${PREFIX}/man/man8
   below do-install in the port's Makefile
 - update pkg/PLIST

I was about to do that myself, then i realized no-ip is commercial
software.  There is nothing wrong with having commercial software
in the ports tree, and having a maintainer for it is better than
having it unmaintained.  It's just that personally, i don't want
to spend that much time on commercial software.

To get this imported, the following is needed:

 1. Check the accuracy of the proposed manual page.
    Does it apply to exactly the version of noip2 we have in our
    tree?  Is it complete and free of errors?
 2. Prepare a patch (diff -Nup) against the existing port
    including the above points.  Since you can't add a
    directory, having just the changes to existing files
    in the patch is acceptable and putting the new file
    into the body of the mail, too.  Whoever imports it
    will add the directory.
 3. Send that patch to ports@, stating that you checked the
    accuracy of the content, ideally stating that you also
    intend to send the manual page upstream for inclusion,
    ideally offering to take maintainership if you are willing
    to maintain the port.

Your mdoc(7) code is of good quality.  Some nits inline, below.

See the porting guide (link above) for help.
Feel free to ask for additional advice if needed.

Thanks,
  Ingo


> It's especially useful information when defining pfctl(8) rules.
> 
> .\"   no-ip.com dynamic IP update client for Linux
> .\"
> .\"   Copyright 2000-2006 Free Software Foundation, Inc.
> .\"
> .\"   This program is free software; you can redistribute it and/or modify
> .\"   it under the terms of the GNU General Public License as published by
> .\"   the Free Software Foundation; either version 2, or (at your option)
> .\"   any later version.
> .\"
> .\"   This program is distributed in the hope that it will be useful,
> .\"   but WITHOUT ANY WARRANTY; without even the implied warranty of
> .\"   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> .\"   GNU General Public License for more details.
> .\"
> .\"   You should have received a copy of the GNU General Public License
> .\"   along with this program; if not, write to the Free Software
> .\"   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
> .\"
> .\"   written June 2000 by jo...@onevista.com
> .\"
> .\"   copyright transferred from
> .\"              One Vista Associates
> .\"   to
> .\"   Free Software Foundation, Inc.
> .\"
> .\"   October 6, 2000 (johna)
> .\" noip2.8 retrieved from http://manpages.ubuntu.com/manpages/ \
> .\" lucid/man8/noip.2.8.html
> .\" Retrieved: 2014-12-09 13:42:00 CST
> .\" mandoc formatted 2014-12-27 for OpenBSD_5_6 by matthew.markf...@gmail.com
> .Dd December 18, 2014
> .Dt noip2 8
> .Os OpenBSD 5.6

That causes gratuitious maintenance effort.

Just put

  .Os

here without any arguments.

> .Sh NAME
> .Nm noip2
> .Nd No-IP.com Dynamic DNS Update Client (DUC)
> .Sh SYNOPSIS
> .Nm noip2
> .Oo
> .Op Fl C
> .Op Fl F
> .Op Fl Y
> .Op Fl L Ar host_groups
> .Op Fl U Ar #min
> .Op Fl u Ar username
> .Op Fl p Ar password
> .Op Fl x Ar progname
> .Oc
> .Op Fl c Ar file
> .Op Fl d
> .Op Fl D Ar pid
> .Op Fl i Ar addr
> .Op Fl S
> .Op Fl M
> .Op Fl h
> .Sh DESCRIPTION
> The
> .Nm
> Dynamic DNS Update Client (DUC) periodically checks the
> local IP address to see if it  has  changed.  If  the  IP  address  has

New sentence, new line.  Make that:

  local IP address to see if it has changed.
  If the IP address has

Same below.

> changed,  the client notifies the No-IP.com DNS servers and updates the
> IP  address  corresponding  to  the  user's   No-IP/No-IP+   configured
> hostname(s).
> .Pp
> A valid No-IP.com account is required.
> .Pp
> The client communicates with the No-IP.com server over TCP on port 8245
> .Pq outgoing .
> .Pp
> The options are as follows:
> .Bl -tag -width indent
> .It Fl C
> Create configuration data file

Full stop at the end of each sentence.  Same below.

> .It Fl F
> Force NAT off
> .It Fl Y
> Select all hosts/groups
> .It Fl L Ar hosts_groups
> Select  supplied  hosts/groups

Purely aestetical:  Avoid multiple space characters between words.

> .It Fl U Ar minutes
> Set  update  interval  in  minutes
> .It Fl u Ar username
> Use supplied username
> .It Fl p Ar password
> Use supplied password
> .It Fl x Ar executable
> Use supplied executable
> .It Fl c Ar config_file
> Use alternate path to store configuration data file
> .It Fl d
> Increase debug verbosity
> .It Fl D Ar processID
> Toggle debug flag for PID
> .It Fl i Ar IPaddress
> Use  supplied  address.  This  option  is also useful to run the
> client once and exit.
> .It Fl I Ar interface
> Use supplied interface
> .It Fl S
> Show configuration data
> .Po requires superuser access Pc
> .It Fl M
> Permit multiple instances
> .It Fl K Ar processID
> Terminate instance PID
> .It Fl z
> Activate shm dump code
> .It Fl h
> Display usage information
> .El
> .Sh EXAMPLES
> .Bd -offset -indent

Delete this .Bd line, it is not needed.
Besides, nested displays are of limited portability (you are
using .Dl inside .Bd).

> Prompted walkthrough to generate default binary configuration file

Maybe a colon at the end of the line?  Same below.

> .Pq minimal first-time step
> .Dl # Nm Fl C
> .Pp
> Show configuration information from default configuration file
> .Pa /etc/noip2.conf
> .Dl # Nm Fl S
> .Pp
> Setting update interval for every 1,440 minutes
> .Pq 24 hours * 60 minutes per hour ,
> use No-IP.com username and password to update client information with 
> No-IP.com
> .Dl # Nm Fl C Fl U Fc 1440 Fl u Ar username Fl p Ar password
> .Ed
> .Sh FILES
> .Bl -tag -width Ds -compact
> .It Pa /etc/noip2.conf
> Binary default configuration file
> 
> .It Pa /usr/local/share/doc/no-ip/README.FIRST

I would put that one below SEE ALSO rather than below FILES.

> .El
> .Sh HISTORY
> .Nm
> first appeared in ports for
> .Ox 3.1 .

If you want to push this upstream, it should probably document the
HISTORY of the program itself, not of the OpenBSD port.

> .Sh LICENSE
> .Nm
> can be distributed under the terms of the GPLv2 license.

Delete that.  Manuals don't need LICENSE sections.

> .Sh AUTHORS
> .Bd -width -indent
> .Nm
> was written by John Adams
> .Aq jo...@onevista.com

Reply via email to