From fa7361b62138583c3b5880b7fb313ed60c289e24 Mon Sep 17 00:00:00 2001 From: Samba Release Account Date: Thu, 1 Aug 1996 19:25:01 +0000 Subject: updated doc files to include a GPL header, with revision history in it. added created and tridge comments on first revision first kick-off in revision history. lkcl (This used to be commit 70d3d3bbf0bca2d7093517c79fd4c6db3f004799) --- source3/nameannounce.doc | 31 +++++++++++++++++++++++++++++++ source3/namebrowse.doc | 30 ++++++++++++++++++++++++++++++ source3/namedbname.doc | 27 +++++++++++++++++++++++++++ source3/namedbresp.doc | 30 ++++++++++++++++++++++++++++++ source3/nameelect.doc | 29 +++++++++++++++++++++++++++++ source3/namelogon.doc | 27 +++++++++++++++++++++++++++ source3/namepacket.doc | 27 +++++++++++++++++++++++++++ source3/namequery.doc | 29 ++++++++++++++++++++++++++++- source3/nameresp.doc | 27 +++++++++++++++++++++++++++ source3/nameserv.doc | 27 +++++++++++++++++++++++++++ source3/nameservreply.doc | 27 +++++++++++++++++++++++++++ source3/nameservresp.doc | 27 +++++++++++++++++++++++++++ source3/namework.doc | 29 +++++++++++++++++++++++++++++ 13 files changed, 366 insertions(+), 1 deletion(-) diff --git a/source3/nameannounce.doc b/source3/nameannounce.doc index 41759526c6..afc4850a1f 100644 --- a/source3/nameannounce.doc +++ b/source3/nameannounce.doc @@ -1,3 +1,34 @@ +/* + Unix SMB/Netbios documentation. + Version 0.1 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: nameannounce.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created + + 0.1 - 22jul96 : Andrew.Tridgell@anu.edu.au + tridge's comments on first revision +*/ + + this module deals with announcements: the sending of announcement requests and the sending of announcements either to refresh other servers' records or as a response to announcement requests. diff --git a/source3/namebrowse.doc b/source3/namebrowse.doc index 44b76dd43f..cef41ee4d2 100644 --- a/source3/namebrowse.doc +++ b/source3/namebrowse.doc @@ -1,3 +1,33 @@ +/* + Unix SMB/Netbios documentation. + Version 0.1 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: namebrowse.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created + + 0.1 - 22jul96 Andrew.Tridgell@anu.edu.au + tridge's comments on first revision +*/ + this module deals with queueing servers that samba must sync browse lists with. it will always issue a name query immediately before actually carrying out the NetServerEnum call, to ensure that time diff --git a/source3/namedbname.doc b/source3/namedbname.doc index 3419fe1818..df47cbf08e 100644 --- a/source3/namedbname.doc +++ b/source3/namedbname.doc @@ -1,3 +1,30 @@ +/* + Unix SMB/Netbios documentation. + Version 0.0 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: namedbname.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created +*/ + this module deals with the NetBIOS name database for samba. it deals directly with adding, removing, finding, loading and saving of names. diff --git a/source3/namedbresp.doc b/source3/namedbresp.doc index 4913d39e0e..a54c070275 100644 --- a/source3/namedbresp.doc +++ b/source3/namedbresp.doc @@ -1,3 +1,33 @@ +/* + Unix SMB/Netbios documentation. + Version 0.1 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: namedbresp.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created + + 0.1 - 22jul96 Andrew.Tridgell@anu.edu.au + tridge's comments on first revision +*/ + module namedbresp deals with the maintenance of the list of expected responses - creating, finding and removal. diff --git a/source3/nameelect.doc b/source3/nameelect.doc index 4b50c4a184..ecc00c7234 100644 --- a/source3/nameelect.doc +++ b/source3/nameelect.doc @@ -1,3 +1,32 @@ +/* + Unix SMB/Netbios documentation. + Version 0.1 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: nameelect.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created + + 0.1 - 22jul96 Andrew.Tridgell@anu.edu.au + tridge's comments on first revision +*/ the module nameelect.c deals with initiating, winning, losing browsing elections, and checking if browsers are still around, diff --git a/source3/namelogon.doc b/source3/namelogon.doc index 0b17d135ab..c4a97d0cf1 100644 --- a/source3/namelogon.doc +++ b/source3/namelogon.doc @@ -1,3 +1,30 @@ +/* + Unix SMB/Netbios documentation. + Version 0.0 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: namelogon.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created +*/ + this module deals with the first stage of domain logons. there is much more work to be done on this: it's all totally undocumented. diff --git a/source3/namepacket.doc b/source3/namepacket.doc index c9ec19418b..159a50738c 100644 --- a/source3/namepacket.doc +++ b/source3/namepacket.doc @@ -1,3 +1,30 @@ +/* + Unix SMB/Netbios documentation. + Version 0.0 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: namepacket.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created +*/ + this module deals with packets: sending, receiving, queueing and some basic interpretation (e.g it excludes datagram error packets at the moment). diff --git a/source3/namequery.doc b/source3/namequery.doc index 77a75714e5..4337cfb7e2 100644 --- a/source3/namequery.doc +++ b/source3/namequery.doc @@ -1,3 +1,30 @@ +/* + Unix SMB/Netbios documentation. + Version 0.0 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: namequery.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created +*/ + this module contains non-threaded versions of name status and name query functions. if a multi-threaded nmbd was to be written, these functions would be the starting point. @@ -33,7 +60,7 @@ forwarder of queries (or to use samba's WINS capabilities) then a query could be made without needing access to the priveleged ports. in order to do this properly, samba must implement secured netbios name server functionality (see rfc1001.txt 15.1.6). - +(lkcl 01aug96: samba now supports secured name registration) /************************************************************************* name_query() diff --git a/source3/nameresp.doc b/source3/nameresp.doc index 23340a8c28..cfe63500c8 100644 --- a/source3/nameresp.doc +++ b/source3/nameresp.doc @@ -1,3 +1,30 @@ +/* + Unix SMB/Netbios documentation. + Version 0.0 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: nameresp.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created +*/ + the netbios expected response code is a key part of samba's NetBIOS handling capabilities. it allows samba to carry on dealing with other things while expecting a response from one or more hosts. diff --git a/source3/nameserv.doc b/source3/nameserv.doc index 71e5c980c6..af4934ade2 100644 --- a/source3/nameserv.doc +++ b/source3/nameserv.doc @@ -1,3 +1,30 @@ +/* + Unix SMB/Netbios documentation. + Version 0.0 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: nameserv.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created +*/ + this module deals with general maintenance of NetBIOS names. /************************************************************************* diff --git a/source3/nameservreply.doc b/source3/nameservreply.doc index 56a5d160f6..26b8a0a1e7 100644 --- a/source3/nameservreply.doc +++ b/source3/nameservreply.doc @@ -1,3 +1,30 @@ +/* + Unix SMB/Netbios documentation. + Version 0.0 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: nameservreply.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created +*/ + /************************************************************************* reply_name_query() *************************************************************************/ diff --git a/source3/nameservresp.doc b/source3/nameservresp.doc index f50f3a7c4f..0d6a4ee8c1 100644 --- a/source3/nameservresp.doc +++ b/source3/nameservresp.doc @@ -1,3 +1,30 @@ +/* + Unix SMB/Netbios documentation. + Version 0.0 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: nameservresp.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created +*/ + this module deals with the receipt of response packets. the response packets are expected to be received, and there is a record of this kept (see also: modules nameresp and namedbresp) diff --git a/source3/namework.doc b/source3/namework.doc index 55dca2cf01..6bc872a5f2 100644 --- a/source3/namework.doc +++ b/source3/namework.doc @@ -1,3 +1,32 @@ +/* + Unix SMB/Netbios documentation. + Version 0.1 + Copyright (C) Luke Leighton Andrew Tridgell 1996 + + 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 of the License, 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. + + Document name: namework.doc + + Revision History: + + 0.0 - 02jul96 : lkcl@pires.co.uk + created + + 0.1 - 22jul96 Andrew.Tridgell@anu.edu.au + tridge's comments on first revision +*/ the module namework.c deals with NetBIOS datagram packets, primarily. it deals with nmbd's workgroup browser side and the domain log in -- cgit