Project

General

Profile

Feature #19221

Add appendix to documentation that contains smb.conf manpage for version of Samba shipping with FreeNAS

Added by an odos over 2 years ago. Updated over 2 years ago.

Status:
Resolved
Priority:
Nice to have
Assignee:
Warren Block
Category:
Documentation
Target version:
Estimated time:
Severity:
New
Reason for Closing:
Reason for Blocked:
Needs QA:
Yes
Needs Doc:
Yes
Needs Merging:
Yes
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:

Description

The smb.conf manpage on Samba's website is crazy out of date. Default parameters (and even what parameters actually do) can vary between samba versions. See "smb encrypt". The manpage included with samba is (I hope) always the correct version for the version of Samba with which it is packaged. It would be nice to have the correct version of the smb.conf manpage somewhere in the docs as an appendix / reference.

Example of crappy out-of-date manpage - https://www.samba.org/samba/docs/man/manpages/smb.conf.5.html

History

#1 Updated by Dru Lavigne over 2 years ago

  • Status changed from Unscreened to Screened
  • Assignee set to Dru Lavigne
  • Priority changed from No priority to Nice to have
  • Target version set to 9.10.2-U1

#2 Updated by Warren Block over 2 years ago

  • Status changed from Screened to Resolved

If there is an online source, we can link to that. We can't link to a local file because it won't necessarily exist. For now, changing links from the poorly-rendered sloop version to the Samba site version.

#3 Updated by Dru Lavigne over 2 years ago

  • Assignee changed from Dru Lavigne to Warren Block
  • Target version changed from 9.10.2-U1 to 9.10.2

#4 Updated by an odos over 2 years ago

Warren Block wrote:

If there is an online source, we can link to that. We can't link to a local file because it won't necessarily exist. For now, changing links from the poorly-rendered sloop version to the Samba site version.

This isn't a very good solution. In addition to being poorly rendered, the sloop version is also out of date / incorrect.

You're better off just linking to the relevant samba project github page if you're going that route: https://github.com/samba-team/samba/blob/v4-3-stable/docs-xml/manpages/smb.conf.5.xml

#5 Updated by Warren Block over 2 years ago

The raw XML in that page is pretty hard to read. For now, I have set these links to go to the rendered version of the man page from the port on the FreeBSD.org site.

Also available in: Atom PDF