No manual pages for ncplogin and ncplogout in package

Bug #72208 reported by Ubuntu User
10
Affects Status Importance Assigned to Milestone
ncpfs (Ubuntu)
Fix Released
Low
Siegfried Gevatter

Bug Description

Binary package hint: ncpfs

I installed the ncpfs package and was looking for the the manual pages for the commands ncplogin and ncplogout.

Typing man ncplogin or man ncplogout results in the following errors:

No manual entry for ncplogin
See 'man 7 undocumented' for help when manual pages are not available.

No manual entry for ncplogout
See 'man 7 undocumented' for help when manual pages are not available.

I checked the 'man 7 undocumented' page which states that there is probably no meaningful documentation for the program, where to look if a bug for the documentation had already been file (in debian's bug system) and how to write better documentation to be included in the future.

The Debian Quality Assurance page (http://qa.debian.org/man-pages.html) list them as commands that don't have man pages as well as some others.

The package list for ncpfs (below) doesn't have the man pages for these two commands listed:

I found them helpful and hope that they can be included.

I am attaching the manual pages that I found using "man <command name>" searching on Google. Both were for BSD, but my guess is that they are the same for Linux... so I wonder why they aren't used.

===ncpfs package list===
/.
/usr
/usr/bin
/usr/bin/nwsfind
/usr/bin/ncpmount
/usr/bin/ncpumount
/usr/bin/ncplogin
/usr/bin/ncpmap
/usr/bin/slist
/usr/bin/pqlist
/usr/bin/nwfsinfo
/usr/bin/pserver
/usr/bin/nprint
/usr/bin/nsend
/usr/bin/nwpasswd
/usr/bin/nwbols
/usr/bin/nwbocreate
/usr/bin/nwborm
/usr/bin/nwboprops
/usr/bin/pqstat
/usr/bin/nwpqjob
/usr/bin/nwbpcreate
/usr/bin/nwbprm
/usr/bin/nwbpvalues
/usr/bin/nwbpadd
/usr/bin/nwbpset
/usr/bin/nwgrant
/usr/bin/nwrevoke
/usr/bin/nwuserlist
/usr/bin/nwauth
/usr/bin/nwfstime
/usr/bin/nwvolinfo
/usr/bin/nwtrustee
/usr/bin/nwdir
/usr/bin/nwfsctrl
/usr/bin/nwpjmv
/usr/bin/ncopy
/usr/bin/nwtrustee2
/usr/bin/nwpurge
/usr/bin/nwrights
/usr/bin/nwdpvalues
/usr/sbin
/usr/sbin/nwmsg
/usr/share
/usr/share/doc
/usr/share/doc/ncpfs
/usr/share/doc/ncpfs/BUGS
/usr/share/doc/ncpfs/README.NDS
/usr/share/doc/ncpfs/ncpfs-nds-0.06.CHANGES
/usr/share/doc/ncpfs/ncpfs-nds-0.06.README
/usr/share/doc/ncpfs/FAQ
/usr/share/doc/ncpfs/ncpfs.lsm
/usr/share/doc/ncpfs/Performance.txt
/usr/share/doc/ncpfs/README.Debian
/usr/share/doc/ncpfs/copyright
/usr/share/doc/ncpfs/changelog.gz
/usr/share/doc/ncpfs/README.gz
/usr/share/doc/ncpfs/changelog.Debian.gz
/usr/share/man
/usr/share/man/man1
/usr/share/man/man1/nprint.1.gz
/usr/share/man/man1/nsend.1.gz
/usr/share/man/man1/nwauth.1.gz
/usr/share/man/man1/nwbols.1.gz
/usr/share/man/man1/nwboprops.1.gz
/usr/share/man/man1/nwbpset.1.gz
/usr/share/man/man1/nwbpvalues.1.gz
/usr/share/man/man1/nwdir.1.gz
/usr/share/man/man1/nwfsinfo.1.gz
/usr/share/man/man1/nwfstime.1.gz
/usr/share/man/man1/nwpasswd.1.gz
/usr/share/man/man1/nwpurge.1.gz
/usr/share/man/man1/nwrights.1.gz
/usr/share/man/man1/nwsfind.1.gz
/usr/share/man/man1/nwtrustee.1.gz
/usr/share/man/man1/nwtrustee2.1.gz
/usr/share/man/man1/nwuserlist.1.gz
/usr/share/man/man1/nwvolinfo.1.gz
/usr/share/man/man1/pqlist.1.gz
/usr/share/man/man1/nwpqjob.1.gz
/usr/share/man/man1/pqstat.1.gz
/usr/share/man/man1/pserver.1.gz
/usr/share/man/man1/slist.1.gz
/usr/share/man/man1/nwpjmv.1.gz
/usr/share/man/man1/ncopy.1.gz
/usr/share/man/man5
/usr/share/man/man5/nwclient.5.gz
/usr/share/man/man8
/usr/share/man/man8/nwbocreate.8.gz
/usr/share/man/man8/nwborm.8.gz
/usr/share/man/man8/nwbpadd.8.gz
/usr/share/man/man8/nwbpcreate.8.gz
/usr/share/man/man8/nwbprm.8.gz
/usr/share/man/man8/nwfsctrl.8.gz
/usr/share/man/man8/nwgrant.8.gz
/usr/share/man/man8/nwrevoke.8.gz
/usr/share/man/man8/ncpmount.8.gz
/usr/share/man/man8/ncpumount.8.gz
/usr/share/man/man8/nwmsg.8.gz
/usr/share/locale
/usr/share/locale/cs
/usr/share/locale/cs/LC_MESSAGES
/usr/share/locale/cs/LC_MESSAGES/ncpfs.mo
/usr/share/locale/de
/usr/share/locale/de/LC_MESSAGES
/usr/share/locale/de/LC_MESSAGES/ncpfs.mo
/usr/share/locale/es
/usr/share/locale/es/LC_MESSAGES
/usr/share/locale/es/LC_MESSAGES/ncpfs.mo
/usr/share/locale/fr
/usr/share/locale/fr/LC_MESSAGES
/usr/share/locale/fr/LC_MESSAGES/ncpfs.mo
/usr/share/locale/hu
/usr/share/locale/hu/LC_MESSAGES
/usr/share/locale/hu/LC_MESSAGES/ncpfs.mo
/usr/share/locale/it
/usr/share/locale/it/LC_MESSAGES
/usr/share/locale/it/LC_MESSAGES/ncpfs.mo
/usr/share/locale/ja
/usr/share/locale/ja/LC_MESSAGES
/usr/share/locale/ja/LC_MESSAGES/ncpfs.mo
/usr/share/locale/pt_BR
/usr/share/locale/pt_BR/LC_MESSAGES
/usr/share/locale/pt_BR/LC_MESSAGES/ncpfs.mo
/usr/share/locale/zh_CN
/usr/share/locale/zh_CN/LC_MESSAGES
/usr/share/locale/zh_CN/LC_MESSAGES/ncpfs.mo
/usr/share/locale/zh_TW
/usr/share/locale/zh_TW/LC_MESSAGES
/usr/share/locale/zh_TW/LC_MESSAGES/ncpfs.mo
/sbin
/usr/bin/ncplogout
/usr/bin/pqrm
/usr/share/man/man1/pqrm.1.gz
/usr/share/man/man8/mount.ncp.8.gz
/sbin/mount.ncp
/sbin/mount.ncpfs
/sbin/nwmsg

===Google search "man ncplogin"===
NCPLOGIN(1) FreeBSD General Commands Manual NCPLOGIN(1)

NAME

     ncplogin -- create permanent connection to a NetWare server

SYNOPSIS

     ncplogin [-BCDN] [-S server] [-U user] [-A host] [-I level] [-M mode] [-O
              [owner][:group]] [-R retrycount] [-T tree] [-W timeout]
     ncplogin [-BCDN] [-A host] [-I level] [-M mode] [-O [owner][:group]]
              [-R retrycount] [-T tree] [-W timeout] /server:user

DESCRIPTION

     Connections to a NetWare server can be created and used independently of
     the mount_nwfs(8) command. Connections can be created by any user. Each
     user can have multiple connections, but each NetWareServer:NetWareUser
     pair should be unique.

     The ncplogin command is used to create a permanent connection to a
     NetWare server. Permanent connections will stay connected even if no
     applications use them. This allows users to run different ncp* programs
     without specifying a file server and user to use. Established connec-
     tions can be destroyed with the ncplogout(1) command.

     Upper case options described in this manual are common for other ncp*
     programs and are referred to as "connection options". Options -U and -S
     are mutually exclusive with the /server:user syntax.

     The options are:

     -S server
             Specify the name of the NetWare server to connect to. This
             affect only IPX servers. For native IP servers, see the -A
             option.

     -U user
             Specify the name of the user used in the login sequence.

     -A host
             Use the UDP protocol to connect to a NetWare 5.x server specified
             by the host argument.

     -C Do not convert the password to uppercase.

     -D Mark the connection as primary. The option can be used to modify
             existing connections. Only the ncplogin program accepts this
             option.

     -I signature_level
             Try to use signature_level. Available values are:

                   Value Meaning
                   0 disable signatures
                   1 enable (use if required by server)
                   2 request but do not require signing
                   3 require signatures

             Note that only packet header signing is implemented.

     -M mode
             Share this connection. The bits in the mode argument are similar
             to standard file permissions:

                   Mask Meaning
                   4 READ - connection will be visible.
                   2 WRITE - connection can be closed/modified
                   1 EXECUTE - user allowed to execute requests.

             By default, the connection is created with mode 0700 and only the
             owner can use it. Specifying 0750 as the argument to the -M
             option would allow read-only group access as well. This would
             allow the group to perform NCP requests, but not to destroy the
             connection. When a server is not explicitly specified, ncp* pro-
             grams try to find a suitable connection in the following order:

                   1. Try to find a connection owned by the user. If there
                        is more than one such connection, try to determine
                        which one is primary. The primary flag is set with
                        the -D option.

                   2. If the primary connection could not be determined, the
                        first shared connection will be used.

     -N Do not prompt for a password. At run time, ncplogin reads the
             ~/.nwfsrc file for additional configuration parameters and a
             password. If no password is found for the specified server:user
             pair, ncplogin prompts for it.

     -O Specify the owner and group attributes for the connection. Newly
             created connections take the owner attribute from the creating
             user's username and the group attribute from the creating user's
             primary group. This option overrides that behaviour. Only the
             superuser can override the owner attribute for a connection.

     -P Mark the connection as permanent. The ncplogin utility always
             creates permanent connections. This option can be used in other
             ncp* programs.

     -R retry_count
             Specify the number of retries to be performed before dropping the
             connection. The default value is 10.

             Note: after a connection is marked `BAD', each request will try
             to restore it. This process restores only the NCP connection; it
             does not reopen any files that were open at the time that the
             connection was marked `BAD'.

     -W timeout
             Specify the server request timeout in seconds. The default is 5
             seconds.

     /server:user
             This syntax is provided for the sake of simplicity and is mutu-
             ally exclusive with the -S and -U options.

IMPLEMENTATION NOTES

     Low level connection management is implemented in the ncp.ko module. The
     IPXrouted(8) program is also required for IPX support.

FILES

     ~/.nwfsrc keeps static parameters for connections and other informa-
                    tion See /usr/share/examples/nwclient/dot.nwfsrc for
                    details.

HISTORY

     The ncplogin command first appeared in FreeBSD 4.0.

AUTHORS

     Boris Popov <email address hidden>, <email address hidden>

BUGS

     Please report any bugs to the author.

FreeBSD 7.0 September 15, 1999 FreeBSD 7.0

===Google search "man ncplogout"===
NAME

     ncplogout -- schedule permanent connection to close

SYNOPSIS

     ncplogout [-S server] [-U user] [-c handle]
     ncplogout [-c handle] /server:user

DESCRIPTION

     The ncplogout utility will schedule a connection created by ncplogin(1)
     command to be closed. If the connection is busy (i.e. used by other pro-
     cesses) it will be closed when the last process using it is terminated.
     This command is similar to the DOS logout.exe command.

     The options are:

     -S server
      Specify the name of the Netware server to which the connection
      should be terminated. Can be omitted if there is only one con-
      nection active.

     -U user
      Specify the name of the user to use when identifying the connec-
      tion. Can be omitted if there is only one connection active.

     -c handle
      Close a connection by handle. A list of available handles can be
      obtained with the following command:

      ncplist c

HISTORY

     The ncplogout utility first appeared in FreeBSD 4.0.

AUTHORS

     Boris Popov <email address hidden>, <email address hidden>

BUGS

     Please report any bugs to the author.

Tags: bitesize

Related branches

Revision history for this message
Dan O'Huiginn (daniel-ohuiginn) wrote :

yep, those man pages are missing. Thanks for the report.

Changed in ncpfs:
importance: Undecided → Low
status: Unconfirmed → Confirmed
Revision history for this message
David Futcher (bobbo) wrote :

Couldnt find the actual man page source for these pages so tried to edit it myself. Heres the debdiff.

Revision history for this message
Luke Yelavich (themuso) wrote :

The manapges aren't quite right. There is markup that you can use for all the options, and you don't need to space them out as they appear on the screen. I would suggest taking a look at other man pages that you have on your system to see how those wre done.

There has also been a new Ubuntu revision of this package since you made your diff. Please also adjust accordingly.

Once you have uploaded a new debdiff, please re-subscribe ubuntu-universe-sponsors when you are ready for sponsoring.

Changed in ncpfs:
assignee: nobody → themuso
status: Confirmed → In Progress
assignee: themuso → nobody
status: In Progress → Incomplete
Revision history for this message
David Futcher (bobbo) wrote :

Assigning myself. Will try and get the proper manpages from upstream/FreeBSD (where they definately exist) and repackage

Changed in ncpfs:
assignee: nobody → bobbo
status: Incomplete → In Progress
Revision history for this message
David Futcher (bobbo) wrote :

No response upstream from Boris Popov (Manpage author). I'll keep looking around but if i cant find anything i'll write my own copy as best i can to look like the others in the package.

Revision history for this message
David Futcher (bobbo) wrote :
Changed in ncpfs:
assignee: bobbo → nobody
Revision history for this message
Steve Stalcup (vorian) wrote :

here goes

Changed in ncpfs:
status: In Progress → Confirmed
Revision history for this message
Mathias Gug (mathiaz) wrote : Re: [Bug 72208] Re: No manual pages for ncplogin and ncplogout in package

On Thu, Feb 07, 2008 at 02:53:53AM -0000, Steve Stalcup wrote:
> here goes
>
> ** Attachment added: "ncpfs_2.2.6-4ubuntu3.debdiff"
> http://launchpadlibrarian.net/11807166/ncpfs_2.2.6-4ubuntu3.debdiff

Thanks for you debdiff. As you've taken the man pages from freebsd,
they're not covered by a GPL license. Could you add a note to
debian/copyright clarifying the license of the two man pages you've
added ?

There are also a couple of other binaries that don't have a man page.
Could you have a look at the freebsd cvs to see if they have some there
?

Once a new debdiff is attached, please re-subscribe
ubuntu-universe-sponsors.

  status incomplete
  unsubscribe ubuntu-universe-sponsors

--
Mathias Gug
Ubuntu Developer http://www.ubuntu.com

Changed in ncpfs:
status: Confirmed → Incomplete
Revision history for this message
Ubuntu User (anotherubuntuuser) wrote : Re: [Bug 72208] Re: No manual pages for ncplogin and ncplogout in package

That's what I was originally wondering.

If they exist for BSD, is there a license issue that restricts them from
being added to the man pages for the Linux counterparts of the same
commands.

If noting the license difference is all that is required, why aren't more of
the "undocumented commands" in the debian archive gaining documentation by
including the BSD docs with the appropriate notifications of license
differences in place?

Thanks for the clarification.

On Feb 7, 2008 3:43 PM, Mathias Gug <email address hidden> wrote:

>
> On Thu, Feb 07, 2008 at 02:53:53AM -0000, Steve Stalcup wrote:
> > here goes
> >
> > ** Attachment added: "ncpfs_2.2.6-4ubuntu3.debdiff"
> > http://launchpadlibrarian.net/11807166/ncpfs_2.2.6-4ubuntu3.debdiff
>
> Thanks for you debdiff. As you've taken the man pages from freebsd,
> they're not covered by a GPL license. Could you add a note to
> debian/copyright clarifying the license of the two man pages you've
> added ?
>
> There are also a couple of other binaries that don't have a man page.
> Could you have a look at the freebsd cvs to see if they have some there
> ?
>
> Once a new debdiff is attached, please re-subscribe
> ubuntu-universe-sponsors.
>
> status incomplete
> unsubscribe ubuntu-universe-sponsors
>
> --
> Mathias Gug
> Ubuntu Developer http://www.ubuntu.com
>
>
> ** Changed in: ncpfs (Ubuntu)
> Status: Confirmed => Incomplete
>
> --
> No manual pages for ncplogin and ncplogout in package
> https://bugs.launchpad.net/bugs/72208
> You received this bug notification because you are a direct subscriber
> of the bug.
>

Revision history for this message
David Futcher (bobbo) wrote :

Subscribed Steve Salcup (~vorian) to the bug as he did the debdiff that only needs a small fix (Adding a mention to the BSD license covering the 2 new man pages) and will hopefully be able to do that for us. Also changing status from 'Incomplete' to 'Confirmed' as the bug report gives us enough information to fix the bug.

Changed in ncpfs:
status: Incomplete → Confirmed
Revision history for this message
Steve Stalcup (vorian) wrote :

There CVS does not have the additional man pages... I'll see If I can whip some up

Changed in ncpfs:
assignee: nobody → vorian
status: Confirmed → In Progress
Revision history for this message
David Futcher (bobbo) wrote :

Had some spare time, so added the mention to BSD license.

Revision history for this message
Steve Stalcup (vorian) wrote :

addition man pages needed

W: ncpfs: binary-without-manpage sbin/mount.ncpfs
W: ncpfs: binary-without-manpage usr/bin/ncpmap
W: ncpfs: binary-without-manpage usr/bin/nwdpvalues

@ David :) - I just updated the Copyright too...

Revision history for this message
David Futcher (bobbo) wrote :

@ Steve, thanks. Ill leave you get on and do the full patch :D

Revision history for this message
Steve Stalcup (vorian) wrote :

That was fun ....

ncpfs (2.2.6-4ubuntu3) hardy; urgency=low

  * Added manpages ncplogin.1 and ncplogout.1 (LP: #72208)
  * Created and added nwdpvalues.1 and ncpmap.1 manpages
  * Added dh_installman to debian/rules
  * Bumped standards version to 3.7.3
  * Added BSD Licence to debian/copyright

Changed in ncpfs:
assignee: vorian → nobody
status: In Progress → Confirmed
Changed in ncpfs:
assignee: nobody → rainct
status: Confirmed → In Progress
Revision history for this message
Siegfried Gevatter (rainct) wrote :

Uploaded with additional changes.

Thanks!

Changed in ncpfs:
status: In Progress → Fix Committed
Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package ncpfs - 2.2.6-4ubuntu3

---------------
ncpfs (2.2.6-4ubuntu3) hardy; urgency=low

  [ Steve Stalcup ]
  * Added manpages ncplogin.1 and ncplogout.1 (LP: #72208)
  * Created and added nwdpvalues.1 and ncpmap.1 manpages
  * Added dh_installman to debian/rules
  * Bumped standards version to 3.7.3
  * Added BSD Licence to debian/copyright

  [ Siegfried-Angel Gevatter Pujals (RainCT) ]
  * debian/manpage/:
     - Fix some formatting issues with the manpages.
  * debian/rules:
     - Remove "export DH_COMPAT=5" (and create a debian/compat file instead)
     - Do not ignore errors from "make distclean".
  * debian/control:
     - Move Homepage field to source stanza.
     - Replace ${Source-Version} with ${source:Version}.

 -- Steve Stalcup <email address hidden> Fri, 22 Feb 2008 11:13:34 -0500

Changed in ncpfs:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.