diff options
262 files changed, 62759 insertions, 0 deletions
diff --git a/docs/docbook/devdoc/CodingSuggestions.xml b/docs/docbook/devdoc/CodingSuggestions.xml new file mode 100644 index 0000000000..bdf6d3d17d --- /dev/null +++ b/docs/docbook/devdoc/CodingSuggestions.xml @@ -0,0 +1,237 @@ +<chapter id="CodingSuggestions"> +<chapterinfo> + <author> + <firstname>Steve</firstname><surname>French</surname> + </author> + <author> + <firstname>Simo</firstname><surname>Sorce</surname> + </author> + <author> + <firstname>Andrew</firstname><surname>Bartlett</surname> + </author> + <author> + <firstname>Tim</firstname><surname>Potter</surname> + </author> + <author> + <firstname>Martin</firstname><surname>Pool</surname> + </author> +</chapterinfo> + +<title>Coding Suggestions</title> + +<para> +So you want to add code to Samba ... +</para> + +<para> +One of the daunting tasks facing a programmer attempting to write code for +Samba is understanding the various coding conventions used by those most +active in the project. These conventions were mostly unwritten and helped +improve either the portability, stability or consistency of the code. This +document will attempt to document a few of the more important coding +practices used at this time on the Samba project. The coding practices are +expected to change slightly over time, and even to grow as more is learned +about obscure portability considerations. Two existing documents +<filename>samba/source/internals.doc</filename> and +<filename>samba/source/architecture.doc</filename> provide +additional information. +</para> + +<para> +The loosely related question of coding style is very personal and this +document does not attempt to address that subject, except to say that I +have observed that eight character tabs seem to be preferred in Samba +source. If you are interested in the topic of coding style, two oft-quoted +documents are: +</para> + +<para> +<ulink url="http://lxr.linux.no/source/Documentation/CodingStyle">http://lxr.linux.no/source/Documentation/CodingStyle</ulink> +</para> + +<para> +<ulink url="http://www.fsf.org/prep/standards_toc.html">http://www.fsf.org/prep/standards_toc.html</ulink> +</para> + +<para> +But note that coding style in Samba varies due to the many different +programmers who have contributed. +</para> + +<para> +Following are some considerations you should use when adding new code to +Samba. First and foremost remember that: +</para> + +<para> +Portability is a primary consideration in adding function, as is network +compatability with de facto, existing, real world CIFS/SMB implementations. +There are lots of platforms that Samba builds on so use caution when adding +a call to a library function that is not invoked in existing Samba code. +Also note that there are many quite different SMB/CIFS clients that Samba +tries to support, not all of which follow the SNIA CIFS Technical Reference +(or the earlier Microsoft reference documents or the X/Open book on the SMB +Standard) perfectly. +</para> + +<para> +Here are some other suggestions: +</para> + +<orderedlist> + +<listitem><para> + use d_printf instead of printf for display text + reason: enable auto-substitution of translated language text +</para></listitem> + +<listitem><para> + use SAFE_FREE instead of free + reason: reduce traps due to null pointers +</para></listitem> + +<listitem><para> + don't use bzero use memset, or ZERO_STRUCT and ZERO_STRUCTP macros + reason: not POSIX +</para></listitem> + +<listitem><para> + don't use strcpy and strlen (use safe_* equivalents) + reason: to avoid traps due to buffer overruns +</para></listitem> + +<listitem><para> + don't use getopt_long, use popt functions instead + reason: portability +</para></listitem> + +<listitem><para> + explicitly add const qualifiers on parm passing in functions where parm + is input only (somewhat controversial but const can be #defined away) +</para></listitem> + +<listitem><para> + when passing a va_list as an arg, or assigning one to another + please use the VA_COPY() macro + reason: on some platforms, va_list is a struct that must be + initialized in each function...can SEGV if you don't. +</para></listitem> + +<listitem><para> + discourage use of threads + reason: portability (also see architecture.doc) +</para></listitem> + +<listitem><para> + don't explicitly include new header files in C files - new h files + should be included by adding them once to includes.h + reason: consistency +</para></listitem> + +<listitem><para> + don't explicitly extern functions (they are autogenerated by + "make proto" into proto.h) + reason: consistency +</para></listitem> + +<listitem><para> + use endian safe macros when unpacking SMBs (see byteorder.h and + internals.doc) + reason: not everyone uses Intel +</para></listitem> + +<listitem><para> + Note Unicode implications of charset handling (see internals.doc). See + pull_* and push_* and convert_string functions. + reason: Internationalization +</para></listitem> + +<listitem><para> + Don't assume English only + reason: See above +</para></listitem> + +<listitem><para> + Try to avoid using in/out parameters (functions that return data which + overwrites input parameters) + reason: Can cause stability problems +</para></listitem> + +<listitem><para> + Ensure copyright notices are correct, don't append Tridge's name to code + that he didn't write. If you did not write the code, make sure that it + can coexist with the rest of the Samba GPLed code. +</para></listitem> + +<listitem><para> + Consider usage of DATA_BLOBs for length specified byte-data. + reason: stability +</para></listitem> + +<listitem><para> + Take advantage of tdbs for database like function + reason: consistency +</para></listitem> + +<listitem><para> + Don't access the SAM_ACCOUNT structure directly, they should be accessed + via pdb_get...() and pdb_set...() functions. + reason: stability, consistency +</para></listitem> + +<listitem><para> + Don't check a password directly against the passdb, always use the + check_password() interface. + reason: long term pluggability +</para></listitem> + +<listitem><para> + Try to use asprintf rather than pstrings and fstrings where possible +</para></listitem> + +<listitem><para> + Use normal C comments / * instead of C++ comments // like + this. Although the C++ comment format is part of the C99 + standard, some older vendor C compilers do not accept it. +</para></listitem> + +<listitem><para> + Try to write documentation for API functions and structures + explaining the point of the code, the way it should be used, and + any special conditions or results. Mark these with a double-star + comment start / ** so that they can be picked up by Doxygen, as in + this file. +</para></listitem> + +<listitem><para> + Keep the scope narrow. This means making functions/variables + static whenever possible. We don't want our namespace + polluted. Each module should have a minimal number of externally + visible functions or variables. +</para></listitem> + +<listitem><para> + Use function pointers to keep knowledge about particular pieces of + code isolated in one place. We don't want a particular piece of + functionality to be spread out across lots of places - that makes + for fragile, hand to maintain code. Instead, design an interface + and use tables containing function pointers to implement specific + functionality. This is particularly important for command + interpreters. +</para></listitem> + +<listitem><para> + Think carefully about what it will be like for someone else to add + to and maintain your code. If it would be hard for someone else to + maintain then do it another way. +</para></listitem> + +</orderedlist> + +<para> +The suggestions above are simply that, suggestions, but the information may +help in reducing the routine rework done on new code. The preceeding list +is expected to change routinely as new support routines and macros are +added. +</para> +</chapter> diff --git a/docs/docbook/devdoc/NetBIOS.xml b/docs/docbook/devdoc/NetBIOS.xml new file mode 100644 index 0000000000..6b4eb34b76 --- /dev/null +++ b/docs/docbook/devdoc/NetBIOS.xml @@ -0,0 +1,154 @@ +<chapter id="netbios"> +<chapterinfo> + <author> + <firstname>Luke</firstname><surname>Leighton</surname> + </author> + <pubdate>12 June 1997</pubdate> +</chapterinfo> + +<title>Definition of NetBIOS Protocol and Name Resolution Modes</title> + +<sect1> +<title>NETBIOS</title> + +<para> +NetBIOS runs over the following tranports: TCP/IP; NetBEUI and IPX/SPX. +Samba only uses NetBIOS over TCP/IP. For details on the TCP/IP NetBIOS +Session Service NetBIOS Datagram Service, and NetBIOS Names, see +rfc1001.txt and rfc1002.txt. +</para> + +<para> +NetBEUI is a raw NetBIOS frame protocol implementation that allows NetBIOS +datagrams to be sent out over the 'wire' embedded within LLC frames. +NetBEUI is not required when using NetBIOS over TCP/IP protocols and it +is preferable NOT to install NetBEUI if it can be avoided. +</para> + +<para> +IPX/SPX is also not required when using NetBIOS over TCP/IP, and it is +preferable NOT to install the IPX/SPX transport unless you are using Novell +servers. At the very least, it is recommended that you do not install +'NetBIOS over IPX/SPX'. +</para> + +<para> +[When installing Windows 95, you will find that NetBEUI and IPX/SPX are +installed as the default protocols. This is because they are the simplest +to manage: no Windows 95 user-configuration is required]. +</para> + +<para> +NetBIOS applications (such as samba) offer their services (for example, +SMB file and print sharing) on a NetBIOS name. They must claim this name +on the network before doing so. The NetBIOS session service will then +accept connections on the application's behalf (on the NetBIOS name +claimed by the application). A NetBIOS session between the application +and the client can then commence. +</para> + +<para> +NetBIOS names consist of 15 characters plus a 'type' character. This is +similar, in concept, to an IP address and a TCP port number, respectively. +A NetBIOS-aware application on a host will offer different services under +different NetBIOS name types, just as a host will offer different TCP/IP +services on different port numbers. +</para> + +<para> +NetBIOS names must be claimed on a network, and must be defended. The use +of NetBIOS names is most suitable on a single subnet; a Local Area Network +or a Wide Area Network. +</para> + +<para> +NetBIOS names are either UNIQUE or GROUP. Only one application can claim a +UNIQUE NetBIOS name on a network. +</para> + +<para> +There are two kinds of NetBIOS Name resolution: Broadcast and Point-to-Point. +</para> + +</sect1> + +<sect1> +<title>BROADCAST NetBIOS</title> + +<para> +Clients can claim names, and therefore offer services on successfully claimed +names, on their broadcast-isolated subnet. One way to get NetBIOS services +(such as browsing: see ftp.microsoft.com/drg/developr/CIFS/browdiff.txt; and +SMB file/print sharing: see cifs4.txt) working on a LAN or WAN is to make +your routers forward all broadcast packets from TCP/IP ports 137, 138 and 139. +</para> + +<para> +This, however, is not recommended. If you have a large LAN or WAN, you will +find that some of your hosts spend 95 percent of their time dealing with +broadcast traffic. [If you have IPX/SPX on your LAN or WAN, you will find +that this is already happening: a packet analyzer will show, roughly +every twelve minutes, great swathes of broadcast traffic!]. +</para> + +</sect1> + +<sect1> +<title>NBNS NetBIOS</title> + +<para> +rfc1001.txt describes, amongst other things, the implementation and use +of, a 'NetBIOS Name Service'. NT/AS offers 'Windows Internet Name Service' +which is fully rfc1001/2 compliant, but has had to take specific action +with certain NetBIOS names in order to make it useful. (for example, it +deals with the registration of <1c> <1d> <1e> names all in different ways. +I recommend the reading of the Microsoft WINS Server Help files for full +details). +</para> + +<para> +The use of a WINS server cuts down on broadcast network traffic for +NetBIOS name resolution. It has the effect of pulling all the broadcast +isolated subnets together into a single NetBIOS scope, across your LAN +or WAN, while avoiding the use of TCP/IP broadcast packets. +</para> + +<para> +When you have a WINS server on your LAN, WINS clients will be able to +contact the WINS server to resolve NetBIOS names. Note that only those +WINS clients that have registered with the same WINS server will be +visible. The WINS server _can_ have static NetBIOS entries added to its +database (usually for security reasons you might want to consider putting +your domain controllers or other important servers as static entries, +but you should not rely on this as your sole means of security), but for +the most part, NetBIOS names are registered dynamically. +</para> + +<para> +This provides some confusion for lots of people, and is worth mentioning +here: a Browse Server is NOT a WINS Server, even if these services are +implemented in the same application. A Browse Server _needs_ a WINS server +because a Browse Server is a WINS client, which is _not_ the same thing]. +</para> + +<para> +Clients can claim names, and therefore offer services on successfully claimed +names, on their broadcast-isolated subnet. One way to get NetBIOS services +(such as browsing: see ftp.microsoft.com/drg/developr/CIFS/browdiff.txt; and +SMB file/print sharing: see cifs6.txt) working on a LAN or WAN is to make +your routers forward all broadcast packets from TCP/IP ports 137, 138 and 139. +You will find, however, if you do this on a large LAN or a WAN, that your +network is completely swamped by NetBIOS and browsing packets, which is why +WINS was developed to minimise the necessity of broadcast traffic. +</para> + +<para> +WINS Clients therefore claim names from the WINS server. If the WINS +server allows them to register a name, the client's NetBIOS session service +can then offer services on this name. Other WINS clients will then +contact the WINS server to resolve a NetBIOS name. +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/devdoc/Tracing.xml b/docs/docbook/devdoc/Tracing.xml new file mode 100644 index 0000000000..ccf1e1c3c8 --- /dev/null +++ b/docs/docbook/devdoc/Tracing.xml @@ -0,0 +1,129 @@ +<chapter id="tracing"> +<chapterinfo> + <author> + <firstname>Andrew</firstname><surname>Tridgell</surname> + <affiliation> + <orgname>Samba Team</orgname> + </affiliation> + </author> +</chapterinfo> + +<title>Tracing samba system calls</title> + +<para> +This file describes how to do a system call trace on Samba to work out +what its doing wrong. This is not for the faint of heart, but if you +are reading this then you are probably desperate. +</para> + +<para> +Actually its not as bad as the the above makes it sound, just don't +expect the output to be very pretty :-) +</para> + +<para> +Ok, down to business. One of the big advantages of unix systems is +that they nearly all come with a system trace utility that allows you +to monitor all system calls that a program is making. This is +extremely using for debugging and also helps when trying to work out +why something is slower than you expect. You can use system tracing +without any special compilation options. +</para> + +<para> +The system trace utility is called different things on different +systems. On Linux systems its called strace. Under SunOS 4 its called +trace. Under SVR4 style systems (including solaris) its called +truss. Under many BSD systems its called ktrace. +</para> + +<para> +The first thing you should do is read the man page for your native +system call tracer. In the discussion below I'll assume its called +strace as strace is the only portable system tracer (its available for +free for many unix types) and its also got some of the nicest +features. +</para> + +<para> +Next, try using strace on some simple commands. For example, <command>strace +ls</command> or <command>strace echo hello</command>. +</para> + +<para> +You'll notice that it produces a LOT of output. It is showing you the +arguments to every system call that the program makes and the +result. Very little happens in a program without a system call so you +get lots of output. You'll also find that it produces a lot of +"preamble" stuff showing the loading of shared libraries etc. Ignore +this (unless its going wrong!) +</para> + +<para> +For example, the only line that really matters in the <command>strace echo +hello</command> output is: +</para> + +<para><programlisting> +write(1, "hello\n", 6) = 6 +</programlisting></para> + +<para>all the rest is just setting up to run the program.</para> + +<para> +Ok, now you're familiar with strace. To use it on Samba you need to +strace the running smbd daemon. The way I tend ot use it is to first +login from my Windows PC to the Samba server, then use smbstatus to +find which process ID that client is attached to, then as root I do +<command>strace -p PID</command> to attach to that process. I normally redirect the +stderr output from this command to a file for later perusal. For +example, if I'm using a csh style shell: +</para> + +<para><command>strace -f -p 3872 >& strace.out</command></para> + +<para>or with a sh style shell:</para> + +<para><command>strace -f -p 3872 > strace.out 2>&1</command></para> + +<para> +Note the "-f" option. This is only available on some systems, and +allows you to trace not just the current process, but any children it +forks. This is great for finding printing problems caused by the +"print command" being wrong. +</para> + +<para> +Once you are attached you then can do whatever it is on the client +that is causing problems and you will capture all the system calls +that smbd makes. +</para> + +<para> +So how do you interpret the results? Generally I search through the +output for strings that I know will appear when the problem +happens. For example, if I am having touble with permissions on a file +I would search for that files name in the strace output and look at +the surrounding lines. Another trick is to match up file descriptor +numbers and "follow" what happens to an open file until it is closed. +</para> + +<para> +Beyond this you will have to use your initiative. To give you an idea +of what you are looking for here is a piece of strace output that +shows that <filename>/dev/null</filename> is not world writeable, which +causes printing to fail with Samba: +</para> + +<para><programlisting> +[pid 28268] open("/dev/null", O_RDWR) = -1 EACCES (Permission denied) +[pid 28268] open("/dev/null", O_WRONLY) = -1 EACCES (Permission denied) +</programlisting></para> + +<para> +The process is trying to first open <filename>/dev/null</filename> read-write +then read-only. Both fail. This means <filename>/dev/null</filename> has +incorrect permissions. +</para> + +</chapter> diff --git a/docs/docbook/devdoc/architecture.xml b/docs/docbook/devdoc/architecture.xml new file mode 100644 index 0000000000..312a63af97 --- /dev/null +++ b/docs/docbook/devdoc/architecture.xml @@ -0,0 +1,184 @@ +<chapter id="architecture"> +<chapterinfo> + <author> + <firstname>Dan</firstname><surname>Shearer</surname> + </author> + <pubdate> November 1997</pubdate> +</chapterinfo> + +<title>Samba Architecture</title> + +<sect1> +<title>Introduction</title> + +<para> +This document gives a general overview of how Samba works +internally. The Samba Team has tried to come up with a model which is +the best possible compromise between elegance, portability, security +and the constraints imposed by the very messy SMB and CIFS +protocol. +</para> + +<para> +It also tries to answer some of the frequently asked questions such as: +</para> + +<orderedlist> +<listitem><para> + Is Samba secure when running on Unix? The xyz platform? + What about the root priveliges issue? +</para></listitem> + +<listitem><para>Pros and cons of multithreading in various parts of Samba</para></listitem> + +<listitem><para>Why not have a separate process for name resolution, WINS, and browsing?</para></listitem> + +</orderedlist> + +</sect1> + +<sect1> +<title>Multithreading and Samba</title> + +<para> +People sometimes tout threads as a uniformly good thing. They are very +nice in their place but are quite inappropriate for smbd. nmbd is +another matter, and multi-threading it would be very nice. +</para> + +<para> +The short version is that smbd is not multithreaded, and alternative +servers that take this approach under Unix (such as Syntax, at the +time of writing) suffer tremendous performance penalties and are less +robust. nmbd is not threaded either, but this is because it is not +possible to do it while keeping code consistent and portable across 35 +or more platforms. (This drawback also applies to threading smbd.) +</para> + +<para> +The longer versions is that there are very good reasons for not making +smbd multi-threaded. Multi-threading would actually make Samba much +slower, less scalable, less portable and much less robust. The fact +that we use a separate process for each connection is one of Samba's +biggest advantages. +</para> + +</sect1> + +<sect1> +<title>Threading smbd</title> + +<para> +A few problems that would arise from a threaded smbd are: +</para> + +<orderedlist> +<listitem><para> + It's not only to create threads instead of processes, but you + must care about all variables if they have to be thread specific + (currently they would be global). +</para></listitem> + +<listitem><para> + if one thread dies (eg. a seg fault) then all threads die. We can + immediately throw robustness out the window. +</para></listitem> + +<listitem><para> + many of the system calls we make are blocking. Non-blocking + equivalents of many calls are either not available or are awkward (and + slow) to use. So while we block in one thread all clients are + waiting. Imagine if one share is a slow NFS filesystem and the others + are fast, we will end up slowing all clients to the speed of NFS. +</para></listitem> + +<listitem><para> + you can't run as a different uid in different threads. This means + we would have to switch uid/gid on _every_ SMB packet. It would be + horrendously slow. +</para></listitem> + +<listitem><para> + the per process file descriptor limit would mean that we could only + support a limited number of clients. +</para></listitem> + +<listitem><para> + we couldn't use the system locking calls as the locking context of + fcntl() is a process, not a thread. +</para></listitem> + +</orderedlist> + +</sect1> + +<sect1> +<title>Threading nmbd</title> + +<para> +This would be ideal, but gets sunk by portability requirements. +</para> + +<para> +Andrew tried to write a test threads library for nmbd that used only +ansi-C constructs (using setjmp and longjmp). Unfortunately some OSes +defeat this by restricting longjmp to calling addresses that are +shallower than the current address on the stack (apparently AIX does +this). This makes a truly portable threads library impossible. So to +support all our current platforms we would have to code nmbd both with +and without threads, and as the real aim of threads is to make the +code clearer we would not have gained anything. (it is a myth that +threads make things faster. threading is like recursion, it can make +things clear but the same thing can always be done faster by some +other method) +</para> + +<para> +Chris tried to spec out a general design that would abstract threading +vs separate processes (vs other methods?) and make them accessible +through some general API. This doesn't work because of the data +sharing requirements of the protocol (packets in the future depending +on packets now, etc.) At least, the code would work but would be very +clumsy, and besides the fork() type model would never work on Unix. (Is there an OS that it would work on, for nmbd?) +</para> + +<para> +A fork() is cheap, but not nearly cheap enough to do on every UDP +packet that arrives. Having a pool of processes is possible but is +nasty to program cleanly due to the enormous amount of shared data (in +complex structures) between the processes. We can't rely on each +platform having a shared memory system. +</para> + +</sect1> + +<sect1> +<title>nbmd Design</title> + +<para> +Originally Andrew used recursion to simulate a multi-threaded +environment, which use the stack enormously and made for really +confusing debugging sessions. Luke Leighton rewrote it to use a +queuing system that keeps state information on each packet. The +first version used a single structure which was used by all the +pending states. As the initialisation of this structure was +done by adding arguments, as the functionality developed, it got +pretty messy. So, it was replaced with a higher-order function +and a pointer to a user-defined memory block. This suddenly +made things much simpler: large numbers of functions could be +made static, and modularised. This is the same principle as used +in NT's kernel, and achieves the same effect as threads, but in +a single process. +</para> + +<para> +Then Jeremy rewrote nmbd. The packet data in nmbd isn't what's on the +wire. It's a nice format that is very amenable to processing but still +keeps the idea of a distinct packet. See "struct packet_struct" in +nameserv.h. It has all the detail but none of the on-the-wire +mess. This makes it ideal for using in disk or memory-based databases +for browsing and WINS support. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/cifsntdomain.xml b/docs/docbook/devdoc/cifsntdomain.xml new file mode 100644 index 0000000000..7c3c22d106 --- /dev/null +++ b/docs/docbook/devdoc/cifsntdomain.xml @@ -0,0 +1,2932 @@ +<chapter id="ntdomain"> +<chapterinfo> + <author> + <firstname>Luke</firstname><surname>Leighton</surname> + <affiliation><address><email>lkcl@switchboard.net</email></address></affiliation> + </author> + <author> + <firstname>Paul</firstname><surname>Ashton</surname> + <affiliation><address><email>paul@argo.demon.co.uk</email></address></affiliation> + </author> + <author> + <firstname>Duncan</firstname><surname>Stansfield</surname> + <affiliation><address><email>duncans@sco.com</email></address></affiliation> + </author> + + <pubdate>01 November 97(version 0.0.24)</pubdate> +</chapterinfo> + +<title>NT Domain RPC's</title> + +<sect1> +<title>Introduction</title> + + +<para> +This document contains information to provide an NT workstation with login +services, without the need for an NT server. It is the sgml version of <ulink url="http://mailhost.cb1.com/~lkcl/cifsntdomain.txt">http://mailhost.cb1.com/~lkcl/cifsntdomain.txt</ulink>, controlled by Luke. +</para> + +<para> +It should be possible to select a domain instead of a workgroup (in the NT +workstation's TCP/IP settings) and after the obligatory reboot, type in a +username, password, select a domain and successfully log in. I would +appreciate any feedback on your experiences with this process, and any +comments, corrections and additions to this document. +</para> + +<para> +The packets described here can be easily derived from (and are probably +better understood using) Netmon.exe. You will need to use the version +of Netmon that matches your system, in order to correctly decode the +NETLOGON, lsarpc and srvsvc Transact pipes. This document is derived from +NT Service Pack 1 and its corresponding version of Netmon. It is intended +that an annotated packet trace be produced, which will likely be more +instructive than this document. +</para> + +<para> +Also needed, to fully implement NT Domain Login Services, is the +document describing the cryptographic part of the NT authentication. +This document is available from comp.protocols.smb; from the ntsecurity.net +digest and from the samba digest, amongst other sources. +</para> + +<para> +A copy is available from: +</para> + +<para><ulink url="http://ntbugtraq.rc.on.ca/SCRIPTS/WA.EXE?A2=ind9708;L=ntbugtraq;O=A;P=2935">http://ntbugtraq.rc.on.ca/SCRIPTS/WA.EXE?A2=ind9708;L=ntbugtraq;O=A;P=2935</ulink></para> + +<para><ulink url="http://mailhost.cb1.com/~lkcl/crypt.html">http://mailhost.cb1.com/~lkcl/crypt.html</ulink></para> + +<para> +A c-code implementation, provided by <ulink url="mailto:linus@incolumitas.se">Linus Nordberg</ulink> +of this protocol is available from: +</para> + +<para><ulink url="http://samba.org/cgi-bin/mfs/01/digest/1997/97aug/0391.html">http://samba.org/cgi-bin/mfs/01/digest/1997/97aug/0391.html</ulink></para> +<para><ulink url="http://mailhost.cb1.com/~lkcl/crypt.txt">http://mailhost.cb1.com/~lkcl/crypt.txt</ulink></para> + +<para> +Also used to provide debugging information is the Check Build version of +NT workstation, and enabling full debugging in NETLOGON. This is +achieved by setting the following REG_SZ registry key to 0x1ffffff: +</para> + +<para><filename>HKLM\SYSTEM\CurrentControlSet\Services\Netlogon\Parameters</filename></para> + +<para><emphasis>Incorrect direct editing of the registry can cause your +machine to fail. Then again, so can incorrect implementation of this +protocol. See "Liability:" above.</emphasis></para> + +<para> +Bear in mind that each packet over-the-wire will have its origin in an +API call. Therefore, there are likely to be structures, enumerations +and defines that are usefully documented elsewhere. +</para> + +<para> +This document is by no means complete or authoritative. Missing sections +include, but are not limited to: +</para> + + +<orderedlist> + +<listitem><para>Mappings of RIDs to usernames (and vice-versa).</para></listitem> + +<listitem><para>What a User ID is and what a Group ID is.</para></listitem> + +<listitem><para>The exact meaning/definition of various magic constants or enumerations.</para></listitem> + +<listitem><para>The reply error code and use of that error code when a +workstation becomes a member of a domain (to be described later). +Failure to return this error code will make the workstation report +that it is already a member of the domain.</para></listitem> + +<listitem><para>the cryptographic side of the NetrServerPasswordSet command, +which would allow the workstation to change its password. This password is +used to generate the long-term session key. [It is possible to reject this +command, and keep the default workstation password].</para></listitem> + +</orderedlist> + +<sect2> +<title>Sources</title> + +<simplelist> +<member>cket Traces from Netmonitor (Service Pack 1 and above)</member> +<member>ul Ashton and Luke Leighton's other "NT Domain" doc.</member> +<member>FS documentation - cifs6.txt</member> +<member>FS documentation - cifsrap2.txt</member> +</simplelist> + +</sect2> + +<sect2> +<title>Credits</title> + +<simplelist> +<member>Paul Ashton: loads of work with Net Monitor; understanding the NT authentication system; reference implementation of the NT domain support on which this document is originally based.</member> +<member>Duncan Stansfield: low-level analysis of MSRPC Pipes.</member> +<member>Linus Nordberg: producing c-code from Paul's crypto spec.</member> +<member>Windows Sourcer development team</member> +</simplelist> + +</sect2> + +</sect1> + +<sect1> +<title>Notes and Structures</title> + +<sect2> +<title>Notes</title> + +<orderedlist> +<listitem><para> +In the SMB Transact pipes, some "Structures", described here, appear to be +4-byte aligned with the SMB header, at their start. Exactly which +"Structures" need aligning is not precisely known or documented. +</para></listitem> + +<listitem><para> +In the UDP NTLOGON Mailslots, some "Structures", described here, appear to be +2-byte aligned with the start of the mailslot, at their start. +</para></listitem> + +<listitem><para> +Domain SID is of the format S-revision-version-auth1-auth2...authN. +e.g S-1-5-123-456-789-123-456. the 5 could be a sub-revision. +</para></listitem> + +<listitem><para> +any undocumented buffer pointers must be non-zero if the string buffer it +refers to contains characters. exactly what value they should be is unknown. +0x0000 0002 seems to do the trick to indicate that the buffer exists. a +NULL buffer pointer indicates that the string buffer is of zero length. +If the buffer pointer is NULL, then it is suspected that the structure it +refers to is NOT put into (or taken out of) the SMB data stream. This is +empirically derived from, for example, the LSA SAM Logon response packet, +where if the buffer pointer is NULL, the user information is not inserted +into the data stream. Exactly what happens with an array of buffer pointers +is not known, although an educated guess can be made. +</para></listitem> + +<listitem><para> +an array of structures (a container) appears to have a count and a pointer. +if the count is zero, the pointer is also zero. no further data is put +into or taken out of the SMB data stream. if the count is non-zero, then +the pointer is also non-zero. immediately following the pointer is the +count again, followed by an array of container sub-structures. the count +appears a third time after the last sub-structure. +</para></listitem> +</orderedlist> + +</sect2> + +<sect2> +<title>Enumerations</title> + +<sect3> +<title>MSRPC Header type</title> +<para>command number in the msrpc packet header</para> + +<variablelist> +<varlistentry> + <term>MSRPC_Request:</term> + <listitem><para>0x00</para></listitem> +</varlistentry> +<varlistentry> + <term>MSRPC_Response:</term> + <listitem><para>0x02</para></listitem> +</varlistentry> +<varlistentry> + <term>MSRPC_Bind:</term> + <listitem><para>0x0B</para></listitem> +</varlistentry> +<varlistentry> + <term>MSRPC_BindAck:</term> + <listitem><para>0x0C</para></listitem> +</varlistentry> +</variablelist> +</sect3> + +<sect3> +<title>MSRPC Packet info</title> + +<para>The meaning of these flags is undocumented</para> + +<variablelist> +<varlistentry> + <term>FirstFrag:</term> + <listitem><para>0x01 </para></listitem> +</varlistentry> +<varlistentry> + <term>LastFrag:</term> + <listitem><para>0x02 </para></listitem> +</varlistentry> +<varlistentry> + <term>NotaFrag:</term> + <listitem><para>0x04 </para></listitem> +</varlistentry> +<varlistentry> + <term>RecRespond:</term> + <listitem><para>0x08 </para></listitem> +</varlistentry> +<varlistentry> + <term>NoMultiplex:</term> + <listitem><para>0x10 </para></listitem> +</varlistentry> +<varlistentry> + <term>NotForIdemp:</term> + <listitem><para>0x20 </para></listitem> +</varlistentry> +<varlistentry> + <term>NotforBcast:</term> + <listitem><para>0x40 </para></listitem> +</varlistentry> +<varlistentry> + <term>NoUuid:</term> + <listitem><para>0x80 </para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +</sect2> + +<sect2> +<title>Structures</title> + +<sect3><title>VOID *</title> +<para>sizeof VOID* is 32 bits.</para> +</sect3> + +<sect3><title>char</title> +<para>sizeof char is 8 bits.</para> +</sect3> + +<sect3><title>UTIME</title> +<para>UTIME is 32 bits, indicating time in seconds since 01jan1970. documented in cifs6.txt (section 3.5 page, page 30).</para> +</sect3> + +<sect3><title>NTTIME</title> +<para>NTTIME is 64 bits. documented in cifs6.txt (section 3.5 page, page 30).</para> +</sect3> + +<sect3> +<title>DOM_SID (domain SID structure)</title> + +<variablelist> + +<varlistentry> + <term>UINT32</term> + <listitem><para>num of sub-authorities in domain SID</para></listitem> +</varlistentry> + +<varlistentry> + <term>UINT8</term> + <listitem><para>SID revision number</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8</term> + <listitem><para>num of sub-authorities in domain SID</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[6]</term> + <listitem><para>6 bytes for domain SID - Identifier Authority.</para></listitem> +</varlistentry> + +<varlistentry> + <term>UINT16[n_subauths]</term> + <listitem><para>domain SID sub-authorities</para></listitem> +</varlistentry> + +</variablelist> + +<para><emphasis>Note: the domain SID is documented elsewhere.</emphasis> +</para> + +</sect3> + +<sect3> +<title>STR (string)</title> + +<para>STR (string) is a char[] : a null-terminated string of ascii characters.</para> + +</sect3> + +<sect3> +<title>UNIHDR (unicode string header) </title> + +<variablelist> + +<varlistentry> + <term>UINT16</term> + <listitem><para>length of unicode string</para></listitem> +</varlistentry> + +<varlistentry> + <term>UINT16</term> + <listitem><para>max length of unicode string</para></listitem> +</varlistentry> + +<varlistentry> + <term>UINT32</term> + <listitem><para>4 - undocumented.</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>UNIHDR2 (unicode string header plus buffer pointer)</title> + +<variablelist> + +<varlistentry> + <term>UNIHDR</term> + <listitem><para>unicode string header</para></listitem> +</varlistentry> + + +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>UNISTR (unicode string)</title> + +<variablelist> + +<varlistentry> + <term>UINT16[]</term> + <listitem><para>null-terminated string of unicode characters.</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>NAME (length-indicated unicode string)</title> + +<variablelist> + +<varlistentry> + <term>UINT32</term> + <listitem><para>length of unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16[]</term> + <listitem><para>null-terminated string of unicode characters.</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>UNISTR2 (aligned unicode string)</title> + +<variablelist> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to get unicode string 4-byte aligned with the start of the SMB header.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>max length of unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>length of unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16[]</term> + <listitem><para>string of uncode characters</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>OBJ_ATTR (object attributes)</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> +<listitem><para>0x18 - length (in bytes) including the length field.</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>0 - root directory (pointer)</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>0 - object name (pointer)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>0 - attributes (undocumented)</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>0 - security descriptior (pointer)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - security quality of service</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>POL_HND (LSA policy handle)</title> + +<variablelist> +<varlistentry> + <term>char[20]</term> + <listitem><para>policy handle</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>DOM_SID2 (domain SID structure, SIDS stored in unicode)</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>5 - SID type</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR2</term> + <listitem><para>domain SID unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>domain SID unicode string</para></listitem> +</varlistentry> +</variablelist> + +<para><emphasis>Note: there is a conflict between the unicode string header and the unicode string itself as to which to use to indicate string length. this will need to be resolved.</emphasis></para> + +<para><emphasis>Note: the SID type indicates, for example, an alias; a well-known group etc. this is documented somewhere.</emphasis></para> + +</sect3> + +<sect3> +<title>DOM_RID (domain RID structure)</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> +<listitem><para>5 - well-known SID. 1 - user SID (see ShowACLs)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>5 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>domain RID </para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - domain index out of above reference domains</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>LOG_INFO (server, account, client structure)</title> + +<para><emphasis>Note: logon server name starts with two '\' characters and is upper case.</emphasis></para> + +<para><emphasis>Note: account name is the logon client name from the LSA Request Challenge, with a $ on the end of it, in upper case.</emphasis></para> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon server unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>account name unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>sec_chan - security channel type</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon client machine unicode string</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>CLNT_SRV (server, client names structure)</title> + +<para><emphasis>Note: logon server name starts with two '\' characters and is upper case.</emphasis></para> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon server unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon client machine unicode string</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>CREDS (credentials + time stamp)</title> + +<variablelist> +<varlistentry> + <term>char[8]</term> + <listitem><para>credentials</para></listitem> +</varlistentry> +<varlistentry> + <term>UTIME</term> + <listitem><para>time stamp</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>CLNT_INFO2 (server, client structure, client credentials)</title> + +<para><emphasis>Note: whenever this structure appears in a request, you must take a copy of the client-calculated credentials received, because they will beused in subsequent credential checks. the presumed intention is to + maintain an authenticated request/response trail.</emphasis></para> + +<variablelist> +<varlistentry> + <term>CLNT_SRV</term> + <listitem><para>client and server names</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>???? padding, for 4-byte alignment with SMB header.</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to client credentials.</para></listitem> +</varlistentry> +<varlistentry> + <term>CREDS</term> + <listitem><para>client-calculated credentials + client time</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>CLNT_INFO (server, account, client structure, client credentials)</title> +<para><emphasis>Note: whenever this structure appears in a request, you must take a copy of the client-calculated credentials received, because they will be used in subsequent credential checks. the presumed intention is to maintain an authenticated request/response trail.</emphasis></para> + +<variablelist> +<varlistentry> + <term>LOG_INFO</term> + <listitem><para>logon account info</para></listitem> +</varlistentry> +<varlistentry> + <term>CREDS</term> + <listitem><para>client-calculated credentials + client time</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>ID_INFO_1 (id info structure, auth level 1)</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>ptr_id_info_1</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>domain name unicode header</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>param control</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT64</term> + <listitem><para>logon ID</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>user name unicode header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>workgroup name unicode header</para></listitem> +</varlistentry> +<varlistentry> + <term>char[16]</term> + <listitem><para>arc4 LM OWF Password</para></listitem> +</varlistentry> +<varlistentry> + <term>char[16]</term> + <listitem><para>arc4 NT OWF Password</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>domain name unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>user name unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>workstation name unicode string</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>SAM_INFO (sam logon/logoff id info structure)</title> + +<para><emphasis>Note: presumably, the return credentials is supposedly for the server to verify that the credential chain hasn't been compromised.</emphasis></para> + +<variablelist> +<varlistentry> + <term>CLNT_INFO2</term> + <listitem><para>client identification/authentication info</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to return credentials.</para></listitem> +</varlistentry> +<varlistentry> + <term>CRED</term> + <listitem><para>return credentials - ignored.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>logon level</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>switch value</para></listitem> +</varlistentry> + +</variablelist> + +<para><programlisting> + switch (switch_value) + case 1: + { + ID_INFO_1 id_info_1; + } +</programlisting></para> + +</sect3> + +<sect3> +<title>GID (group id info)</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> +<listitem><para>group id</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>user attributes (only used by NT 3.1 and 3.51)</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>DOM_REF (domain reference info)</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num referenced domains?</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain name buffer pointer.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>32 - max number of entries</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>4 - num referenced domains?</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR2</term> + <listitem><para>domain name unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR2[num_ref_doms-1]</term> + <listitem><para>referenced domain unicode string headers</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>domain name unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>DOM_SID[num_ref_doms]</term> + <listitem><para>referenced domain SIDs</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>DOM_INFO (domain info, levels 3 and 5 are the same))</title> + +<variablelist> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>??? padding to get 4-byte alignment with start of SMB header</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>domain name string length * 2</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>domain name string length * 2</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain name string buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>undocumented domain SID string buffer pointer</para></listitem></varlistentry> +<varlistentry> + <term>UNISTR2</term> +<listitem><para>domain name (unicode string)</para></listitem></varlistentry> +<varlistentry> + <term>DOM_SID</term> + <listitem><para>domain SID</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>USER_INFO (user logon info)</title> + +<para><emphasis>Note: it would be nice to know what the 16 byte user session key is for.</emphasis></para> + +<variablelist> +<varlistentry> + <term>NTTIME</term> + <listitem><para>logon time</para></listitem> +</varlistentry> +<varlistentry> + <term>NTTIME</term> + <listitem><para>logoff time</para></listitem> +</varlistentry> +<varlistentry> + <term>NTTIME</term> + <listitem><para>kickoff time</para></listitem> +</varlistentry> +<varlistentry> + <term>NTTIME</term> + <listitem><para>password last set time</para></listitem> +</varlistentry> +<varlistentry> + <term>NTTIME</term> + <listitem><para>password can change time</para></listitem> +</varlistentry> +<varlistentry> + <term>NTTIME</term> + <listitem><para>password must change time</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>username unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>user's full name unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>logon script unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>profile path unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>home directory unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>home directory drive unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>logon count</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>bad password count</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>User ID</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>Group ID</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num groups</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer to groups.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>user flags</para></listitem> +</varlistentry> +<varlistentry> + <term>char[16]</term> + <listitem><para>user session key</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>logon server unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>UNIHDR</term> + <listitem><para>logon domain unicode string header</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented logon domain id pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>char[40]</term> + <listitem><para>40 undocumented padding bytes. future expansion?</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - num_other_sids?</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>NULL - undocumented pointer to other domain SIDs.</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>username unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>user's full name unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon script unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>profile path unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>home directory unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>home directory drive unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num groups</para></listitem> +</varlistentry> +<varlistentry> + <term>GID[num_groups]</term> + <listitem><para>group info</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon server unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon domain unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>DOM_SID</term> + <listitem><para>domain SID</para></listitem> +</varlistentry> +<varlistentry> + <term>DOM_SID[num_sids]</term> + <listitem><para>other domain SIDs?</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>SH_INFO_1_PTR (pointers to level 1 share info strings)</title> + +<para><emphasis>Note: see cifsrap2.txt section5, page 10.</emphasis></para> + +<simplelist> +<member>0 for shi1_type indicates a Disk.</member> +<member>1 for shi1_type indicates a Print Queue.</member> +<member>2 for shi1_type indicates a Device.</member> +<member>3 for shi1_type indicates an IPC pipe.</member> +<member>0x8000 0000 (top bit set in shi1_type) indicates a hidden share.</member> +</simplelist> + +<variablelist> + +<varlistentry> + <term>VOID*</term> + <listitem><para>shi1_netname - pointer to net name</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>shi1_type - type of share. 0 - undocumented.</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>shi1_remark - pointer to comment.</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>SH_INFO_1_STR (level 1 share info strings)</title> + +<variablelist> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>shi1_netname - unicode string of net name</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>shi1_remark - unicode string of comment.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>SHARE_INFO_1_CTR</title> + +<para>share container with 0 entries:</para> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - EntriesRead</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - Buffer</para></listitem> +</varlistentry> +</variablelist> + +<para>share container with > 0 entries:</para> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>EntriesRead</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>non-zero - Buffer</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>EntriesRead</para></listitem> +</varlistentry> +<varlistentry> + <term>SH_INFO_1_PTR[EntriesRead]</term> + <listitem><para>share entry pointers</para></listitem> +</varlistentry> +<varlistentry> + <term>SH_INFO_1_STR[EntriesRead]</term> + <listitem><para>share entry strings</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to get unicode string 4-byte aligned with start of the SMB header.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>EntriesRead</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - padding</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title>SERVER_INFO_101</title> + +<para><emphasis>Note: see cifs6.txt section 6.4 - the fields described therein will be of assistance here. for example, the type listed below is the same as fServerType, which is described in 6.4.1. </emphasis></para> + +<variablelist> +<varlistentry> + <term>SV_TYPE_WORKSTATION</term> + <listitem><para>0x00000001 All workstations</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_SERVER</term> + <listitem><para>0x00000002 All servers</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_SQLSERVER</term> + <listitem><para>0x00000004 Any server running with SQL server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DOMAIN_CTRL</term> + <listitem><para>0x00000008 Primary domain controller</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DOMAIN_BAKCTRL</term> + <listitem><para>0x00000010 Backup domain controller</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_TIME_SOURCE</term> + <listitem><para>0x00000020 Server running the timesource service</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_AFP</term> + <listitem><para>0x00000040 Apple File Protocol servers</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_NOVELL</term> + <listitem><para>0x00000080 Novell servers</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DOMAIN_MEMBER</term> + <listitem><para>0x00000100 Domain Member</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_PRINTQ_SERVER</term> + <listitem><para>0x00000200 Server sharing print queue</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DIALIN_SERVER</term> + <listitem><para>0x00000400 Server running dialin service.</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_XENIX_SERVER</term> + <listitem><para>0x00000800 Xenix server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_NT</term> + <listitem><para>0x00001000 NT server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_WFW</term> + <listitem><para>0x00002000 Server running Windows for </para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_SERVER_NT</term> + <listitem><para>0x00008000 Windows NT non DC server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_POTENTIAL_BROWSER</term> + <listitem><para>0x00010000 Server that can run the browser service</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_BACKUP_BROWSER</term> + <listitem><para>0x00020000 Backup browser server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_MASTER_BROWSER</term> + <listitem><para>0x00040000 Master browser server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DOMAIN_MASTER</term> + <listitem><para>0x00080000 Domain Master Browser server</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_LOCAL_LIST_ONLY</term> + <listitem><para>0x40000000 Enumerate only entries marked "local"</para></listitem> +</varlistentry> +<varlistentry> + <term>SV_TYPE_DOMAIN_ENUM</term> + <listitem><para>0x80000000 Enumerate Domains. The pszServer and pszDomain parameters must be NULL.</para></listitem> +</varlistentry> + +</variablelist> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>500 - platform_id</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to name</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>5 - major version</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>4 - minor version</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>type (SV_TYPE_... bit field)</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to comment</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>sv101_name - unicode string of server name</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>sv_101_comment - unicode string of server comment.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to get unicode string 4-byte aligned with start of the SMB header.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>MSRPC over Transact Named Pipe</title> + +<para>For details on the SMB Transact Named Pipe, see cifs6.txt</para> + +<sect2> +<title>MSRPC Pipes</title> + +<para> +The MSRPC is conducted over an SMB Transact Pipe with a name of +<filename>\PIPE\</filename>. You must first obtain a 16 bit file handle, by +sending a SMBopenX with the pipe name <filename>\PIPE\srvsvc</filename> for +example. You can then perform an SMB Trans, +and must carry out an SMBclose on the file handle once you are finished. +</para> + +<para> +Trans Requests must be sent with two setup UINT16s, no UINT16 params (none +known about), and UINT8 data parameters sufficient to contain the MSRPC +header, and MSRPC data. The first UINT16 setup parameter must be either +0x0026 to indicate an RPC, or 0x0001 to indicate Set Named Pipe Handle +state. The second UINT16 parameter must be the file handle for the pipe, +obtained above. +</para> + +<para> +The Data section for an API Command of 0x0026 (RPC pipe) in the Trans +Request is the RPC Header, followed by the RPC Data. The Data section for +an API Command of 0x0001 (Set Named Pipe Handle state) is two bytes. The +only value seen for these two bytes is 0x00 0x43. +</para> + +<para> +MSRPC Responses are sent as response data inside standard SMB Trans +responses, with the MSRPC Header, MSRPC Data and MSRPC tail. +</para> + +<para> +It is suspected that the Trans Requests will need to be at least 2-byte +aligned (probably 4-byte). This is standard practice for SMBs. It is also +independent of the observed 4-byte alignments with the start of the MSRPC +header, including the 4-byte alignment between the MSRPC header and the +MSRPC data. +</para> + +<para> +First, an SMBtconX connection is made to the IPC$ share. The connection +must be made using encrypted passwords, not clear-text. Then, an SMBopenX +is made on the pipe. Then, a Set Named Pipe Handle State must be sent, +after which the pipe is ready to accept API commands. Lastly, and SMBclose +is sent. +</para> + +<para> +To be resolved: +</para> + +<para> +lkcl/01nov97 there appear to be two additional bytes after the null-terminated \PIPE\ name for the RPC pipe. Values seen so far are +listed below:</para> + +<para><programlisting> + initial SMBopenX request: RPC API command 0x26 params: + "\\PIPE\\lsarpc" 0x65 0x63; 0x72 0x70; 0x44 0x65; + "\\PIPE\\srvsvc" 0x73 0x76; 0x4E 0x00; 0x5C 0x43; +</programlisting></para> + +</sect2> + +<sect2> +<title>Header</title> + +<para>[section to be rewritten, following receipt of work by Duncan Stansfield]</para> + +<para>Interesting note: if you set packed data representation to 0x0100 0000 +then all 4-byte and 2-byte word ordering is turned around!</para> + +<para>The start of each of the NTLSA and NETLOGON named pipes begins with:</para> + +<segmentedlist> +<segtitle>offset</segtitle><segtitle>Variable type</segtitle><segtitle>Variable data</segtitle> +<seglistitem><seg>00</seg><seg>UINT8</seg><seg>5 - RPC major version</seg></seglistitem> +<seglistitem><seg>01</seg><seg>UINT8</seg><seg>0 - RPC minor version</seg></seglistitem> +<seglistitem><seg>02</seg><seg>UINT8</seg><seg>2 - RPC response packet</seg></seglistitem> +<seglistitem><seg>03</seg><seg>UINT8</seg><seg>3 - (FirstFrag bit-wise or with LastFrag)</seg></seglistitem> +<seglistitem><seg>04</seg><seg>UINT32</seg><seg>0x1000 0000 - packed data representation</seg></seglistitem> +<seglistitem><seg>08</seg><seg>UINT16</seg><seg>fragment length - data size (bytes) inc header and tail.</seg></seglistitem> +<seglistitem><seg>0A</seg><seg>UINT16</seg><seg>0 - authentication length </seg></seglistitem> +<seglistitem><seg>0C</seg><seg>UINT32</seg><seg>call identifier. matches 12th UINT32 of incoming RPC data.</seg></seglistitem> +<seglistitem><seg>10</seg><seg>UINT32</seg><seg>allocation hint - data size (bytes) minus header and tail.</seg></seglistitem> +<seglistitem><seg>14</seg><seg>UINT16</seg><seg>0 - presentation context identifier</seg></seglistitem> +<seglistitem><seg>16</seg><seg>UINT8</seg><seg>0 - cancel count</seg></seglistitem> +<seglistitem><seg>17</seg><seg>UINT8</seg><seg>in replies: 0 - reserved; in requests: opnum - see #defines.</seg></seglistitem> +<seglistitem><seg>18</seg><seg>......</seg><seg>start of data (goes on for allocation_hint bytes)</seg></seglistitem> +</segmentedlist> + +<sect3> +<title>RPC_Packet for request, response, bind and bind acknowledgement</title> + +<variablelist> +<varlistentry> + <term>UINT8 versionmaj</term> +<listitem><para>reply same as request (0x05)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 versionmin</term> +<listitem><para>reply same as request (0x00)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 type</term> +<listitem><para>one of the MSRPC_Type enums</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 flags</term> +<listitem><para>reply same as request (0x00 for Bind, 0x03 for Request)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32 representation</term> +<listitem><para>reply same as request (0x00000010)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 fraglength</term> +<listitem><para>the length of the data section of the SMB trans packet</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 authlength</term> + <listitem><para></para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32 callid</term> +<listitem><para>call identifier. (e.g. 0x00149594)</para></listitem></varlistentry> +<varlistentry> + <term>* stub USE TvPacket</term> +<listitem><para>the remainder of the packet depending on the "type"</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Interface identification</title> + +<para>the interfaces are numbered. as yet I haven't seen more than one interface used on the same pipe name srvsvc</para> + +<para><programlisting> +abstract (0x4B324FC8, 0x01D31670, 0x475A7812, 0x88E16EBF, 0x00000003) +transfer (0x8A885D04, 0x11C91CEB, 0x0008E89F, 0x6048102B, 0x00000002) +</programlisting></para> + +</sect3> + +<sect3> +<title>RPC_Iface RW</title> + +<variablelist> +<varlistentry> + <term>UINT8 byte[16]</term> +<listitem><para>16 bytes of number</para></listitem></varlistentry> +<varlistentry> + <term>UINT32 version</term> +<listitem><para>the interface number</para></listitem></varlistentry> +</variablelist> + + +</sect3> + +<sect3> +<title>RPC_ReqBind RW</title> + +<para>the remainder of the packet after the header if "type" was Bind in the response header, "type" should be BindAck</para> + +<variablelist> +<varlistentry> + <term>UINT16 maxtsize</term> +<listitem><para>maximum transmission fragment size (0x1630)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 maxrsize</term> +<listitem><para>max receive fragment size (0x1630)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32 assocgid</term> +<listitem><para>associated group id (0x0)</para></listitem></varlistentry> +<varlistentry> + <term>UINT32 numelements</term> +<listitem><para>the number of elements (0x1)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 contextid</term> +<listitem><para>presentation context identifier (0x0)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 numsyntaxes</term> +<listitem><para>the number of syntaxes (has always been 1?)(0x1)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8[]</term> +<listitem><para>4-byte alignment padding, against SMB header</para></listitem></varlistentry> +<varlistentry> + <term>* abstractint USE RPC_Iface</term> +<listitem><para>num and vers. of interface client is using</para></listitem></varlistentry> +<varlistentry> + <term>* transferint USE RPC_Iface</term> + <listitem><para>num and vers. of interface to use for replies</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>RPC_Address RW</title> + +<variablelist> +<varlistentry> + <term>UINT16 length</term> +<listitem><para>length of the string including null terminator</para></listitem></varlistentry> +<varlistentry> + <term>* port USE string</term> +<listitem><para>the string above in single byte, null terminated form</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>RPC_ResBind RW</title> + +<para>the response to place after the header in the reply packet</para> + +<variablelist> +<varlistentry> + <term>UINT16 maxtsize</term> +<listitem><para>same as request</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 maxrsize</term> +<listitem><para>same as request</para></listitem></varlistentry> +<varlistentry> + <term>UINT32 assocgid</term> +<listitem><para>zero</para></listitem></varlistentry> +<varlistentry> + <term>* secondaddr USE RPC_Address</term> +<listitem><para>the address string, as described earlier</para></listitem></varlistentry> +<varlistentry> + <term>UINT8[]</term> +<listitem><para>4-byte alignment padding, against SMB header</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 numresults</term> +<listitem><para>the number of results (0x01)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8[]</term> +<listitem><para>4-byte alignment padding, against SMB header</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 result</term> +<listitem><para>result (0x00 = accept)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 reason</term> +<listitem><para>reason (0x00 = no reason specified)</para></listitem></varlistentry> +<varlistentry> + <term>* transfersyntax USE RPC_Iface</term> +<listitem><para>the transfer syntax from the request</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>RPC_ReqNorm RW</title> + +<para>the remainder of the packet after the header for every other other request</para> + +<variablelist> +<varlistentry> + <term>UINT32 allochint</term> +<listitem><para>the size of the stub data in bytes</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 prescontext</term> +<listitem><para>presentation context identifier (0x0)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 opnum</term> +<listitem><para>operation number (0x15)</para></listitem></varlistentry> +<varlistentry> + <term>* stub USE TvPacket</term> +<listitem><para>a packet dependent on the pipe name (probably the interface) and the op number)</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>RPC_ResNorm RW</title> + +<variablelist> +<varlistentry> + <term>UINT32 allochint</term> +<listitem><para># size of the stub data in bytes</para></listitem></varlistentry> +<varlistentry> + <term>UINT16 prescontext</term> +<listitem><para># presentation context identifier (same as request)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 cancelcount</term> +<listitem><para># cancel count? (0x0)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8 reserved</term> +<listitem><para># 0 - one byte padding</para></listitem></varlistentry> +<varlistentry> + <term>* stub USE TvPacket</term> +<listitem><para># the remainder of the reply</para></listitem></varlistentry> +</variablelist> +</sect3> + +</sect2> + +<sect2> +<title>Tail</title> + +<para>The end of each of the NTLSA and NETLOGON named pipes ends with:</para> + +<variablelist> +<varlistentry> + <term>......</term> + <listitem><para>end of data</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>return code</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>RPC Bind / Bind Ack</title> + +<para> +RPC Binds are the process of associating an RPC pipe (e.g \PIPE\lsarpc) +with a "transfer syntax" (see RPC_Iface structure). The purpose for doing +this is unknown. +</para> + +<para><emphasis>Note: The RPC_ResBind SMB Transact request is sent with two uint16 setup parameters. The first is 0x0026; the second is the file handle + returned by the SMBopenX Transact response.</emphasis></para> + +<para><emphasis>Note: The RPC_ResBind members maxtsize, maxrsize and assocgid are the same in the response as the same members in the RPC_ReqBind. The + RPC_ResBind member transfersyntax is the same in the response as + the</emphasis></para> + +<para><emphasis>Note: The RPC_ResBind response member secondaddr contains the name of what is presumed to be the service behind the RPC pipe. The + mapping identified so far is:</emphasis></para> + +<variablelist> + +<varlistentry> + <term>initial SMBopenX request:</term> + <listitem><para>RPC_ResBind response:</para></listitem> +</varlistentry> + +<varlistentry> + <term>"\\PIPE\\srvsvc"</term> + <listitem><para>"\\PIPE\\ntsvcs"</para></listitem> +</varlistentry> +<varlistentry> + <term>"\\PIPE\\samr"</term> + <listitem><para>"\\PIPE\\lsass"</para></listitem> +</varlistentry> +<varlistentry> + <term>"\\PIPE\\lsarpc"</term> + <listitem><para>"\\PIPE\\lsass"</para></listitem> +</varlistentry> +<varlistentry> + <term>"\\PIPE\\wkssvc"</term> + <listitem><para>"\\PIPE\\wksvcs"</para></listitem> +</varlistentry> +<varlistentry> + <term>"\\PIPE\\NETLOGON"</term> + <listitem><para>"\\PIPE\\NETLOGON"</para></listitem> +</varlistentry> +</variablelist> + +<para><emphasis>Note: The RPC_Packet fraglength member in both the Bind Request and Bind Acknowledgment must contain the length of the entire RPC data, including the RPC_Packet header.</emphasis></para> + +<para>Request:</para> + +<simplelist> +<member>RPC_Packet</member> +<member>RPC_ReqBind</member> +</simplelist> + +<para>Response:</para> +<simplelist> +<member>RPC_Packet</member> +<member>RPC_ResBind</member> +</simplelist> + +</sect2> + +<sect2> +<title>NTLSA Transact Named Pipe</title> + +<para>The sequence of actions taken on this pipe are:</para> + +<simplelist> +<member>Establish a connection to the IPC$ share (SMBtconX). use encrypted passwords.</member> +<member>Open an RPC Pipe with the name "\\PIPE\\lsarpc". Store the file handle.</member> +<member>Using the file handle, send a Set Named Pipe Handle state to 0x4300.</member> +<member>Send an LSA Open Policy request. Store the Policy Handle.</member> +<member>Using the Policy Handle, send LSA Query Info Policy requests, etc.</member> +<member>Using the Policy Handle, send an LSA Close.</member> +<member>Close the IPC$ share.</member> +</simplelist> + +<para>Defines for this pipe, identifying the query are:</para> +<variablelist> +<varlistentry> + <term>LSA Open Policy:</term> + <listitem><para>0x2c</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Query Info Policy:</term> + <listitem><para>0x07</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Enumerate Trusted Domains:</term> + <listitem><para>0x0d</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Open Secret:</term> + <listitem><para>0xff</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Lookup SIDs:</term> + <listitem><para>0xfe</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Lookup Names:</term> + <listitem><para>0xfd</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Close:</term> + <listitem><para>0x00</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>LSA Open Policy</title> + +<para><emphasis>Note: The policy handle can be anything you like.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>server name - unicode string starting with two '\'s</para></listitem> +</varlistentry> +<varlistentry> + <term>OBJ_ATTR</term> + <listitem><para>object attributes</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>1 - desired access</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> + +<varlistentry> + <term>POL_HND</term> + <listitem><para>LSA policy handle</para></listitem> +</varlistentry> + +<varlistentry> + <term>return</term> + <listitem><para>0 - indicates success</para></listitem> +</varlistentry> + +</variablelist> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Query Info Policy</title> + +<para><emphasis>Note: The info class in response must be the same as that in the request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>POL_HND</term> +<listitem><para>LSA policy handle</para></listitem></varlistentry> +<varlistentry> + <term>UINT16</term> +<listitem><para>info class (also a policy handle?)</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>info class (same as info class in request).</para></listitem> +</varlistentry> + +</variablelist> + +<para><programlisting> +switch (info class) +case 3: +case 5: +{ +DOM_INFO domain info, levels 3 and 5 (are the same). +} + +return 0 - indicates success +</programlisting></para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Enumerate Trusted Domains</title> + +<sect3> +<title>Request</title> + +<para>no extra data</para> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - enumeration context</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - entries read</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - trust information</para></listitem> +</varlistentry> +<varlistentry> + <term>return</term> + <listitem><para>0x8000 001a - "no trusted domains" success code</para></listitem> +</varlistentry> +</variablelist> + +</sect3> +</sect2> + +<sect2> +<title>LSA Open Secret</title> + +<sect3> +<title>Request</title> + +<para>no extra data</para> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>0 - undocumented</para></listitem> +</varlistentry> +</variablelist> + +<para>return 0x0C00 0034 - "no such secret" success code</para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Close</title> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>POL_HND</term> + <listitem><para>policy handle to be closed</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>POL_HND</term> +<listitem><para>0s - closed policy handle (all zeros)</para></listitem></varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> +</sect2> + +<sect2> +<title>LSA Lookup SIDS</title> + +<para><emphasis>Note: num_entries in response must be same as num_entries in request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>POL_HND</term> + <listitem><para>LSA policy handle</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num_entries</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain SID buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain name buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*[num_entries] undocumented domain SID pointers to be looked up. +</term> +<listitem><para>DOM_SID[num_entries] domain SIDs to be looked up.</para></listitem></varlistentry> +<varlistentry> + <term>char[16]</term> + <listitem><para>completely undocumented 16 bytes.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>DOM_REF</term> +<listitem><para>domain reference response</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>undocumented buffer pointer</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +<varlistentry> + <term>DOM_SID2[num_entries]</term> +<listitem><para>domain SIDs (from Request, listed above).</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Lookup Names</title> + +<para><emphasis>Note: num_entries in response must be same as num_entries in request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>POL_HND</term> + <listitem><para>LSA policy handle</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num_entries</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>num_entries</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain SID buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented domain name buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>NAME[num_entries]</term> + <listitem><para>names to be looked up.</para></listitem> +</varlistentry> +<varlistentry> + <term>char[]</term> + <listitem><para>undocumented bytes - falsely translated SID structure?</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>DOM_REF</term> +<listitem><para>domain reference response</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>undocumented buffer pointer</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +<varlistentry> + <term>DOM_RID[num_entries]</term> +<listitem><para>domain SIDs (from Request, listed above).</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>num_entries (listed above)</para></listitem></varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>NETLOGON rpc Transact Named Pipe</title> + +<para>The sequence of actions taken on this pipe are:</para> + +<simplelist> +<member>tablish a connection to the IPC$ share (SMBtconX). use encrypted passwords.</member> +<member>en an RPC Pipe with the name "\\PIPE\\NETLOGON". Store the file handle.</member> +<member>ing the file handle, send a Set Named Pipe Handle state to 0x4300.</member> +<member>eate Client Challenge. Send LSA Request Challenge. Store Server Challenge.</member> +<member>lculate Session Key. Send an LSA Auth 2 Challenge. Store Auth2 Challenge.</member> +<member>lc/Verify Client Creds. Send LSA Srv PW Set. Calc/Verify Server Creds.</member> +<member>lc/Verify Client Creds. Send LSA SAM Logon . Calc/Verify Server Creds.</member> +<member>lc/Verify Client Creds. Send LSA SAM Logoff. Calc/Verify Server Creds.</member> +<member>ose the IPC$ share.</member> +</simplelist> + +<para>Defines for this pipe, identifying the query are</para> + +<variablelist> +<varlistentry> + <term>LSA Request Challenge:</term> + <listitem><para>0x04</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Server Password Set:</term> + <listitem><para>0x06</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA SAM Logon:</term> + <listitem><para>0x02</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA SAM Logoff:</term> + <listitem><para>0x03</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Auth 2:</term> + <listitem><para>0x0f</para></listitem> +</varlistentry> +<varlistentry> + <term>LSA Logon Control:</term> + <listitem><para>0x0e</para></listitem> +</varlistentry> +</variablelist> + +<sect2> +<title>LSA Request Challenge</title> + +<para><emphasis>Note: logon server name starts with two '\' characters and is upper case.</emphasis></para> + +<para><emphasis>Note: logon client is the machine, not the user.</emphasis></para> + +<para><emphasis>Note: the initial LanManager password hash, against which the challenge is issued, is the machine name itself (lower case). there will becalls issued (LSA Server Password Set) which will change this, later. refusing these calls allows you to always deal with the same password (i.e the LM# of the machine name in lower case).</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon server unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>logon client unicode string</para></listitem> +</varlistentry> +<varlistentry> + <term>char[8]</term> + <listitem><para>client challenge</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>char[8]</term> + <listitem><para>server challenge</para></listitem> +</varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Authenticate 2</title> + +<para><emphasis>Note: in between request and response, calculate the client credentials, and check them against the client-calculated credentials (this process uses the previously received client credentials).</emphasis></para> + +<para><emphasis>Note: neg_flags in the response is the same as that in the request.</emphasis></para> + +<para><emphasis>Note: you must take a copy of the client-calculated credentials received here, because they will be used in subsequent authentication packets.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>LOG_INFO</term> + <listitem><para>client identification info</para></listitem> +</varlistentry> +<varlistentry> + <term>char[8]</term> + <listitem><para>client-calculated credentials</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> +<listitem><para>padding to 4-byte align with start of SMB header.</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>neg_flags - negotiated flags (usual value is 0x0000 01ff)</para></listitem></varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>char[8]</term> + <listitem><para>server credentials.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>neg_flags - same as neg_flags in request.</para></listitem> +</varlistentry> +</variablelist> + +<para>return 0 - indicates success. failure value unknown.</para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA Server Password Set</title> + +<para><emphasis>Note: the new password is suspected to be a DES encryption using the old password to generate the key.</emphasis></para> + +<para><emphasis>Note: in between request and response, calculate the client credentials, and check them against the client-calculated credentials (this process uses the previously received client credentials).</emphasis></para> + +<para><emphasis>Note: the server credentials are constructed from the client-calculated credentials and the client time + 1 second.</emphasis></para> + +<para><emphasis>Note: you must take a copy of the client-calculated credentials received here, because they will be used in subsequent authentication packets.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>CLNT_INFO</term> + <listitem><para>client identification/authentication info</para></listitem> +</varlistentry> +<varlistentry> + <term>char[]</term> + <listitem><para>new password - undocumented.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>CREDS</term> + <listitem><para>server credentials. server time stamp appears to be ignored.</para></listitem> +</varlistentry> +</variablelist> + +<para>return 0 - indicates success; 0xC000 006a indicates failure</para> + +</sect3> +</sect2> + +<sect2> +<title>LSA SAM Logon</title> + +<para><emphasis> +Note: valid_user is True iff the username and password hash are valid for + the requested domain. +</emphasis></para> + +<sect3> +<title>Request</title> +<variablelist> +<varlistentry> + <term>SAM_INFO</term> + <listitem><para>sam_id structure</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>CREDS</term> + <listitem><para>server credentials. server time stamp appears to be ignored.</para></listitem> +</varlistentry> +</variablelist> + +<para><programlisting> +if (valid_user) +{ + UINT16 3 - switch value indicating USER_INFO structure. + VOID* non-zero - pointer to USER_INFO structure + USER_INFO user logon information + + UINT32 1 - Authoritative response; 0 - Non-Auth? + + return 0 - indicates success +} +else +{ + UINT16 0 - switch value. value to indicate no user presumed. + VOID* 0x0000 0000 - indicates no USER_INFO structure. + + UINT32 1 - Authoritative response; 0 - Non-Auth? + + return 0xC000 0064 - NT_STATUS_NO_SUCH_USER. +} +</programlisting></para> + +</sect3> + +</sect2> + +<sect2> +<title>LSA SAM Logoff</title> + +<para><emphasis> +Note: presumably, the SAM_INFO structure is validated, and a (currently + undocumented) error code returned if the Logoff is invalid. +</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>SAM_INFO</term> + <listitem><para>sam_id structure</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> + <listitem><para>undocumented buffer pointer</para></listitem> +</varlistentry> +<varlistentry> + <term>CREDS</term> + <listitem><para>server credentials. server time stamp appears to be ignored.</para></listitem> +</varlistentry> +</variablelist> + +<para>return 0 - indicates success. undocumented failure indication.</para> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>\\MAILSLOT\NET\NTLOGON</title> + +<para><emphasis> +Note: mailslots will contain a response mailslot, to which the response + should be sent. the target NetBIOS name is REQUEST_NAME<20>, where + REQUEST_NAME is the name of the machine that sent the request. +</emphasis></para> + +<sect2> +<title>Query for PDC</title> + +<para><emphasis>Note: NTversion, LMNTtoken, LM20token in response are the same as those given in the request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>UINT16</term> + <listitem><para>0x0007 - Query for PDC</para></listitem> +</varlistentry> +<varlistentry> + <term>STR</term> + <listitem><para>machine name</para></listitem> +</varlistentry> +<varlistentry> + <term>STR</term> + <listitem><para>response mailslot</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to 2-byte align with start of mailslot.</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>machine name</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>NTversion</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LMNTtoken</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LM20token</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT16</term> +<listitem><para>0x000A - Respose to Query for PDC</para></listitem></varlistentry> +<varlistentry> + <term>STR</term> +<listitem><para>machine name (in uppercase)</para></listitem></varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to 2-byte align with start of mailslot.</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>machine name</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> +<listitem><para>domain name</para></listitem></varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>NTversion (same as received in request)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16</term> +<listitem><para>LMNTtoken (same as received in request)</para></listitem></varlistentry> +<varlistentry> + <term>UINT16</term> +<listitem><para>LM20token (same as received in request)</para></listitem></varlistentry> +</variablelist> + +</sect3> +</sect2> + +<sect2> +<title>SAM Logon</title> + +<para><emphasis>Note: machine name in response is preceded by two '\' characters.</emphasis></para> + +<para><emphasis>Note: NTversion, LMNTtoken, LM20token in response are the same as those given in the request.</emphasis></para> + +<para><emphasis>Note: user name in the response is presumably the same as that in the request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>UINT16</term> + <listitem><para>0x0012 - SAM Logon</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>request count</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>machine name</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>user name</para></listitem> +</varlistentry> +<varlistentry> + <term>STR</term> + <listitem><para>response mailslot</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>alloweable account</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>domain SID size</para></listitem> +</varlistentry> +<varlistentry> + <term>char[sid_size]</term> + <listitem><para>domain SID, of sid_size bytes.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>???? padding to 4? 2? -byte align with start of mailslot.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>NTversion</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LMNTtoken</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LM20token</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT16</term> + <listitem><para>0x0013 - Response to SAM Logon</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>machine name</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>user name - workstation trust account</para></listitem> +</varlistentry> +<varlistentry> + <term>UNISTR</term> + <listitem><para>domain name </para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>NTversion</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LMNTtoken</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT16</term> + <listitem><para>LM20token</para></listitem> +</varlistentry> +</variablelist> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>SRVSVC Transact Named Pipe</title> + +<para>Defines for this pipe, identifying the query are:</para> + +<variablelist> +<varlistentry> + <term>Net Share Enum</term> + <listitem><para>0x0f</para></listitem> +</varlistentry> +<varlistentry> + <term>Net Server Get Info</term> + <listitem><para>0x15</para></listitem> +</varlistentry> + +</variablelist> + +<sect2> +<title>Net Share Enum</title> + +<para><emphasis>Note: share level and switch value in the response are presumably the same as those in the request.</emphasis></para> + +<para><emphasis>Note: cifsrap2.txt (section 5) may be of limited assistance here.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>VOID*</term> +<listitem><para>pointer (to server name?)</para></listitem></varlistentry> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>server name</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT8[]</term> + <listitem><para>padding to get unicode string 4-byte aligned with the start of the SMB header.</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>share level</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>switch value</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to SHARE_INFO_1_CTR</para></listitem> +</varlistentry> +<varlistentry> + <term>SHARE_INFO_1_CTR</term> + <listitem><para>share info with 0 entries</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> +<listitem><para>preferred maximum length (0xffff ffff)</para></listitem></varlistentry> +</variablelist> +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>share level</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>switch value</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> +<listitem><para>pointer to SHARE_INFO_1_CTR</para></listitem></varlistentry> +<varlistentry> + <term>SHARE_INFO_1_CTR</term> +<listitem><para>share info (only added if share info ptr is non-zero)</para></listitem></varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> +</sect2> + +<sect2> +<title>Net Server Get Info</title> + +<para><emphasis>Note: level is the same value as in the request.</emphasis></para> + +<sect3> +<title>Request</title> + +<variablelist> +<varlistentry> + <term>UNISTR2</term> + <listitem><para>server name</para></listitem> +</varlistentry> +<varlistentry> + <term>UINT32</term> + <listitem><para>switch level</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Response</title> + +<variablelist> +<varlistentry> + <term>UINT32</term> + <listitem><para>switch level</para></listitem> +</varlistentry> +<varlistentry> + <term>VOID*</term> + <listitem><para>pointer to SERVER_INFO_101</para></listitem> +</varlistentry> +<varlistentry> + <term>SERVER_INFO_101</term> +<listitem><para>server info (only added if server info ptr is non-zero)</para></listitem></varlistentry> +</variablelist> + +<para>return 0 - indicates success</para> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>Cryptographic side of NT Domain Authentication</title> + +<sect2> +<title>Definitions</title> + +<variablelist> +<varlistentry> +<term>Add(A1,A2)</term> +<listitem><para>Intel byte ordered addition of corresponding 4 byte words in arrays A1 and A2</para></listitem> +</varlistentry> + +<varlistentry> +<term>E(K,D)</term> +<listitem><para>DES ECB encryption of 8 byte data D using 7 byte key K</para></listitem> +</varlistentry> + +<varlistentry> +<term>lmowf()</term> +<listitem><para>Lan man hash</para></listitem> +</varlistentry> + +<varlistentry> +<term>ntowf()</term> +<listitem><para>NT hash</para></listitem> +</varlistentry> + +<varlistentry> +<term>PW</term> +<listitem><para>md4(machine_password) == md4(lsadump $machine.acc) == +pwdump(machine$) (initially) == md4(lmowf(unicode(machine))) +</para></listitem> +</varlistentry> + +<varlistentry> +<term>ARC4(K,Lk,D,Ld)</term> +<listitem><para>ARC4 encryption of data D of length Ld with key K of length Lk</para></listitem> +</varlistentry> + +<varlistentry> +<term>v[m..n(,l)]</term> +<listitem><para>subset of v from bytes m to n, optionally padded with zeroes to length l</para></listitem> +</varlistentry> + +<varlistentry> +<term>Cred(K,D)</term> +<listitem><para>E(K[7..7,7],E(K[0..6],D)) computes a credential</para></listitem> +</varlistentry> + +<varlistentry> +<term>Time()</term> +<listitem><para>4 byte current time</para></listitem> +</varlistentry> + +<varlistentry> +<term>Cc,Cs</term> +<listitem><para>8 byte client and server challenges Rc,Rs: 8 byte client and server credentials</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>Protocol</title> + +<programlisting> +C->S ReqChal,Cc +S->C Cs +</programlisting> + +<programlisting> +C & S compute session key Ks = E(PW[9..15],E(PW[0..6],Add(Cc,Cs))) +</programlisting> + +<programlisting> +C: Rc = Cred(Ks,Cc) +C->S Authenticate,Rc +S: Rs = Cred(Ks,Cs), assert(Rc == Cred(Ks,Cc)) +S->C Rs +C: assert(Rs == Cred(Ks,Cs)) +</programlisting> + +<para> +On joining the domain the client will optionally attempt to change its +password and the domain controller may refuse to update it depending +on registry settings. This will also occur weekly afterwards. +</para> + +<programlisting> +C: Tc = Time(), Rc' = Cred(Ks,Rc+Tc) +C->S ServerPasswordSet,Rc',Tc,arc4(Ks[0..7,16],lmowf(randompassword()) +C: Rc = Cred(Ks,Rc+Tc+1) +S: assert(Rc' == Cred(Ks,Rc+Tc)), Ts = Time() +S: Rs' = Cred(Ks,Rs+Tc+1) +S->C Rs',Ts +C: assert(Rs' == Cred(Ks,Rs+Tc+1)) +S: Rs = Rs' +</programlisting> + +<para> +User: U with password P wishes to login to the domain (incidental data +such as workstation and domain omitted) +</para> + +<programlisting> +C: Tc = Time(), Rc' = Cred(Ks,Rc+Tc) +C->S NetLogonSamLogon,Rc',Tc,U,arc4(Ks[0..7,16],16,ntowf(P),16), arc4(Ks[0..7,16],16,lmowf(P),16) +S: assert(Rc' == Cred(Ks,Rc+Tc)) assert(passwords match those in SAM) +S: Ts = Time() +</programlisting> + +<programlisting> +S->C Cred(Ks,Cred(Ks,Rc+Tc+1)),userinfo(logon script,UID,SIDs,etc) +C: assert(Rs == Cred(Ks,Cred(Rc+Tc+1)) +C: Rc = Cred(Ks,Rc+Tc+1) +</programlisting> + +</sect2> + +<sect2> +<title>Comments</title> + +<para> +On first joining the domain the session key could be computed by +anyone listening in on the network as the machine password has a well +known value. Until the machine is rebooted it will use this session +key to encrypt NT and LM one way functions of passwords which are +password equivalents. Any user who logs in before the machine has been +rebooted a second time will have their password equivalent exposed. Of +course the new machine password is exposed at this time anyway. +</para> + +<para> +None of the returned user info such as logon script, profile path and +SIDs *appear* to be protected by anything other than the TCP checksum. +</para> + +<para> +The server time stamps appear to be ignored. +</para> + +<para> +The client sends a ReturnAuthenticator in the SamLogon request which I +can't find a use for. However its time is used as the timestamp +returned by the server. +</para> + +<para> +The password OWFs should NOT be sent over the network reversibly +encrypted. They should be sent using ARC4(Ks,md4(owf)) with the server +computing the same function using the owf values in the SAM. +</para> + +</sect2> +</sect1> + +<sect1> +<title>SIDs and RIDs</title> + +<para> +SIDs and RIDs are well documented elsewhere. +</para> + +<para> +A SID is an NT Security ID (see DOM_SID structure). They are of the form: +</para> + +<simplelist> +<member>revision-NN-SubAuth1-SubAuth2-SubAuth3... </member> +<member>revision-0xNNNNNNNNNNNN-SubAuth1-SubAuth2-SubAuth3...</member> +</simplelist> + +<para> +currently, the SID revision is 1. +The Sub-Authorities are known as Relative IDs (RIDs). +</para> + +<sect2> +<title>Well-known SIDs</title> + +<sect3> +<title>Universal well-known SIDs</title> + +<variablelist> +<varlistentry> + <term>Null SID</term> + <listitem><para>S-1-0-0</para></listitem> +</varlistentry> +<varlistentry> + <term>World</term> + <listitem><para>S-1-1-0</para></listitem> +</varlistentry> +<varlistentry> + <term>Local</term> + <listitem><para>S-1-2-0</para></listitem> +</varlistentry> +<varlistentry> + <term>Creator Owner ID</term> + <listitem><para>S-1-3-0</para></listitem> +</varlistentry> +<varlistentry> + <term>Creator Group ID</term> + <listitem><para>S-1-3-1</para></listitem> +</varlistentry> +<varlistentry> + <term>Creator Owner Server ID</term> + <listitem><para>S-1-3-2</para></listitem> +</varlistentry> +<varlistentry> + <term>Creator Group Server ID</term> + <listitem><para>S-1-3-3</para></listitem> +</varlistentry> +<varlistentry> + <term>(Non-unique IDs)</term> + <listitem><para>S-1-4</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>NT well-known SIDs</title> + +<variablelist> +<varlistentry> + <term>NT Authority</term> + <listitem><para>S-1-5</para></listitem> +</varlistentry> +<varlistentry> + <term>Dialup</term> + <listitem><para>S-1-5-1</para></listitem> +</varlistentry> +<varlistentry> + <term>Network</term> + <listitem><para>S-1-5-2</para></listitem> +</varlistentry> +<varlistentry> + <term>Batch</term> + <listitem><para>S-1-5-3</para></listitem> +</varlistentry> +<varlistentry> + <term>Interactive</term> + <listitem><para>S-1-5-4</para></listitem> +</varlistentry> +<varlistentry> + <term>Service</term> +<listitem><para>S-1-5-6</para></listitem></varlistentry> +<varlistentry> + <term>AnonymousLogon(aka null logon session)</term> + <listitem><para>S-1-5-7</para></listitem> +</varlistentry> +<varlistentry> + <term>Proxy</term> +<listitem><para>S-1-5-8</para></listitem></varlistentry> +<varlistentry> + <term>ServerLogon(aka domain controller account)</term> + <listitem><para>S-1-5-8</para></listitem> +</varlistentry> +<varlistentry> + <term>(Logon IDs)</term> + <listitem><para>S-1-5-5-X-Y</para></listitem> +</varlistentry> +<varlistentry> + <term>(NT non-unique IDs)</term> + <listitem><para>S-1-5-0x15-...</para></listitem> +</varlistentry> +<varlistentry> + <term>(Built-in domain)</term> + <listitem><para>s-1-5-0x20</para></listitem> +</varlistentry> +</variablelist> + +</sect3> +</sect2> + +<sect2> +<title>Well-known RIDS</title> + +<para> +A RID is a sub-authority value, as part of either a SID, or in the case +of Group RIDs, part of the DOM_GID structure, in the USER_INFO_1 +structure, in the LSA SAM Logon response. +</para> + +<sect3> +<title>Well-known RID users</title> + +<segmentedlist> +<segtitle>Groupname</segtitle> +<segtitle>????</segtitle> +<segtitle>RID</segtitle> +<seglistitem><seg>DOMAIN_USER_RID_ADMIN</seg><seg>0x0000</seg><seg>01F4</seg></seglistitem> +<seglistitem><seg>DOMAIN_USER_RID_GUEST</seg><seg>0x0000</seg><seg>01F5</seg></seglistitem> +</segmentedlist> + +</sect3> + +<sect3> +<title>Well-known RID groups</title> + +<segmentedlist> +<segtitle>Groupname</segtitle> +<segtitle>????</segtitle> +<segtitle>RID</segtitle> +<seglistitem><seg> DOMAIN_GROUP_RID_ADMINS</seg><seg>0x0000</seg><seg>0200</seg></seglistitem> +<seglistitem><seg> DOMAIN_GROUP_RID_USERS</seg><seg>0x0000</seg><seg>0201</seg></seglistitem> +<seglistitem><seg> DOMAIN_GROUP_RID_GUESTS</seg><seg>0x0000</seg><seg>0202</seg></seglistitem> +</segmentedlist> + +</sect3> + +<sect3> +<title>Well-known RID aliases</title> + +<segmentedlist> +<segtitle>Groupname</segtitle> +<segtitle>????</segtitle> +<segtitle>RID</segtitle> +<seglistitem><seg> DOMAIN_ALIAS_RID_ADMINS</seg><seg>0x0000</seg><seg>0220</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_USERS</seg><seg>0x0000</seg><seg>0221</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_GUESTS</seg><seg>0x0000</seg><seg>0222</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_POWER_USERS</seg><seg>0x0000</seg><seg>0223</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_ACCOUNT_OPS</seg><seg>0x0000</seg><seg>0224</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_SYSTEM_OPS</seg><seg>0x0000</seg><seg>0225</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_PRINT_OPS</seg><seg>0x0000</seg><seg>0226</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_BACKUP_OPS</seg><seg>0x0000</seg><seg>0227</seg></seglistitem> +<seglistitem><seg> DOMAIN_ALIAS_RID_REPLICATOR</seg><seg>0x0000</seg><seg>0228</seg></seglistitem> +</segmentedlist> + +</sect3> +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/debug.xml b/docs/docbook/devdoc/debug.xml new file mode 100644 index 0000000000..7e81cc825d --- /dev/null +++ b/docs/docbook/devdoc/debug.xml @@ -0,0 +1,321 @@ +<chapter id="debug"> +<chapterinfo> + <author> + <firstname>Chris</firstname><surname>Hertel</surname> + </author> + <pubdate>July 1998</pubdate> +</chapterinfo> + +<title>The samba DEBUG system</title> + +<sect1> +<title>New Output Syntax</title> + +<para> + The syntax of a debugging log file is represented as: +</para> + +<para><programlisting> + >debugfile< :== { >debugmsg< } + + >debugmsg< :== >debughdr< '\n' >debugtext< + + >debughdr< :== '[' TIME ',' LEVEL ']' FILE ':' [FUNCTION] '(' LINE ')' + + >debugtext< :== { >debugline< } + + >debugline< :== TEXT '\n' +</programlisting></para> + +<para> +TEXT is a string of characters excluding the newline character. +</para> + +<para> +LEVEL is the DEBUG level of the message (an integer in the range + 0..10). +</para> + +<para> +TIME is a timestamp. +</para> + +<para> +FILE is the name of the file from which the debug message was +generated. +</para> + +<para> +FUNCTION is the function from which the debug message was generated. +</para> + +<para> +LINE is the line number of the debug statement that generated the +message. +</para> + +<para>Basically, what that all means is:</para> +<orderedlist> +<listitem><para> +A debugging log file is made up of debug messages. +</para></listitem> +<listitem><para> +Each debug message is made up of a header and text. The header is +separated from the text by a newline. +</para></listitem> +<listitem><para> +The header begins with the timestamp and debug level of the +message enclosed in brackets. The filename, function, and line +number at which the message was generated follow. The filename is +terminated by a colon, and the function name is terminated by the +parenthesis which contain the line number. Depending upon the +compiler, the function name may be missing (it is generated by the +__FUNCTION__ macro, which is not universally implemented, dangit). +</para></listitem> +<listitem><para> +The message text is made up of zero or more lines, each terminated +by a newline. +</para></listitem> +</orderedlist> + +<para>Here's some example output:</para> + +<para><programlisting> + [1998/08/03 12:55:25, 1] nmbd.c:(659) + Netbios nameserver version 1.9.19-prealpha started. + Copyright Andrew Tridgell 1994-1997 + [1998/08/03 12:55:25, 3] loadparm.c:(763) + Initializing global parameters +</programlisting></para> + +<para> +Note that in the above example the function names are not listed on +the header line. That's because the example above was generated on an +SGI Indy, and the SGI compiler doesn't support the __FUNCTION__ macro. +</para> + +</sect1> + +<sect1> +<title>The DEBUG() Macro</title> + +<para> +Use of the DEBUG() macro is unchanged. DEBUG() takes two parameters. +The first is the message level, the second is the body of a function +call to the Debug1() function. +</para> + +<para>That's confusing.</para> + +<para>Here's an example which may help a bit. If you would write</para> + +<para><programlisting> +printf( "This is a %s message.\n", "debug" ); +</programlisting></para> + +<para> +to send the output to stdout, then you would write +</para> + +<para><programlisting> +DEBUG( 0, ( "This is a %s message.\n", "debug" ) ); +</programlisting></para> + +<para> +to send the output to the debug file. All of the normal printf() +formatting escapes work. +</para> + +<para> +Note that in the above example the DEBUG message level is set to 0. +Messages at level 0 always print. Basically, if the message level is +less than or equal to the global value DEBUGLEVEL, then the DEBUG +statement is processed. +</para> + +<para> +The output of the above example would be something like: +</para> + +<para><programlisting> + [1998/07/30 16:00:51, 0] file.c:function(128) + This is a debug message. +</programlisting></para> + +<para> +Each call to DEBUG() creates a new header *unless* the output produced +by the previous call to DEBUG() did not end with a '\n'. Output to the +debug file is passed through a formatting buffer which is flushed +every time a newline is encountered. If the buffer is not empty when +DEBUG() is called, the new input is simply appended. +</para> + +<para> +...but that's really just a Kludge. It was put in place because +DEBUG() has been used to write partial lines. Here's a simple (dumb) +example of the kind of thing I'm talking about: +</para> + +<para><programlisting> + DEBUG( 0, ("The test returned " ) ); + if( test() ) + DEBUG(0, ("True") ); + else + DEBUG(0, ("False") ); + DEBUG(0, (".\n") ); +</programlisting></para> + +<para> +Without the format buffer, the output (assuming test() returned true) +would look like this: +</para> + +<para><programlisting> + [1998/07/30 16:00:51, 0] file.c:function(256) + The test returned + [1998/07/30 16:00:51, 0] file.c:function(258) + True + [1998/07/30 16:00:51, 0] file.c:function(261) + . +</programlisting></para> + +<para>Which isn't much use. The format buffer kludge fixes this problem. +</para> + +</sect1> + +<sect1> +<title>The DEBUGADD() Macro</title> + +<para> +In addition to the kludgey solution to the broken line problem +described above, there is a clean solution. The DEBUGADD() macro never +generates a header. It will append new text to the current debug +message even if the format buffer is empty. The syntax of the +DEBUGADD() macro is the same as that of the DEBUG() macro. +</para> + +<para><programlisting> + DEBUG( 0, ("This is the first line.\n" ) ); + DEBUGADD( 0, ("This is the second line.\nThis is the third line.\n" ) ); +</programlisting></para> + +<para>Produces</para> + +<para><programlisting> + [1998/07/30 16:00:51, 0] file.c:function(512) + This is the first line. + This is the second line. + This is the third line. +</programlisting></para> + +</sect1> + +<sect1> +<title>The DEBUGLVL() Macro</title> + +<para> +One of the problems with the DEBUG() macro was that DEBUG() lines +tended to get a bit long. Consider this example from +nmbd_sendannounce.c: +</para> + +<para><programlisting> + DEBUG(3,("send_local_master_announcement: type %x for name %s on subnet %s for workgroup %s\n", + type, global_myname, subrec->subnet_name, work->work_group)); +</programlisting></para> + +<para> +One solution to this is to break it down using DEBUG() and DEBUGADD(), +as follows: +</para> + +<para><programlisting> + DEBUG( 3, ( "send_local_master_announcement: " ) ); + DEBUGADD( 3, ( "type %x for name %s ", type, global_myname ) ); + DEBUGADD( 3, ( "on subnet %s ", subrec->subnet_name ) ); + DEBUGADD( 3, ( "for workgroup %s\n", work->work_group ) ); +</programlisting></para> + +<para> +A similar, but arguably nicer approach is to use the DEBUGLVL() macro. +This macro returns True if the message level is less than or equal to +the global DEBUGLEVEL value, so: +</para> + +<para><programlisting> + if( DEBUGLVL( 3 ) ) + { + dbgtext( "send_local_master_announcement: " ); + dbgtext( "type %x for name %s ", type, global_myname ); + dbgtext( "on subnet %s ", subrec->subnet_name ); + dbgtext( "for workgroup %s\n", work->work_group ); + } +</programlisting></para> + +<para>(The dbgtext() function is explained below.)</para> + +<para>There are a few advantages to this scheme:</para> +<orderedlist> +<listitem><para> +The test is performed only once. +</para></listitem> +<listitem><para> +You can allocate variables off of the stack that will only be used +within the DEBUGLVL() block. +</para></listitem> +<listitem><para> +Processing that is only relevant to debug output can be contained +within the DEBUGLVL() block. +</para></listitem> +</orderedlist> + +</sect1> + +<sect1> +<title>New Functions</title> + +<sect2> +<title>dbgtext()</title> +<para> +This function prints debug message text to the debug file (and +possibly to syslog) via the format buffer. The function uses a +variable argument list just like printf() or Debug1(). The +input is printed into a buffer using the vslprintf() function, +and then passed to format_debug_text(). + +If you use DEBUGLVL() you will probably print the body of the +message using dbgtext(). +</para> +</sect2> + +<sect2> +<title>dbghdr()</title> +<para> +This is the function that writes a debug message header. +Headers are not processed via the format buffer. Also note that +if the format buffer is not empty, a call to dbghdr() will not +produce any output. See the comments in dbghdr() for more info. +</para> + +<para> +It is not likely that this function will be called directly. It +is used by DEBUG() and DEBUGADD(). +</para> +</sect2> + +<sect2> +<title>format_debug_text()</title> +<para> +This is a static function in debug.c. It stores the output text +for the body of the message in a buffer until it encounters a +newline. When the newline character is found, the buffer is +written to the debug file via the Debug1() function, and the +buffer is reset. This allows us to add the indentation at the +beginning of each line of the message body, and also ensures +that the output is written a line at a time (which cleans up +syslog output). +</para> +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/dev-doc.xml b/docs/docbook/devdoc/dev-doc.xml new file mode 100644 index 0000000000..26374f7f39 --- /dev/null +++ b/docs/docbook/devdoc/dev-doc.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE book SYSTEM "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY NetBIOS SYSTEM "NetBIOS.xml"> +<!ENTITY Architecture SYSTEM "architecture.xml"> +<!ENTITY debug SYSTEM "debug.xml"> +<!ENTITY internals SYSTEM "internals.xml"> +<!ENTITY parsing SYSTEM "parsing.xml"> +<!ENTITY unix-smb SYSTEM "unix-smb.xml"> +<!ENTITY CodingSuggestions SYSTEM "CodingSuggestions.xml"> +<!ENTITY Tracing SYSTEM "Tracing.xml"> +<!ENTITY cifsntdomain SYSTEM "cifsntdomain.xml"> +<!ENTITY printing SYSTEM "printing.xml"> +<!ENTITY wins SYSTEM "wins.xml"> +<!ENTITY sam SYSTEM "sam.xml"> +<!ENTITY encryption SYSTEM "encryption.xml"> +<!ENTITY rpc-plugin SYSTEM "rpc_plugin.xml"> +<!ENTITY modules SYSTEM "modules.xml"> +<!ENTITY packagers SYSTEM "packagers.xml"> +]> + +<book id="Samba-Developers-Guide"> + +<title>SAMBA Developers Guide</title> + +<bookinfo> + <author> + <surname>SAMBA Team</surname> + </author> + <address><email>samba@samba.org</email></address> +</bookinfo> + +<dedication> +<title>Abstract</title> + +<para> +<emphasis>Last Update</emphasis> : Mon Sep 30 15:23:53 CDT 2002 +</para> + +<para> +This book is a collection of documents that might be useful for +people developing samba or those interested in doing so. +It's nothing more than a collection of documents written by samba developers about +the internals of various parts of samba and the SMB protocol. It's still incomplete. +The most recent version of this document +can be found at <ulink url="http://devel.samba.org/">http://devel.samba.org/</ulink>. +Please send updates to <ulink +url="mailto:jelmer@samba.org">Jelmer Veenrooij</ulink>. +</para> + +<para> +This documentation is distributed under the GNU General Public License (GPL) +version 2. A copy of the license is included with the Samba source +distribution. A copy can be found on-line at <ulink +url="http://www.fsf.org/licenses/gpl.txt">http://www.fsf.org/licenses/gpl.txt</ulink> +</para> + +</dedication> + +<!-- Contents --> +<toc/> + +<!-- Chapters --> +&NetBIOS; +&Architecture; +&debug; +&CodingSuggestions; +&internals; +&parsing; +&unix-smb; +&Tracing; +&cifsntdomain; +&printing; +&wins; +&sam; +&encryption; +&modules; +&rpc-plugin; +&packagers; + +</book> diff --git a/docs/docbook/devdoc/encryption.xml b/docs/docbook/devdoc/encryption.xml new file mode 100644 index 0000000000..56a1d10c9c --- /dev/null +++ b/docs/docbook/devdoc/encryption.xml @@ -0,0 +1,197 @@ +<chapter id="pwencrypt"> + + +<chapterinfo> + <author> + <firstname>Jeremy</firstname><surname>Allison</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address> + <email>samba@samba.org</email> + </address> + </affiliation> + </author> + + <pubdate>19 Apr 1999</pubdate> +</chapterinfo> + +<title>LanMan and NT Password Encryption</title> + +<sect1> + <title>Introduction</title> + + <para>With the development of LanManager and Windows NT + compatible password encryption for Samba, it is now able + to validate user connections in exactly the same way as + a LanManager or Windows NT server.</para> + + <para>This document describes how the SMB password encryption + algorithm works and what issues there are in choosing whether + you want to use it. You should read it carefully, especially + the part about security and the "PROS and CONS" section.</para> + +</sect1> + +<sect1> + <title>How does it work?</title> + + <para>LanManager encryption is somewhat similar to UNIX + password encryption. The server uses a file containing a + hashed value of a user's password. This is created by taking + the user's plaintext password, capitalising it, and either + truncating to 14 bytes or padding to 14 bytes with null bytes. + This 14 byte value is used as two 56 bit DES keys to encrypt + a 'magic' eight byte value, forming a 16 byte value which is + stored by the server and client. Let this value be known as + the "hashed password".</para> + + <para>Windows NT encryption is a higher quality mechanism, + consisting of doing an MD4 hash on a Unicode version of the user's + password. This also produces a 16 byte hash value that is + non-reversible.</para> + + <para>When a client (LanManager, Windows for WorkGroups, Windows + 95 or Windows NT) wishes to mount a Samba drive (or use a Samba + resource), it first requests a connection and negotiates the + protocol that the client and server will use. In the reply to this + request the Samba server generates and appends an 8 byte, random + value - this is stored in the Samba server after the reply is sent + and is known as the "challenge". The challenge is different for + every client connection.</para> + + <para>The client then uses the hashed password (16 byte values + described above), appended with 5 null bytes, as three 56 bit + DES keys, each of which is used to encrypt the challenge 8 byte + value, forming a 24 byte value known as the "response".</para> + + <para>In the SMB call SMBsessionsetupX (when user level security + is selected) or the call SMBtconX (when share level security is + selected), the 24 byte response is returned by the client to the + Samba server. For Windows NT protocol levels the above calculation + is done on both hashes of the user's password and both responses are + returned in the SMB call, giving two 24 byte values.</para> + + <para>The Samba server then reproduces the above calculation, using + its own stored value of the 16 byte hashed password (read from the + <filename>smbpasswd</filename> file - described later) and the challenge + value that it kept from the negotiate protocol reply. It then checks + to see if the 24 byte value it calculates matches the 24 byte value + returned to it from the client.</para> + + <para>If these values match exactly, then the client knew the + correct password (or the 16 byte hashed value - see security note + below) and is thus allowed access. If not, then the client did not + know the correct password and is denied access.</para> + + <para>Note that the Samba server never knows or stores the cleartext + of the user's password - just the 16 byte hashed values derived from + it. Also note that the cleartext password or 16 byte hashed values + are never transmitted over the network - thus increasing security.</para> +</sect1> + +<sect1> + <title>The smbpasswd file</title> + <anchor id="SMBPASSWDFILEFORMAT"/> + <para>In order for Samba to participate in the above protocol + it must be able to look up the 16 byte hashed values given a user name. + Unfortunately, as the UNIX password value is also a one way hash + function (ie. it is impossible to retrieve the cleartext of the user's + password given the UNIX hash of it), a separate password file + containing this 16 byte value must be kept. To minimise problems with + these two password files, getting out of sync, the UNIX <filename> + /etc/passwd</filename> and the <filename>smbpasswd</filename> file, + a utility, <command>mksmbpasswd.sh</command>, is provided to generate + a smbpasswd file from a UNIX <filename>/etc/passwd</filename> file. + </para> + + + <para>To generate the smbpasswd file from your <filename>/etc/passwd + </filename> file use the following command:</para> + + <para><prompt>$ </prompt><userinput>cat /etc/passwd | mksmbpasswd.sh + > /usr/local/samba/private/smbpasswd</userinput></para> + + <para>If you are running on a system that uses NIS, use</para> + + <para><prompt>$ </prompt><userinput>ypcat passwd | mksmbpasswd.sh + > /usr/local/samba/private/smbpasswd</userinput></para> + + <para>The <command>mksmbpasswd.sh</command> program is found in + the Samba source directory. By default, the smbpasswd file is + stored in :</para> + + <para><filename>/usr/local/samba/private/smbpasswd</filename></para> + + <para>The owner of the <filename>/usr/local/samba/private/</filename> + directory should be set to root, and the permissions on it should + be set to 0500 (<command>chmod 500 /usr/local/samba/private</command>). + </para> + + <para>Likewise, the smbpasswd file inside the private directory should + be owned by root and the permissions on is should be set to 0600 + (<command>chmod 600 smbpasswd</command>).</para> + + + <para>The format of the smbpasswd file is (The line has been + wrapped here. It should appear as one entry per line in + your smbpasswd file.)</para> + + <para><programlisting> +username:uid:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: + [Account type]:LCT-<last-change-time>:Long name + </programlisting></para> + + <para>Although only the <replaceable>username</replaceable>, + <replaceable>uid</replaceable>, <replaceable> + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</replaceable>, + [<replaceable>Account type</replaceable>] and <replaceable> + last-change-time</replaceable> sections are significant + and are looked at in the Samba code.</para> + + <para>It is <emphasis>VITALLY</emphasis> important that there by 32 + 'X' characters between the two ':' characters in the XXX sections - + the smbpasswd and Samba code will fail to validate any entries that + do not have 32 characters between ':' characters. The first XXX + section is for the Lanman password hash, the second is for the + Windows NT version.</para> + + <para>When the password file is created all users have password entries + consisting of 32 'X' characters. By default this disallows any access + as this user. When a user has a password set, the 'X' characters change + to 32 ascii hexadecimal digits (0-9, A-F). These are an ascii + representation of the 16 byte hashed value of a user's password.</para> + + <para>To set a user to have no password (not recommended), edit the file + using vi, and replace the first 11 characters with the ascii text + <constant>"NO PASSWORD"</constant> (minus the quotes).</para> + + <para>For example, to clear the password for user bob, his smbpasswd file + entry would look like :</para> + + <para><programlisting> +bob:100:NO PASSWORDXXXXXXXXXXXXXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX: + [U ]:LCT-00000000:Bob's full name:/bobhome:/bobshell + </programlisting></para> + + <para>If you are allowing users to use the smbpasswd command to set + their own passwords, you may want to give users NO PASSWORD initially + so they do not have to enter a previous password when changing to their + new password (not recommended). In order for you to allow this the + <command>smbpasswd</command> program must be able to connect to the + <command>smbd</command> daemon as that user with no password. Enable this + by adding the line :</para> + + <para><command>null passwords = yes</command></para> + + <para>to the [global] section of the smb.conf file (this is why + the above scenario is not recommended). Preferably, allocate your + users a default password to begin with, so you do not have + to enable this on your server.</para> + + <para><emphasis>Note : </emphasis>This file should be protected very + carefully. Anyone with access to this file can (with enough knowledge of + the protocols) gain access to your SMB server. The file is thus more + sensitive than a normal unix <filename>/etc/passwd</filename> file.</para> +</sect1> + +</chapter> diff --git a/docs/docbook/devdoc/gencache.xml b/docs/docbook/devdoc/gencache.xml new file mode 100644 index 0000000000..1ba2f77c9d --- /dev/null +++ b/docs/docbook/devdoc/gencache.xml @@ -0,0 +1,119 @@ +<chapter id="gencache"> +<chapterinfo> + <author> + <firstname>Rafal</firstname><surname>Szczesniak</surname> + </author> + <pubdate>April 2003</pubdate> +</chapterinfo> + +<title>General cache mechanism and API</title> + +<sect1> +<title>Abstract</title> +<para> +General cache (gencache) was designed to combine various kinds of caching +mechanisms into one, defined by a simple API. This way, anyone can use it +to create their own caching layer on top of gencache. An example of +such approach is the netbios name cache. +</para> +</sect1> + +<sect1> +<title>The mechanism</title> +<para> +Gencache utilises <emphasise>tdb</emphasise> database, like many other +parts of Samba. As its origins are in Berkeley DB implementation, it +uses key/value pairs stored in binary file. The values gencache +operates on are string-based, however. This makes very easy to use it +in command line environment eg. to quickly take a look at what's in +the cache or set some value. +</para> + +<para> +All the data is stored in <filename>gencache.tdb</filename> +file. Records put there are in key/value format as mentioned below, +but as it's a cache, the timeout plays also important role and has a +special place in the key/value pair, as well as API. +</para> +</sect1> + + +<sect1> +<title>The data structure</title> +<para> +The record stored in <filename>gencache.tdb</filename> file consists +of the key, the value and the expiration timeout. While the first part +is stored completely independent from the others, the last two are +kept together. The form the record has is: +</para> + +<para><programlisting> +key: <string&bt; +value: <12-digit timeout&bt;/<string> +</programlisting></para> + +<para>The timeout part is the ASCII representation of +<emphasis>time_t</emphasis> value of the time when the cache entry +expires. Obviously the API, the programmer is provided with, hides this detail, +so that you don't have to care about checking it. Simply watch +carefully the return status of the function. +</para> +</sect1> + +<sect1> +<title>The API</title> + +<para><programlisting> +BOOL gencache_init() +</programlisting></para> + +<para>This is used to initialise to whole caching mechanism. It means +opening the file or creating it if non-existing. If it's already been +opened earlier, then the routine just does nothing and returns +<constant>true</constant>. If something goes wrong, say the user +doesn't have necessary rights, the function returns +<constant>false</constant>.</para> + +<para><programlisting> +BOOL gencache_shutdown() +</programlisting></para> + +<para>This is the proper way to close the cache file. It simply +returns <constant>true</constant> after successful closing file and +<constant>false</constant> upon a failure.</para> + +<para><programlisting> +BOOL gencache_set(const char* keystr, const char* value, time_t timeout) +</programlisting></para> + +<para>This is one of the most basic functions. What it allows you to +do is to set some particular cache entry. If the entry haven't +existed yet, the function will act just as it was "gencache_add" +function. If it's already been in the cache, the entry will be set to +the new value. In either case, the cache entry will be set with given +key, value and timeout. Thus it is comfortable way to just set the +entry and not care about the details.</para> + +<para><programlisting> +BOOL gencache_set_only(const char* keystr, const char* value, time_t timeout) +</programlisting></para> + +<para><programlisting> +BOOL gencache_del(const char* keystr) +</programlisting></para> + +<para><programlisting> +BOOL gencache_get(const char* keystr, char** valstr, time_t* timeout) +</programlisting></para> + +<para><programlisting> +void gencache_iterate(void (*fn)(const char* key, const char *value, time_t timeout, void* dptr), + void* data, const char* keystr_pattern) + +</programlisting></para> + +<sect1> +<title>Writing your own caching layer</title> +</sect1> + +</chapter> diff --git a/docs/docbook/devdoc/internals.xml b/docs/docbook/devdoc/internals.xml new file mode 100644 index 0000000000..982cfd2e10 --- /dev/null +++ b/docs/docbook/devdoc/internals.xml @@ -0,0 +1,440 @@ +<chapter id="internals"> +<chapterinfo> + <author> + <firstname>David</firstname><surname>Chappell</surname> + <affiliation> + <address><email>David.Chappell@mail.trincoll.edu</email></address> + </affiliation> + </author> + <pubdate>8 May 1996</pubdate> +</chapterinfo> + +<title>Samba Internals</title> + +<sect1> +<title>Character Handling</title> +<para> +This section describes character set handling in Samba, as implemented in +Samba 3.0 and above +</para> + +<para> +In the past Samba had very ad-hoc character set handling. Scattered +throughout the code were numerous calls which converted particular +strings to/from DOS codepages. The problem is that there was no way of +telling if a particular char* is in dos codepage or unix +codepage. This led to a nightmare of code that tried to cope with +particular cases without handlingt the general case. +</para> +</sect1> + +<sect1> +<title>The new functions</title> + +<para> +The new system works like this: +</para> + +<orderedlist> +<listitem><para> + all char* strings inside Samba are "unix" strings. These are + multi-byte strings that are in the charset defined by the "unix + charset" option in smb.conf. +</para></listitem> + +<listitem><para> + there is no single fixed character set for unix strings, but any + character set that is used does need the following properties: + </para> + <orderedlist> + + <listitem><para> + must not contain NULLs except for termination + </para></listitem> + + <listitem><para> + must be 7-bit compatible with C strings, so that a constant + string or character in C will be byte-for-byte identical to the + equivalent string in the chosen character set. + </para></listitem> + + <listitem><para> + when you uppercase or lowercase a string it does not become + longer than the original string + </para></listitem> + + <listitem><para> + must be able to correctly hold all characters that your client + will throw at it + </para></listitem> + </orderedlist> + + <para> + For example, UTF-8 is fine, and most multi-byte asian character sets + are fine, but UCS2 could not be used for unix strings as they + contain nulls. + </para> +</listitem> + +<listitem><para> + when you need to put a string into a buffer that will be sent on the + wire, or you need a string in a character set format that is + compatible with the clients character set then you need to use a + pull_ or push_ function. The pull_ functions pull a string from a + wire buffer into a (multi-byte) unix string. The push_ functions + push a string out to a wire buffer. +</para></listitem> + +<listitem><para> + the two main pull_ and push_ functions you need to understand are + pull_string and push_string. These functions take a base pointer + that should point at the start of the SMB packet that the string is + in. The functions will check the flags field in this packet to + automatically determine if the packet is marked as a unicode packet, + and they will choose whether to use unicode for this string based on + that flag. You may also force this decision using the STR_UNICODE or + STR_ASCII flags. For use in smbd/ and libsmb/ there are wrapper + functions clistr_ and srvstr_ that call the pull_/push_ functions + with the appropriate first argument. + </para> + + <para> + You may also call the pull_ascii/pull_ucs2 or push_ascii/push_ucs2 + functions if you know that a particular string is ascii or + unicode. There are also a number of other convenience functions in + charcnv.c that call the pull_/push_ functions with particularly + common arguments, such as pull_ascii_pstring() + </para> +</listitem> + +<listitem><para> + The biggest thing to remember is that internal (unix) strings in Samba + may now contain multi-byte characters. This means you cannot assume + that characters are always 1 byte long. Often this means that you will + have to convert strings to ucs2 and back again in order to do some + (seemingly) simple task. For examples of how to do this see functions + like strchr_m(). I know this is very slow, and we will eventually + speed it up but right now we want this stuff correct not fast. +</para></listitem> + +<listitem><para> + all lp_ functions now return unix strings. The magic "DOS" flag on + parameters is gone. +</para></listitem> + +<listitem><para> + all vfs functions take unix strings. Don't convert when passing to them +</para></listitem> + +</orderedlist> + +</sect1> + +<sect1> +<title>Macros in byteorder.h</title> + +<para> +This section describes the macros defined in byteorder.h. These macros +are used extensively in the Samba code. +</para> + +<sect2> +<title>CVAL(buf,pos)</title> + +<para> +returns the byte at offset pos within buffer buf as an unsigned character. +</para> +</sect2> + +<sect2> +<title>PVAL(buf,pos)</title> +<para>returns the value of CVAL(buf,pos) cast to type unsigned integer.</para> +</sect2> + +<sect2> +<title>SCVAL(buf,pos,val)</title> +<para>sets the byte at offset pos within buffer buf to value val.</para> +</sect2> + +<sect2> +<title>SVAL(buf,pos)</title> +<para> + returns the value of the unsigned short (16 bit) little-endian integer at + offset pos within buffer buf. An integer of this type is sometimes + refered to as "USHORT". +</para> +</sect2> + +<sect2> +<title>IVAL(buf,pos)</title> +<para>returns the value of the unsigned 32 bit little-endian integer at offset +pos within buffer buf.</para> +</sect2> + +<sect2> +<title>SVALS(buf,pos)</title> +<para>returns the value of the signed short (16 bit) little-endian integer at +offset pos within buffer buf.</para> +</sect2> + +<sect2> +<title>IVALS(buf,pos)</title> +<para>returns the value of the signed 32 bit little-endian integer at offset pos +within buffer buf.</para> +</sect2> + +<sect2> +<title>SSVAL(buf,pos,val)</title> +<para>sets the unsigned short (16 bit) little-endian integer at offset pos within +buffer buf to value val.</para> +</sect2> + +<sect2> +<title>SIVAL(buf,pos,val)</title> +<para>sets the unsigned 32 bit little-endian integer at offset pos within buffer +buf to the value val.</para> +</sect2> + +<sect2> +<title>SSVALS(buf,pos,val)</title> +<para>sets the short (16 bit) signed little-endian integer at offset pos within +buffer buf to the value val.</para> +</sect2> + +<sect2> +<title>SIVALS(buf,pos,val)</title> +<para>sets the signed 32 bit little-endian integer at offset pos withing buffer +buf to the value val.</para> +</sect2> + +<sect2> +<title>RSVAL(buf,pos)</title> +<para>returns the value of the unsigned short (16 bit) big-endian integer at +offset pos within buffer buf.</para> +</sect2> + +<sect2> +<title>RIVAL(buf,pos)</title> +<para>returns the value of the unsigned 32 bit big-endian integer at offset +pos within buffer buf.</para> +</sect2> + +<sect2> +<title>RSSVAL(buf,pos,val)</title> +<para>sets the value of the unsigned short (16 bit) big-endian integer at +offset pos within buffer buf to value val. +refered to as "USHORT".</para> +</sect2> + +<sect2> +<title>RSIVAL(buf,pos,val)</title> +<para>sets the value of the unsigned 32 bit big-endian integer at offset +pos within buffer buf to value val.</para> +</sect2> + +</sect1> + + +<sect1> +<title>LAN Manager Samba API</title> + +<para> +This section describes the functions need to make a LAN Manager RPC call. +This information had been obtained by examining the Samba code and the LAN +Manager 2.0 API documentation. It should not be considered entirely +reliable. +</para> + +<para> +<programlisting> +call_api(int prcnt, int drcnt, int mprcnt, int mdrcnt, + char *param, char *data, char **rparam, char **rdata); +</programlisting> +</para> + +<para> +This function is defined in client.c. It uses an SMB transaction to call a +remote api. +</para> + +<sect2> +<title>Parameters</title> + +<para>The parameters are as follows:</para> + +<orderedlist> +<listitem><para> + prcnt: the number of bytes of parameters begin sent. +</para></listitem> +<listitem><para> + drcnt: the number of bytes of data begin sent. +</para></listitem> +<listitem><para> + mprcnt: the maximum number of bytes of parameters which should be returned +</para></listitem> +<listitem><para> + mdrcnt: the maximum number of bytes of data which should be returned +</para></listitem> +<listitem><para> + param: a pointer to the parameters to be sent. +</para></listitem> +<listitem><para> + data: a pointer to the data to be sent. +</para></listitem> +<listitem><para> + rparam: a pointer to a pointer which will be set to point to the returned + paramters. The caller of call_api() must deallocate this memory. +</para></listitem> +<listitem><para> + rdata: a pointer to a pointer which will be set to point to the returned + data. The caller of call_api() must deallocate this memory. +</para></listitem> +</orderedlist> + +<para> +These are the parameters which you ought to send, in the order of their +appearance in the parameter block: +</para> + +<orderedlist> + +<listitem><para> +An unsigned 16 bit integer API number. You should set this value with +SSVAL(). I do not know where these numbers are described. +</para></listitem> + +<listitem><para> +An ASCIIZ string describing the parameters to the API function as defined +in the LAN Manager documentation. The first parameter, which is the server +name, is ommited. This string is based uppon the API function as described +in the manual, not the data which is actually passed. +</para></listitem> + +<listitem><para> +An ASCIIZ string describing the data structure which ought to be returned. +</para></listitem> + +<listitem><para> +Any parameters which appear in the function call, as defined in the LAN +Manager API documentation, after the "Server" and up to and including the +"uLevel" parameters. +</para></listitem> + +<listitem><para> +An unsigned 16 bit integer which gives the size in bytes of the buffer we +will use to receive the returned array of data structures. Presumably this +should be the same as mdrcnt. This value should be set with SSVAL(). +</para></listitem> + +<listitem><para> +An ASCIIZ string describing substructures which should be returned. If no +substructures apply, this string is of zero length. +</para></listitem> + +</orderedlist> + +<para> +The code in client.c always calls call_api() with no data. It is unclear +when a non-zero length data buffer would be sent. +</para> + +</sect2> + +<sect2> +<title>Return value</title> + +<para> +The returned parameters (pointed to by rparam), in their order of appearance +are:</para> + +<orderedlist> + +<listitem><para> +An unsigned 16 bit integer which contains the API function's return code. +This value should be read with SVAL(). +</para></listitem> + +<listitem><para> +An adjustment which tells the amount by which pointers in the returned +data should be adjusted. This value should be read with SVAL(). Basically, +the address of the start of the returned data buffer should have the returned +pointer value added to it and then have this value subtracted from it in +order to obtain the currect offset into the returned data buffer. +</para></listitem> + +<listitem><para> +A count of the number of elements in the array of structures returned. +It is also possible that this may sometimes be the number of bytes returned. +</para></listitem> +</orderedlist> + +<para> +When call_api() returns, rparam points to the returned parameters. The +first if these is the result code. It will be zero if the API call +suceeded. This value by be read with "SVAL(rparam,0)". +</para> + +<para> +The second parameter may be read as "SVAL(rparam,2)". It is a 16 bit offset +which indicates what the base address of the returned data buffer was when +it was built on the server. It should be used to correct pointer before +use. +</para> + +<para> +The returned data buffer contains the array of returned data structures. +Note that all pointers must be adjusted before use. The function +fix_char_ptr() in client.c can be used for this purpose. +</para> + +<para> +The third parameter (which may be read as "SVAL(rparam,4)") has something to +do with indicating the amount of data returned or possibly the amount of +data which can be returned if enough buffer space is allowed. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Code character table</title> +<para> +Certain data structures are described by means of ASCIIz strings containing +code characters. These are the code characters: +</para> + +<orderedlist> +<listitem><para> +W a type byte little-endian unsigned integer +</para></listitem> +<listitem><para> +N a count of substructures which follow +</para></listitem> +<listitem><para> +D a four byte little-endian unsigned integer +</para></listitem> +<listitem><para> +B a byte (with optional count expressed as trailing ASCII digits) +</para></listitem> +<listitem><para> +z a four byte offset to a NULL terminated string +</para></listitem> +<listitem><para> +l a four byte offset to non-string user data +</para></listitem> +<listitem><para> +b an offset to data (with count expressed as trailing ASCII digits) +</para></listitem> +<listitem><para> +r pointer to returned data buffer??? +</para></listitem> +<listitem><para> +L length in bytes of returned data buffer??? +</para></listitem> +<listitem><para> +h number of bytes of information available??? +</para></listitem> +</orderedlist> + +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/modules.xml b/docs/docbook/devdoc/modules.xml new file mode 100644 index 0000000000..0bcdadc66c --- /dev/null +++ b/docs/docbook/devdoc/modules.xml @@ -0,0 +1,156 @@ +<chapter id="modules"> +<chapterinfo> + <author> + <firstname>Jelmer</firstname><surname>Vernooij</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>jelmer@samba.org</email></address> + </affiliation> + </author> + <pubdate> 19 March 2003 </pubdate> +</chapterinfo> + +<title>Modules</title> + +<sect1> +<title>Advantages</title> + +<para> +The new modules system has the following advantages: +</para> + +<simplelist> +<member>Transparent loading of static and shared modules (no need +for a subsystem to know about modules)</member> +<member>Simple selection between shared and static modules at configure time</member> +<member>"preload modules" option for increasing performance for stable modules</member> +<member>No nasty #define stuff anymore</member> +<member>All backends are available as plugin now (including pdb_ldap and pdb_tdb)</member> +</simplelist> +</sect1> + +<sect1> +<title>Loading modules</title> + +<para> +Some subsystems in samba use different backends. These backends can be +either statically linked in to samba or available as a plugin. A subsystem +should have a function that allows a module to register itself. For example, +the passdb subsystem has: +</para> + +<para><programlisting> +BOOL smb_register_passdb(const char *name, pdb_init_function init, int version); +</programlisting></para> + +<para> +This function will be called by the initialisation function of the module to +register itself. +</para> + +<sect2> +<title>Static modules</title> + +<para> +The modules system compiles a list of initialisation functions for the +static modules of each subsystem. This is a define. For example, +it is here currently (from <filename>include/config.h</filename>): +</para> + +<para><programlisting> +/* Static init functions */ +#define static_init_pdb { pdb_mysql_init(); pdb_ldap_init(); pdb_smbpasswd_init(); pdb_tdbsam_init(); pdb_guest_init();} +</programlisting></para> + +<para> +These functions should be called before the subsystem is used. That +should be done when the subsystem is initialised or first used. +</para> + +</sect2> + +<sect2> +<title>Shared modules</title> + +<para> +If a subsystem needs a certain backend, it should check if it has +already been registered. If the backend hasn't been registered already, +the subsystem should call smb_probe_module(char *subsystem, char *backend). +This function tries to load the correct module from a certain path +($LIBDIR/subsystem/backend.so). If the first character in 'backend' +is a slash, smb_probe_module() tries to load the module from the +absolute path specified in 'backend'. +</para> + +<para>After smb_probe_module() has been executed, the subsystem +should check again if the module has been registered. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Writing modules</title> + +<para> +Each module has an initialisation function. For modules that are +included with samba this name is '<replaceable>subsystem</replaceable>_<replaceable>backend</replaceable>_init'. For external modules (that will never be built-in, but only available as a module) this name is always 'init_module'. (In the case of modules included with samba, the configure system will add a #define subsystem_backend_init() init_module()). +The prototype for these functions is: +</para> + +<para><programlisting> +int init_module(void); +</programlisting></para> + +<para>This function should call one or more +registration functions. The function should return non-zero on success and zero on +failure.</para> + +<para>For example, pdb_ldap_init() contains: </para> + +<para><programlisting> +int pdb_ldap_init(void) +{ + smb_register_passdb("ldapsam", pdb_init_ldapsam, PASSDB_INTERFACE_VERSION); + smb_register_passdb("ldapsam_nua", pdb_init_ldapsam_nua, PASSDB_INTERFACE_VERSION); + return TRUE; +} +</programlisting></para> + +<sect2> +<title>Static/Shared selection in configure.in</title> + +<para> +Some macros in configure.in generate the various defines and substs that +are necessary for the system to work correct. All modules that should +be built by default have to be added to the variable 'default_modules'. +For example, if ldap is found, pdb_ldap is added to this variable. +</para> + +<para> +On the bottom of configure.in, SMB_MODULE() should be called +for each module and SMB_SUBSYSTEM() for each subsystem. +</para> + +<para>Syntax:</para> + +<para><programlisting> +SMB_MODULE(<replaceable>subsystem</replaceable>_<replaceable>backend</replaceable>, <replaceable>object files</replaceable>, <replaceable>plugin name</replaceable>, <replaceable>subsystem name</replaceable>, <replaceable>static_action</replaceable>, <replaceable>shared_action</replaceable>) +SMB_SUBSYSTEM(<replaceable>subsystem</replaceable>) +</programlisting></para> + +<para>Also, make sure to add the correct directives to +<filename>Makefile.in</filename>. <replaceable>@SUBSYSTEM_STATIC@</replaceable> +will be replaced with a list of objects files of the modules that need to +be linked in statically. <replaceable>@SUBSYSTEM_MODULES@</replaceable> will +be replaced with the names of the plugins to build. +</para> + +<para>You must make sure all .c files that contain defines that can +be changed by ./configure are rebuilded in the 'modules_clean' make target. +Practically, this means all c files that contain <command>static_init_subsystem;</command> calls need to be rebuilded. +</para> + +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/packagers.xml b/docs/docbook/devdoc/packagers.xml new file mode 100644 index 0000000000..fb47c7305c --- /dev/null +++ b/docs/docbook/devdoc/packagers.xml @@ -0,0 +1,40 @@ +<chapter id="Packaging"> +<chapterinfo> + <author> + <firstname>Jelmer</firstname><surname>Vernooij</surname> + </author> +</chapterinfo> + +<title>Notes to packagers</title> + +<sect1> +<title>Versioning</title> + +<para>Please, please update the version number in +<filename>source/include/version.h</filename> to include the versioning of your package. This makes it easier to distinguish standard samba builds +from custom-build samba builds (distributions often patch packages). For +example, a good version would be: </para> + +<para><programlisting> +Version 2.999+3.0.alpha21-5 for Debian +</programlisting></para> + +</sect1> + +<sect1> +<title>Modules</title> + +<para>Samba now has support for building parts of samba as plugins. This +makes it possible to, for example, put ldap or mysql support in a seperate +package, thus making it possible to have a normal samba package not +depending on ldap or mysql. To build as much parts of samba +as a plugin, run: </para> + +<para><programlisting> +./configure --with-shared-modules=rpc,vfs,auth,pdb,charset +</programlisting></para> + +</sect1> + + +</chapter> diff --git a/docs/docbook/devdoc/parsing.xml b/docs/docbook/devdoc/parsing.xml new file mode 100644 index 0000000000..8d929617f5 --- /dev/null +++ b/docs/docbook/devdoc/parsing.xml @@ -0,0 +1,239 @@ +<chapter id="parsing"> +<chapterinfo> + <author> + <firstname>Chris</firstname><surname>Hertel</surname> + </author> + <pubdate>November 1997</pubdate> +</chapterinfo> + +<title>The smb.conf file</title> + +<sect1> +<title>Lexical Analysis</title> + +<para> +Basically, the file is processed on a line by line basis. There are +four types of lines that are recognized by the lexical analyzer +(params.c): +</para> + +<orderedlist> +<listitem><para> +Blank lines - Lines containing only whitespace. +</para></listitem> +<listitem><para> +Comment lines - Lines beginning with either a semi-colon or a +pound sign (';' or '#'). +</para></listitem> +<listitem><para> +Section header lines - Lines beginning with an open square bracket ('['). +</para></listitem> +<listitem><para> +Parameter lines - Lines beginning with any other character. +(The default line type.) +</para></listitem> +</orderedlist> + +<para> +The first two are handled exclusively by the lexical analyzer, which +ignores them. The latter two line types are scanned for +</para> + +<orderedlist> +<listitem><para> + - Section names +</para></listitem> +<listitem><para> + - Parameter names +</para></listitem> +<listitem><para> + - Parameter values +</para></listitem> +</orderedlist> + +<para> +These are the only tokens passed to the parameter loader +(loadparm.c). Parameter names and values are divided from one +another by an equal sign: '='. +</para> + +<sect2> +<title>Handling of Whitespace</title> + +<para> +Whitespace is defined as all characters recognized by the isspace() +function (see ctype(3C)) except for the newline character ('\n') +The newline is excluded because it identifies the end of the line. +</para> + +<orderedlist> +<listitem><para> +The lexical analyzer scans past white space at the beginning of a line. +</para></listitem> + +<listitem><para> +Section and parameter names may contain internal white space. All +whitespace within a name is compressed to a single space character. +</para></listitem> + +<listitem><para> +Internal whitespace within a parameter value is kept verbatim with +the exception of carriage return characters ('\r'), all of which +are removed. +</para></listitem> + +<listitem><para> +Leading and trailing whitespace is removed from names and values. +</para></listitem> + +</orderedlist> + +</sect2> + +<sect2> +<title>Handling of Line Continuation</title> + +<para> +Long section header and parameter lines may be extended across +multiple lines by use of the backslash character ('\\'). Line +continuation is ignored for blank and comment lines. +</para> + +<para> +If the last (non-whitespace) character within a section header or on +a parameter line is a backslash, then the next line will be +(logically) concatonated with the current line by the lexical +analyzer. For example: +</para> + +<para><programlisting> + param name = parameter value string \ + with line continuation. +</programlisting></para> + +<para>Would be read as</para> + +<para><programlisting> + param name = parameter value string with line continuation. +</programlisting></para> + +<para> +Note that there are five spaces following the word 'string', +representing the one space between 'string' and '\\' in the top +line, plus the four preceeding the word 'with' in the second line. +(Yes, I'm counting the indentation.) +</para> + +<para> +Line continuation characters are ignored on blank lines and at the end +of comments. They are *only* recognized within section and parameter +lines. +</para> + +</sect2> + +<sect2> +<title>Line Continuation Quirks</title> + +<para>Note the following example:</para> + +<para><programlisting> + param name = parameter value string \ + \ + with line continuation. +</programlisting></para> + +<para> +The middle line is *not* parsed as a blank line because it is first +concatonated with the top line. The result is +</para> + +<para><programlisting> +param name = parameter value string with line continuation. +</programlisting></para> + +<para>The same is true for comment lines.</para> + +<para><programlisting> + param name = parameter value string \ + ; comment \ + with a comment. +</programlisting></para> + +<para>This becomes:</para> + +<para><programlisting> +param name = parameter value string ; comment with a comment. +</programlisting></para> + +<para> +On a section header line, the closing bracket (']') is considered a +terminating character, and the rest of the line is ignored. The lines +</para> + +<para><programlisting> + [ section name ] garbage \ + param name = value +</programlisting></para> + +<para>are read as</para> + +<para><programlisting> + [section name] + param name = value +</programlisting></para> + +</sect2> +</sect1> + +<sect1> +<title>Syntax</title> + +<para>The syntax of the smb.conf file is as follows:</para> + +<para><programlisting> + <file> :== { <section> } EOF + <section> :== <section header> { <parameter line> } + <section header> :== '[' NAME ']' + <parameter line> :== NAME '=' VALUE NL +</programlisting></para> + +<para>Basically, this means that</para> + +<orderedlist> +<listitem><para> + a file is made up of zero or more sections, and is terminated by + an EOF (we knew that). +</para></listitem> + +<listitem><para> + A section is made up of a section header followed by zero or more + parameter lines. +</para></listitem> + +<listitem><para> + A section header is identified by an opening bracket and + terminated by the closing bracket. The enclosed NAME identifies + the section. +</para></listitem> + +<listitem><para> + A parameter line is divided into a NAME and a VALUE. The *first* + equal sign on the line separates the NAME from the VALUE. The + VALUE is terminated by a newline character (NL = '\n'). +</para></listitem> + +</orderedlist> + +<sect2> +<title>About params.c</title> + +<para> +The parsing of the config file is a bit unusual if you are used to +lex, yacc, bison, etc. Both lexical analysis (scanning) and parsing +are performed by params.c. Values are loaded via callbacks to +loadparm.c. +</para> +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/printing.xml b/docs/docbook/devdoc/printing.xml new file mode 100644 index 0000000000..363b9fb6e5 --- /dev/null +++ b/docs/docbook/devdoc/printing.xml @@ -0,0 +1,393 @@ +<chapter id="printing"> +<chapterinfo> + <author> + <firstname>Gerald</firstname><surname>Carter</surname> + </author> + <pubdate>October 2002</pubdate> +</chapterinfo> + + +<title>Samba Printing Internals</title> + + +<sect1> +<title>Abstract</title> +<para> +The purpose of this document is to provide some insight into +Samba's printing functionality and also to describe the semantics +of certain features of Windows client printing. +</para> +</sect1> + + + +<sect1> +<title> +Printing Interface to Various Back ends +</title> + +<para> +Samba uses a table of function pointers to seven functions. The +function prototypes are defined in the <varname>printif</varname> structure declared +in <filename>printing.h</filename>. +</para> + +<itemizedlist> + <listitem><para>retrieve the contents of a print queue</para></listitem> + <listitem><para>pause the print queue</para></listitem> + <listitem><para>resume a paused print queue</para></listitem> + <listitem><para>delete a job from the queue</para></listitem> + <listitem><para>pause a job in the print queue</para></listitem> + <listitem><para>result a paused print job in the queue</para></listitem> + <listitem><para>submit a job to the print queue</para></listitem> +</itemizedlist> + +<para> +Currently there are only two printing back end implementations +defined. +</para> + +<itemizedlist> + <listitem><para>a generic set of functions for working with standard UNIX + printing subsystems</para></listitem> + + <listitem><para>a set of CUPS specific functions (this is only enabled if + the CUPS libraries were located at compile time).</para></listitem> +</itemizedlist> + +</sect1> + + + + +<sect1> +<title> +Print Queue TDB's +</title> + + +<para> +Samba provides periodic caching of the output from the "lpq command" +for performance reasons. This cache time is configurable in seconds. +Obviously the longer the cache time the less often smbd will be +required to exec a copy of lpq. However, the accuracy of the print +queue contents displayed to clients will be diminished as well. +</para> + +<para> +The list of currently opened print queue TDB's can be found +be examining the list of tdb_print_db structures ( see print_db_head +in printing.c ). A queue TDB is opened using the wrapper function +printing.c:get_print_db_byname(). The function ensures that smbd +does not open more than MAX_PRINT_DBS_OPEN in an effort to prevent +a large print server from exhausting all available file descriptors. +If the number of open queue TDB's exceeds the MAX_PRINT_DBS_OPEN +limit, smbd falls back to a most recently used algorithm for maintaining +a list of open TDB's. +</para> + +<para> +There are two ways in which a a print job can be entered into +a print queue's TDB. The first is to submit the job from a Windows +client which will insert the job information directly into the TDB. +The second method is to have the print job picked up by executing the +"lpq command". +</para> + +<para><programlisting> +/* included from printing.h */ +struct printjob { + pid_t pid; /* which process launched the job */ + int sysjob; /* the system (lp) job number */ + int fd; /* file descriptor of open file if open */ + time_t starttime; /* when the job started spooling */ + int status; /* the status of this job */ + size_t size; /* the size of the job so far */ + int page_count; /* then number of pages so far */ + BOOL spooled; /* has it been sent to the spooler yet? */ + BOOL smbjob; /* set if the job is a SMB job */ + fstring filename; /* the filename used to spool the file */ + fstring jobname; /* the job name given to us by the client */ + fstring user; /* the user who started the job */ + fstring queuename; /* service number of printer for this job */ + NT_DEVICEMODE *nt_devmode; +}; +</programlisting></para> + +<para> +The current manifestation of the printjob structure contains a field +for the UNIX job id returned from the "lpq command" and a Windows job +ID (32-bit bounded by PRINT_MAX_JOBID). When a print job is returned +by the "lpq command" that does not match an existing job in the queue's +TDB, a 32-bit job ID above the <*vance doesn't know what word is missing here*> is generating by adding UNIX_JOB_START to +the id reported by lpq. +</para> + +<para> +In order to match a 32-bit Windows jobid onto a 16-bit lanman print job +id, smbd uses an in memory TDB to match the former to a number appropriate +for old lanman clients. +</para> + +<para> +When updating a print queue, smbd will perform the following +steps ( refer to <filename>print.c:print_queue_update()</filename> ): +</para> + +<orderedlist> + <listitem><para>Check to see if another smbd is currently in + the process of updating the queue contents by checking the pid + stored in <constant>LOCK/<replaceable>printer_name</replaceable></constant>. + If so, then do not update the TDB.</para></listitem> + + <listitem><para>Lock the mutex entry in the TDB and store our own pid. + Check that this succeeded, else fail.</para></listitem> + + <listitem><para>Store the updated time stamp for the new cache + listing</para></listitem> + + <listitem><para>Retrieve the queue listing via "lpq command"</para></listitem> + + <listitem><para><programlisting> + foreach job in the queue + { + if the job is a UNIX job, create a new entry; + if the job has a Windows based jobid, then + { + Lookup the record by the jobid; + if the lookup failed, then + treat it as a UNIX job; + else + update the job status only + } + }</programlisting></para></listitem> + + <listitem><para>Delete any jobs in the TDB that are not + in the in the lpq listing</para></listitem> + + <listitem><para>Store the print queue status in the TDB</para></listitem> + + <listitem><para>update the cache time stamp again</para></listitem> + +</orderedlist> + +<para> +Note that it is the contents of this TDB that is returned to Windows +clients and not the actual listing from the "lpq command". +</para> + +<para> +The NT_DEVICEMODE stored as part of the printjob structure is used to +store a pointer to a non-default DeviceMode associated with the print +job. The pointer will be non-null when the client included a Device +Mode in the OpenPrinterEx() call and subsequently submitted a job for +printing on that same handle. If the client did not include a Device +Mode in the OpenPrinterEx() request, the nt_devmode field is NULL +and the job has the printer's device mode associated with it by default. +</para> + +<para> +Only non-default Device Mode are stored with print jobs in the print +queue TDB. Otherwise, the Device Mode is obtained from the printer +object when the client issues a GetJob(level == 2) request. +</para> + +</sect1> + + + + +<sect1> +<title> +ChangeID and Client Caching of Printer Information +</title> + +<para> +[To be filled in later] +</para> +</sect1> + + + +<sect1> +<title> +Windows NT/2K Printer Change Notify +</title> + +<para> +When working with Windows NT+ clients, it is possible for a +print server to use RPC to send asynchronous change notification +events to clients for certain printer and print job attributes. +This can be useful when the client needs to know that a new +job has been added to the queue for a given printer or that the +driver for a printer has been changed. Note that this is done +entirely orthogonal to cache updates based on a new ChangeID for +a printer object. +</para> + +<para> +The basic set of RPC's used to implement change notification are +</para> + +<itemizedlist> + <listitem><para>RemoteFindFirstPrinterChangeNotifyEx ( RFFPCN )</para></listitem> + <listitem><para>RemoteFindNextPrinterChangeNotifyEx ( RFNPCN )</para></listitem> + <listitem><para>FindClosePrinterChangeNotify( FCPCN )</para></listitem> + <listitem><para>ReplyOpenPrinter</para></listitem> + <listitem><para>ReplyClosePrinter</para></listitem> + <listitem><para>RouteRefreshPrinterChangeNotify ( RRPCN )</para></listitem> +</itemizedlist> + +<para> +One additional RPC is available to a server, but is never used by the +Windows spooler service: +</para> + +<itemizedlist> + <listitem><para>RouteReplyPrinter()</para></listitem> +</itemizedlist> + +<para> +The opnum for all of these RPC's are defined in include/rpc_spoolss.h +</para> + +<para> +Windows NT print servers use a bizarre method of sending print +notification event to clients. The process of registering a new change +notification handle is as follows. The 'C' is for client and the +'S' is for server. All error conditions have been eliminated. +</para> + +<para><programlisting> +C: Obtain handle to printer or to the printer + server via the standard OpenPrinterEx() call. +S: Respond with a valid handle to object + +C: Send a RFFPCN request with the previously obtained + handle with either (a) set of flags for change events + to monitor, or (b) a PRINTER_NOTIFY_OPTIONS structure + containing the event information to monitor. The windows + spooler has only been observed to use (b). +S: The <* another missing word*> opens a new TCP session to the client (thus requiring + all print clients to be CIFS servers as well) and sends + a ReplyOpenPrinter() request to the client. +C: The client responds with a printer handle that can be used to + send event notification messages. +S: The server replies success to the RFFPCN request. + +C: The windows spooler follows the RFFPCN with a RFNPCN + request to fetch the current values of all monitored + attributes. +S: The server replies with an array SPOOL_NOTIFY_INFO_DATA + structures (contained in a SPOOL_NOTIFY_INFO structure). + +C: If the change notification handle is ever released by the + client via a FCPCN request, the server sends a ReplyClosePrinter() + request back to the client first. However a request of this + nature from the client is often an indication that the previous + notification event was not marshalled correctly by the server + or a piece of data was wrong. +S: The server closes the internal change notification handle + (POLICY_HND) and does not send any further change notification + events to the client for that printer or job. +</programlisting></para> + +<para> +The current list of notification events supported by Samba can be +found by examining the internal tables in srv_spoolss_nt.c +</para> + +<itemizedlist> + <listitem><para>printer_notify_table[]</para></listitem> + <listitem><para>job_notify_table[]</para></listitem> +</itemizedlist> + +<para> +When an event occurs that could be monitored, smbd sends a message +to itself about the change. The list of events to be transmitted +are queued by the smbd process sending the message to prevent an +overload of TDB usage and the internal message is sent during smbd's +idle loop (refer to printing/notify.c and the functions +send_spoolss_notify2_msg() and print_notify_send_messages() ). +</para> + +<para> +The decision of whether or not the change is to be sent to connected +clients is made by the routine which actually sends the notification. +( refer to srv_spoolss_nt.c:recieve_notify2_message() ). +</para> + +<para> +Because it possible to receive a listing of multiple changes for +multiple printers, the notification events must be split into +categories by the printer name. This makes it possible to group +multiple change events to be sent in a single RPC according to the +printer handle obtained via a ReplyOpenPrinter(). +</para> + +<para> +The actual change notification is performed using the RRPCN request +RPC. This packet contains +</para> + + +<itemizedlist> + +<listitem><para>the printer handle registered with the +client's spooler on which the change occurred</para></listitem> + +<listitem><para>The change_low value which was sent as part +of the last RFNPCN request from the client</para></listitem> + +<listitem><para>The SPOOL_NOTIFY_INFO container with the event +information</para></listitem> + +</itemizedlist> + +<para> +A <varname>SPOOL_NOTIFY_INFO</varname> contains: +</para> + +<itemizedlist> + +<listitem><para>the version and flags field are predefined +and should not be changed</para></listitem> + +<listitem><para>The count field is the number of entries +in the SPOOL_NOTIFY_INFO_DATA array</para></listitem> + +</itemizedlist> + +<para> +The <varname>SPOOL_NOTIFY_INFO_DATA</varname> entries contain: +</para> + +<itemizedlist> + +<listitem><para>The type defines whether or not this event +is for a printer or a print job</para></listitem> + +<listitem><para>The field is the flag identifying the event</para></listitem> + +<listitem><para>the notify_data union contains the new valuie of the +attribute</para></listitem> + +<listitem><para>The enc_type defines the size of the structure for marshalling +and unmarshalling</para></listitem> + +<listitem><para>(a) the id must be 0 for a printer event on a printer handle. +(b) the id must be the job id for an event on a printer job +(c) the id must be the matching number of the printer index used +in the response packet to the RFNPCN when using a print server +handle for notification. Samba currently uses the snum of +the printer for this which can break if the list of services +has been modified since the notification handle was registered.</para></listitem> + +<listitem><para>The size is either (a) the string length in UNICODE for strings, +(b) the size in bytes of the security descriptor, or (c) 0 for +data values.</para></listitem> + +</itemizedlist> + +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/rpc_plugin.xml b/docs/docbook/devdoc/rpc_plugin.xml new file mode 100644 index 0000000000..c83742a247 --- /dev/null +++ b/docs/docbook/devdoc/rpc_plugin.xml @@ -0,0 +1,83 @@ +<chapter id="rpc-plugin"> +<chapterinfo> + <author> + <firstname>Anthony</firstname><surname>Liguori</surname> + <affiliation> + <orgname>IBM</orgname> + <address><email>aliguor@us.ibm.com</email></address> + </affiliation> + </author> + <author> + <firstname>Jelmer</firstname><surname>Vernooij</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>jelmer@samba.org</email></address> + </affiliation> + </author> + <pubdate>January 2003</pubdate> +</chapterinfo> + +<title>RPC Pluggable Modules</title> + +<sect1> +<title>About</title> + +<para> +This document describes how to make use the new RPC Pluggable Modules features +of Samba 3.0. This architecture was added to increase the maintainability of +Samba allowing RPC Pipes to be worked on separately from the main CVS branch. +The RPM architecture will also allow third-party vendors to add functionality +to Samba through plug-ins. +</para> + +</sect1> + +<sect1> +<title>General Overview</title> + +<para> +When an RPC call is sent to smbd, smbd tries to load a shared library by the +name <filename>librpc_<pipename>.so</filename> to handle the call if +it doesn't know how to handle the call internally. For instance, LSA calls +are handled by <filename>librpc_lsass.so</filename>.. +These shared libraries should be located in the <filename><sambaroot>/lib/rpc</filename>. smbd then attempts to call the init_module function within +the shared library. Check the chapter on modules for more information. +</para> + +<para> +In the init_module function, the library should call +rpc_pipe_register_commands(). This function takes the following arguments: +</para> + +<para><programlisting> +int rpc_pipe_register_commands(const char *clnt, const char *srv, + const struct api_struct *cmds, int size); +</programlisting></para> + +<variablelist> + +<varlistentry><term>clnt</term> +<listitem><para>the Client name of the named pipe</para></listitem> +</varlistentry> + +<varlistentry><term>srv</term> +<listitem><para>the Server name of the named pipe</para></listitem> +</varlistentry> + +<varlistentry><term>cmds</term> +<listitem><para>a list of api_structs that map RPC ordinal numbers to function calls</para></listitem> +</varlistentry> + +<varlistentry><term>size</term> +<listitem><para>the number of api_structs contained in cmds</para></listitem> +</varlistentry> + +</variablelist> + +<para> +See rpc_server/srv_reg.c and rpc_server/srv_reg_nt.c for a small example of +how to use this library. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/sam.xml b/docs/docbook/devdoc/sam.xml new file mode 100644 index 0000000000..84c17d65e2 --- /dev/null +++ b/docs/docbook/devdoc/sam.xml @@ -0,0 +1,357 @@ +<chapter id="sam"> + +<chapterinfo> + <author> + <firstname>Andrew</firstname><surname>Bartlett</surname> + </author> + <pubdate>1 October 2002</pubdate> +</chapterinfo> + +<title>The Upcoming SAM System</title> + +<sect1> +<title>Security in the 'new SAM'</title> + +<para>One of the biggest problems with passdb is it's implementation of +'security'. Access control is on a 'are you root at the moment' basis, +and it has no concept of NT ACLs. Things like ldapsam had to add +'magic' 'are you root' checks.</para> + +<para>We took this very seriously when we started work, and the new structure +is designed with this in mind, from the ground up. Each call to the SAM +has a NT_TOKEN and (if relevant) an 'access desired'. This is either +provided as a parameter, or implicitly supplied by the object being +accessed.</para> + +<para> +For example, when you call +</para> + +<programlisting> +NTSTATUS sam_get_account_by_name(const SAM_CONTEXT *context, const +NT_USER_TOKEN *access_token, uint32 access_desired, const char *domain, +const char *name, SAM_ACCOUNT_HANDLE **account) +</programlisting> + +<para> +The context can be NULL (and is used to allow import/export by setting +up 2 contexts, and allowing calls on both simultaneously) +</para> + +<para> +The access token *must* be specified. Normally the user's token out of +current_user, this can also be a global 'system' context. +</para> + +<para> +The access desired is as per the ACL, for passing to the seaccess stuff. +</para> + +<para> +The domain/username are standard. Even if we only have one domain, +keeping this ensures that we don't get 'unqualified' usernames (same +problem as we had with unqualified SIDs). +</para> + +<para> +We return a 'handle'. This is opaque to the rest of Samba, but is +operated on by get/set routines, all of which return NTSTATUS. +</para> + +<para> +The access checking is done by the SAM module. The reason it is not +done 'above' the interface is to ensure a 'choke point'. I put a lot of +effort into the auth subsystem to ensure we never 'accidentally' forgot +to check for null passwords, missed a restriction etc. I intend the SAM +to be written with the same caution. +</para> + +<para> +The reason the access checking is not handled by the interface itself is +due to the different implementations it make take on. For example, on +ADS, you cannot set a password over a non-SSL connection. Other +backends may have similar requirements - we need to leave this policy up +to the modules. They will naturally have access to 'helper' procedures +and good examples to avoid mishaps. +</para> + +<para> +(Furthermore, some backends my actually chose to push the whole ACL +issue to the remote server, and - assuming ldap for this example - bind +as the user directly) +</para> + +<para> +Each returned handle has an internal 'access permitted', which allows +the 'get' and 'set' routines to return 'ACCESS_DENIED' for things that +were not able to be retrieved from the backend. This removes the need +to specify the NT_TOKEN on every operation, and allows for 'object not +present' to be easily distinguished from 'access denied'. +</para> + +<para> +When you 'set' an object (calling sam_update_account) the internal +details are again used. Each change that has been made to the object +has been flagged, so as to avoid race conditions (on unmodified +components) and to avoid violating any extra ACL requirements on the +actual data store (like the LDAP server). +</para> + +<para> +Finally, we have generic get_sec_desc() and set_sec_desc() routines to +allow external ACL manipulation. These do lookups based on SID. +</para> + +</sect1> + +<sect1> +<title>Standalone from UNIX</title> + +<para> +One of the primary tenants of the 'new SAM' is that it would not attempt +to deal with 'what unix id for that'. This would be left to the 'SMS' +(Sid Mapping System') or SID farm, and probably administered via +winbind. We have had constructive discussion on how 'basic' unix +accounts like 'root' would be handled, and we think this can work. +Accounts not preexisting in unix would be served up via winbind. +</para> + +<para> +This is an *optional* part, and my preferred end-game. We have a fare +way to go before things like winbind up to it however. +</para> + +</sect1> + +<sect1> +<title>Handles and Races in the new SAM</title> + +<para> +One of the things that the 'new SAM' work has tried to face is both +compatibility with existing code, and a closer alignment to the SAMR +interface. I consider SAMR to be a 'primary customer' to the this work, +because if we get alignment with that wrong, things get more, rather +than less complex. Also, most other parts of Samba are much more +flexible with what they can allow. +</para> + +<para> +In any case, that was a decision taken as to how the general design +would progress. BTW, my understanding of SAMR may be completely flawed. +</para> + +<para> +One of the most race-prone areas of the new code is the conflicting +update problem. We have taken two approaches: +</para> + +<itemizedlist> +<listitem> +<para>'Not conflicting' conflicts. Due to the way usrmgr operates, it will +open a user, display all the properties and *save* them all, even if you +don't change any. +</para> + +<para> +For this, see what I've done in rpc_server/srv_samr_util.c. I intend +to take this one step further, and operate on the 'handle' that the +values were read from. This should mean that we only update things that +have *really* changed. +</para> +</listitem> + +<listitem> +<para> +'conflicting' updates: Currently we don't deal with this (in passdb +or the new sam stuff), but the design is sufficiently flexible to 'deny' +a second update. I don't foresee locking records however. +</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1> +<title>Layers</title> + +<sect2> +<title>Application</title> + +<para> +This is where smbd, samtest and whatever end-user replacement we have +for pdbedit sits. They use only the SAM interface, and do not get +'special knowledge' of what is below them. +</para> +</sect2> +<sect2> +<title>SAM Interface</title> + +<para> +This level 'owns' the various handle structures, the get/set routines on +those structures and provides the public interface. The application +layer may initialize a 'context' to be passed to all interface routines, +else a default, self-initialising context will be supplied. This layser +finds the appropriate backend module for the task, and tries very hard +not to need to much 'knowledge'. It should just provide the required +abstraction to the modules below, and arrange for their initial loading. +</para> + +<para> +We could possibly add ACL checking at this layer, to avoid discrepancies +in implementation modules. +</para> + +</sect2> + +<sect2> +<title>SAM Modules</title> + +<para> +These do not communicate with the application directly, only by setting +values in the handles, and receiving requests from the interface. These +modules are responsible for translating values from the handle's +.private into (say) an LDAP modification list. The module is expected +to 'know' things like it's own domain SID, domain name, and any other +state attached to the SAM. Simpler modules may call back to some helper +routine. +</para> + +</sect2> +</sect1> + +<sect1> +<title>SAM Modules</title> + +<sect2> +<title>Special Module: sam_passdb</title> + +<para> +In order for there to be a smooth transition, kai is writing a module +that reads existing passdb backends, and translates them into SAM +replies. (Also pulling data from the account policy DB etc). We also +intend to write a module that does the reverse - gives the SAM a passdb +interface. +</para> +</sect2> + +<sect2> +<title>sam_ads</title> +<para> +This is the first of the SAM modules to be committed to the tree - +mainly because I needed to coordinate work with metze (who authored most +of it). This module aims to use Samba's libads code to provide an +Active Directory LDAP client, suitable for use on a mixed-mode DC. +While it is currently being tested against Win2k servers (with a +password in the smb.conf file) it is expected to eventually use a +(possibly modified) OpenLDAP server. We hope that this will assist in +the construction of an Samba AD DC. +</para> + +<para> +We also intend to construct a Samba 2.2/3.0 compatible ldap module, +again using libads code. +</para> +</sect2> +</sect1> + +<sect1> +<title>Memory Management</title> + +<para> +The 'new SAM' development effort also concerned itself with getting a +sane implementation of memory management. It was decided that we would +be (as much as possible) talloc based, using an 'internal talloc +context' on many objects. That is, the creation of an object would +initiate it's own internal talloc context, and this would be used for +all operations on that object. Much of this is already implemented in +passdb. Also, like passdb, it will be possible to specify that some +object actually be created on a specified context. +</para> + +<para> +Memory management is important here because the APIs in the 'new SAM' do +not use 'pdb_init()' or an equivalent. They always allocate new +objects. Enumeration's are slightly different, and occur on a supplied +context that 'owns' the entire list, rather than per-element. (the +enumeration functions return an array of all elements - not full handles +just basic (and public) info) Likewise for things that fill in a char +**. +</para> + +<para>For example:</para> + +<para><programlisting> +NTSTATUS sam_lookup_sid(const SAM_CONTEXT *context, const NT_USER_TOKEN +*access_token, TALLOC_CTX *mem_ctx, const DOM_SID *sid, char **name, +uint32 *type) +</programlisting></para> + +<para>Takes a context to allocate the 'name' on, while:</para> + +<para><programlisting> +NTSTATUS sam_get_account_by_sid(const SAM_CONTEXT *context, const +NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID +*accountsid, SAM_ACCOUNT_HANDLE **account) +</programlisting></para> + +<para>Allocates a handle and stores the allocation context on that handle.</para> + +<para>I think that the following:</para> + +<para><programlisting> +NTSTATUS sam_enum_accounts(const SAM_CONTEXT *context, const +NT_USER_TOKEN *access_token, const DOM_SID *domainsid, uint16 acct_ctrl, +int32 *account_count, SAM_ACCOUNT_ENUM **accounts) +</programlisting></para> + +</sect1> + +<sect1> +<title>Testing</title> + +<para> +Testing is vital in any piece of software, and Samba is certainly no +exception. In designing this new subsystem, we have taken care to ensure +it is easily tested, independent of outside protocols. +</para> + +<para> +To this end, Jelmer has constructed 'samtest'. +</para> + +<para> +This utility (see torture/samtest.c) is structured like rpcclient, but +instead operates on the SAM subsystem. It creates a 'custom' SAM +context, that may be distinct from the default values used by the rest +of the system, and can load a separate configuration file. +</para> + +<para> +A small number of commands are currently implemented, but these have +already proved vital in testing. I expect SAM module authors will find +it particularly valuable. +</para> + +<para>Example useage:</para> + +<para><prompt>$</prompt> <command>bin/samtest</command></para> + +<para><programlisting> +> context ads:ldap://192.168.1.96 +</programlisting> +(this loads a new context, using the new ADS module. The parameter is +the 'location' of the ldap server) +</para> + +<para><programlisting> +> lookup_name DOMAIN abartlet +</programlisting> +(returns a sid). +</para> + +<para> +Because the 'new SAM' is NT ACL based, there will be a command to +specify an arbitrary NT ACL, but for now it uses 'system' by default. +</para> +</sect1> +</chapter> diff --git a/docs/docbook/devdoc/unix-smb.xml b/docs/docbook/devdoc/unix-smb.xml new file mode 100644 index 0000000000..d6a658089c --- /dev/null +++ b/docs/docbook/devdoc/unix-smb.xml @@ -0,0 +1,316 @@ +<chapter id="unix-smb"> +<chapterinfo> + <author> + <firstname>Andrew</firstname><surname>Tridgell</surname> + </author> + <pubdate>April 1995</pubdate> +</chapterinfo> + +<title>NetBIOS in a Unix World</title> + +<sect1> +<title>Introduction</title> +<para> +This is a short document that describes some of the issues that +confront a SMB implementation on unix, and how Samba copes with +them. They may help people who are looking at unix<->PC +interoperability. +</para> + +<para> +It was written to help out a person who was writing a paper on unix to +PC connectivity. +</para> + +</sect1> + +<sect1> +<title>Usernames</title> +<para> +The SMB protocol has only a loose username concept. Early SMB +protocols (such as CORE and COREPLUS) have no username concept at +all. Even in later protocols clients often attempt operations +(particularly printer operations) without first validating a username +on the server. +</para> + +<para> +Unix security is based around username/password pairs. A unix box +should not allow clients to do any substantive operation without some +sort of validation. +</para> + +<para> +The problem mostly manifests itself when the unix server is in "share +level" security mode. This is the default mode as the alternative +"user level" security mode usually forces a client to connect to the +server as the same user for each connected share, which is +inconvenient in many sites. +</para> + +<para> +In "share level" security the client normally gives a username in the +"session setup" protocol, but does not supply an accompanying +password. The client then connects to resources using the "tree +connect" protocol, and supplies a password. The problem is that the +user on the PC types the username and the password in different +contexts, unaware that they need to go together to give access to the +server. The username is normally the one the user typed in when they +"logged onto" the PC (this assumes Windows for Workgroups). The +password is the one they chose when connecting to the disk or printer. +</para> + +<para> +The user often chooses a totally different username for their login as +for the drive connection. Often they also want to access different +drives as different usernames. The unix server needs some way of +divining the correct username to combine with each password. +</para> + +<para> +Samba tries to avoid this problem using several methods. These succeed +in the vast majority of cases. The methods include username maps, the +service%user syntax, the saving of session setup usernames for later +validation and the derivation of the username from the service name +(either directly or via the user= option). +</para> + +</sect1> + +<sect1> +<title>File Ownership</title> + +<para> +The commonly used SMB protocols have no way of saying "you can't do +that because you don't own the file". They have, in fact, no concept +of file ownership at all. +</para> + +<para> +This brings up all sorts of interesting problems. For example, when +you copy a file to a unix drive, and the file is world writeable but +owned by another user the file will transfer correctly but will +receive the wrong date. This is because the utime() call under unix +only succeeds for the owner of the file, or root, even if the file is +world writeable. For security reasons Samba does all file operations +as the validated user, not root, so the utime() fails. This can stuff +up shared development diectories as programs like "make" will not get +file time comparisons right. +</para> + +<para> +There are several possible solutions to this problem, including +username mapping, and forcing a specific username for particular +shares. +</para> + +</sect1> + +<sect1> +<title>Passwords</title> + +<para> +Many SMB clients uppercase passwords before sending them. I have no +idea why they do this. Interestingly WfWg uppercases the password only +if the server is running a protocol greater than COREPLUS, so +obviously it isn't just the data entry routines that are to blame. +</para> + +<para> +Unix passwords are case sensitive. So if users use mixed case +passwords they are in trouble. +</para> + +<para> +Samba can try to cope with this by either using the "password level" +option which causes Samba to try the offered password with up to the +specified number of case changes, or by using the "password server" +option which allows Samba to do its validation via another machine +(typically a WinNT server). +</para> + +<para> +Samba supports the password encryption method used by SMB +clients. Note that the use of password encryption in Microsoft +networking leads to password hashes that are "plain text equivalent". +This means that it is *VERY* important to ensure that the Samba +smbpasswd file containing these password hashes is only readable +by the root user. See the documentation ENCRYPTION.txt for more +details. +</para> + +</sect1> + +<sect1> +<title>Locking</title> +<para> +Since samba 2.2, samba supports other types of locking as well. This +section is outdated. +</para> + +<para> +The locking calls available under a DOS/Windows environment are much +richer than those available in unix. This means a unix server (like +Samba) choosing to use the standard fcntl() based unix locking calls +to implement SMB locking has to improvise a bit. +</para> + +<para> +One major problem is that dos locks can be in a 32 bit (unsigned) +range. Unix locking calls are 32 bits, but are signed, giving only a 31 +bit range. Unfortunately OLE2 clients use the top bit to select a +locking range used for OLE semaphores. +</para> + +<para> +To work around this problem Samba compresses the 32 bit range into 31 +bits by appropriate bit shifting. This seems to work but is not +ideal. In a future version a separate SMB lockd may be added to cope +with the problem. +</para> + +<para> +It also doesn't help that many unix lockd daemons are very buggy and +crash at the slightest provocation. They normally go mostly unused in +a unix environment because few unix programs use byte range +locking. The stress of huge numbers of lock requests from dos/windows +clients can kill the daemon on some systems. +</para> + +<para> +The second major problem is the "opportunistic locking" requested by +some clients. If a client requests opportunistic locking then it is +asking the server to notify it if anyone else tries to do something on +the same file, at which time the client will say if it is willing to +give up its lock. Unix has no simple way of implementing +opportunistic locking, and currently Samba has no support for it. +</para> + +</sect1> + +<sect1> +<title>Deny Modes</title> + +<para> +When a SMB client opens a file it asks for a particular "deny mode" to +be placed on the file. These modes (DENY_NONE, DENY_READ, DENY_WRITE, +DENY_ALL, DENY_FCB and DENY_DOS) specify what actions should be +allowed by anyone else who tries to use the file at the same time. If +DENY_READ is placed on the file, for example, then any attempt to open +the file for reading should fail. +</para> + +<para> +Unix has no equivalent notion. To implement this Samba uses either lock +files based on the files inode and placed in a separate lock +directory or a shared memory implementation. The lock file method +is clumsy and consumes processing and file resources, +the shared memory implementation is vastly prefered and is turned on +by default for those systems that support it. +</para> + +</sect1> + +<sect1> +<title>Trapdoor UIDs</title> +<para> +A SMB session can run with several uids on the one socket. This +happens when a user connects to two shares with different +usernames. To cope with this the unix server needs to switch uids +within the one process. On some unixes (such as SCO) this is not +possible. This means that on those unixes the client is restricted to +a single uid. +</para> + +<para> +Note that you can also get the "trapdoor uid" message for other +reasons. Please see the FAQ for details. +</para> + +</sect1> + +<sect1> +<title>Port numbers</title> +<para> +There is a convention that clients on sockets use high "unprivilaged" +port numbers (>1000) and connect to servers on low "privilaged" port +numbers. This is enforced in Unix as non-root users can't open a +socket for listening on port numbers less than 1000. +</para> + +<para> +Most PC based SMB clients (such as WfWg and WinNT) don't follow this +convention completely. The main culprit is the netbios nameserving on +udp port 137. Name query requests come from a source port of 137. This +is a problem when you combine it with the common firewalling technique +of not allowing incoming packets on low port numbers. This means that +these clients can't query a netbios nameserver on the other side of a +low port based firewall. +</para> + +<para> +The problem is more severe with netbios node status queries. I've +found that WfWg, Win95 and WinNT3.5 all respond to netbios node status +queries on port 137 no matter what the source port was in the +request. This works between machines that are both using port 137, but +it means it's not possible for a unix user to do a node status request +to any of these OSes unless they are running as root. The answer comes +back, but it goes to port 137 which the unix user can't listen +on. Interestingly WinNT3.1 got this right - it sends node status +responses back to the source port in the request. +</para> + +</sect1> + +<sect1> +<title>Protocol Complexity</title> +<para> +There are many "protocol levels" in the SMB protocol. It seems that +each time new functionality was added to a Microsoft operating system, +they added the equivalent functions in a new protocol level of the SMB +protocol to "externalise" the new capabilities. +</para> + +<para> +This means the protocol is very "rich", offering many ways of doing +each file operation. This means SMB servers need to be complex and +large. It also means it is very difficult to make them bug free. It is +not just Samba that suffers from this problem, other servers such as +WinNT don't support every variation of every call and it has almost +certainly been a headache for MS developers to support the myriad of +SMB calls that are available. +</para> + +<para> +There are about 65 "top level" operations in the SMB protocol (things +like SMBread and SMBwrite). Some of these include hundreds of +sub-functions (SMBtrans has at least 120 sub-functions, like +DosPrintQAdd and NetSessionEnum). All of them take several options +that can change the way they work. Many take dozens of possible +"information levels" that change the structures that need to be +returned. Samba supports all but 2 of the "top level" functions. It +supports only 8 (so far) of the SMBtrans sub-functions. Even NT +doesn't support them all. +</para> + +<para> +Samba currently supports up to the "NT LM 0.12" protocol, which is the +one preferred by Win95 and WinNT3.5. Luckily this protocol level has a +"capabilities" field which specifies which super-duper new-fangled +options the server suports. This helps to make the implementation of +this protocol level much easier. +</para> + +<para> +There is also a problem with the SMB specications. SMB is a X/Open +spec, but the X/Open book is far from ideal, and fails to cover many +important issues, leaving much to the imagination. Microsoft recently +renamed the SMB protocol CIFS (Common Internet File System) and have +published new specifications. These are far superior to the old +X/Open documents but there are still undocumented calls and features. +This specification is actively being worked on by a CIFS developers +mailing list hosted by Microsft. +</para> +</sect1> +</chapter> + diff --git a/docs/docbook/devdoc/wins.xml b/docs/docbook/devdoc/wins.xml new file mode 100644 index 0000000000..53410316c5 --- /dev/null +++ b/docs/docbook/devdoc/wins.xml @@ -0,0 +1,79 @@ +<chapter id="wins"> +<chapterinfo> + <author> + <firstname>Gerald</firstname><surname>Carter</surname> + </author> + <pubdate>October 2002</pubdate> +</chapterinfo> + + +<title>Samba WINS Internals</title> + + +<sect1> +<title>WINS Failover</title> + + +<para> +The current Samba codebase possesses the capability to use groups of WINS +servers that share a common namespace for NetBIOS name registration and +resolution. The formal parameter syntax is +</para> + +<para><programlisting> + WINS_SERVER_PARAM = SERVER [ SEPARATOR SERVER_LIST ] + WINS_SERVER_PARAM = "wins server" + SERVER = ADDR[:TAG] + ADDR = ip_addr | fqdn + TAG = string + SEPARATOR = comma | \s+ + SERVER_LIST = SERVER [ SEPARATOR SERVER_LIST ] +</programlisting></para> + +<para> +A simple example of a valid wins server setting is +</para> + +<para><programlisting> +[global] + wins server = 192.168.1.2 192.168.1.3 +</programlisting></para> + +<para> +In the event that no TAG is defined in for a SERVER in the list, smbd assigns a default +TAG of "*". A TAG is used to group servers of a shared NetBIOS namespace together. Upon +startup, nmbd will attempt to register the netbios name value with one server in each +tagged group. +</para> + +<para> +An example using tags to group WINS servers together is show here. Note that the use of +interface names in the tags is only by convention and is not a technical requirement. +</para> + + +<para><programlisting> +[global] + wins server = 192.168.1.2:eth0 192.168.1.3:eth0 192.168.2.2:eth1 +</programlisting></para> + +<para> +Using this configuration, nmbd would attempt to register the server's NetBIOS name +with one WINS server in each group. Because the "eth0" group has two servers, the +second server would only be used when a registration (or resolution) request to +the first server in that group timed out. +</para> + +<para> +NetBIOS name resolution follows a similar pattern as name registration. When resolving +a NetBIOS name via WINS, smbd and other Samba programs will attempt to query a single WINS +server in a tagged group until either a positive response is obtained at least once or +until a server from every tagged group has responded negatively to the name query request. +If a timeout occurs when querying a specific WINS server, that server is marked as down to +prevent further timeouts and the next server in the WINS group is contacted. Once marked as +dead, Samba will not attempt to contact that server for name registration/resolution queries +for a period of 10 minutes. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/faq/clientapp.xml b/docs/docbook/faq/clientapp.xml new file mode 100644 index 0000000000..3d44dd44c0 --- /dev/null +++ b/docs/docbook/faq/clientapp.xml @@ -0,0 +1,101 @@ +<chapter id="FAQ-ClientApp"> +<title>Specific client application problems</title> + +<sect1> +<title>MS Office Setup reports "Cannot change properties of '\\MSOFFICE\\SETUP.INI'"</title> +<para> +When installing MS Office on a Samba drive for which you have admin +user permissions, ie. admin users = username, you will find the +setup program unable to complete the installation. +</para> + +<para> +To get around this problem, do the installation without admin user +permissions The problem is that MS Office Setup checks that a file is +rdonly by trying to open it for writing. +</para> + +<para> +Admin users can always open a file for writing, as they run as root. +You just have to install as a non-admin user and then use "chown -R" +to fix the owner. +</para> + +</sect1> + +<sect1> +<title>How to use a Samba share as an administrative share for MS Office, etc.</title> + +<para> +Microsoft Office products can be installed as an administrative installation +from which the application can either be run off the administratively installed +product that resides on a shared resource, or from which that product can be +installed onto workstation clients. +</para> + +<para> +The general mechanism for implementing an adminstrative installation involves +running <command>X:\setup /A</command>, where X is the drive letter of either CDROM or floppy. +</para> + +<para> +This installation process will NOT install the product for use per se, but +rather results in unpacking of the compressed distribution files into a target +shared folder. For this process you need write privilidge to the share and it +is desirable to enable file locking and share mode operation during this +process. +</para> + +<para> +Subsequent installation of MS Office from this share will FAIL unless certain +precautions are taken. This failure will be caused by share mode operation +which will prevent the MS Office installation process from re-opening various +dynamic link library files and will cause sporadic file not found problems. +</para> + +<itemizedlist> +<listitem><para> +As soon as the administrative installation (unpacking) has completed +set the following parameters on the share containing it: +</para> + +<para><programlisting> +[MSOP95] + path = /where_you_put_it + comment = Your comment + volume = "The_CD_ROM_Label" + read only = yes + available = yes + share modes = no + locking = no + browseable = yes + public = yes +</programlisting></para> + +</listitem> + +<listitem> +<para>Now you are ready to run the setup program from the Microsoft Windows +workstation as follows: <command>\\"Server_Name"\MSOP95\msoffice\setup</command> +</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1> +<title>Microsoft Access database opening errors</title> + +<para> +Here are some notes on running MS-Access on a Samba drive from <ulink url="stefank@esi.com.au">Stefan Kjellberg</ulink> +</para> + +<para><simplelist> +<member>Opening a database in 'exclusive' mode does NOT work. Samba ignores r/w/share modes on file open.</member> +<member>Make sure that you open the database as 'shared' and to 'lock modified records'</member> +<member>Of course locking must be enabled for the particular share (smb.conf)</member> +</simplelist> +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/faq/config.xml b/docs/docbook/faq/config.xml new file mode 100644 index 0000000000..2c17c86c4e --- /dev/null +++ b/docs/docbook/faq/config.xml @@ -0,0 +1,37 @@ +<chapter id="FAQ-Config"> +<title>Configuration problems</title> + +<sect1> +<title>I have set 'force user' and samba still makes 'root' the owner of all the files I touch!</title> +<para> +When you have a user in 'admin users', samba will always do file operations for +this user as 'root', even if 'force user' has been set. +</para> +</sect1> + +<sect1> +<title>I have just installed samba and I'm trying to log in from Windows, but samba refuses all logins!</title> + +<para> +Newer windows clients(NT4, 2000, XP) send encrypted passwords. Samba can't compare these +passwords to the unix password database, so it needs it's own user database. You can +add users to this database using "smbpasswd -a user-name". +</para> + +<para> +See also the "User database" chapter of the samba HOWTO Collection. +</para> +</sect1> + +<sect1> +<title>How can I make samba use netbios scope ID's</title> + +<para>By default Samba uses a blank scope ID. This means +all your windows boxes must also have a blank scope ID. +If you really want to use a non-blank scope ID then you will +need to use the 'netbios scope' smb.conf option. +All your PCs will need to have the same setting for +this to work. Scope ID's are not recommended.</para> +</sect1> + +</chapter> diff --git a/docs/docbook/faq/errors.xml b/docs/docbook/faq/errors.xml new file mode 100644 index 0000000000..97619ce704 --- /dev/null +++ b/docs/docbook/faq/errors.xml @@ -0,0 +1,176 @@ +<chapter id="FAQ-errors"> + +<title>Common errors</title> + +<sect1> +<title>Not listening for calling name</title> + +<para> +<programlisting> +Session request failed (131,129) with myname=HOBBES destname=CALVIN +Not listening for calling name +</programlisting> +</para> + +<para> +If you get this when talking to a Samba box then it means that your +global "hosts allow" or "hosts deny" settings are causing the Samba +server to refuse the connection. +</para> + +<para> +Look carefully at your "hosts allow" and "hosts deny" lines in the +global section of smb.conf. +</para> + +<para> +It can also be a problem with reverse DNS lookups not functioning +correctly, leading to the remote host identity not being able to +be confirmed, but that is less likely. +</para> +</sect1> + +<sect1> +<title>System Error 1240</title> + +<para> +System error 1240 means that the client is refusing to talk +to a non-encrypting server. Microsoft changed WinNT in service +pack 3 to refuse to connect to servers that do not support +SMB password encryption. +</para> + +<para>There are two main solutions: +<simplelist> +<member>enable SMB password encryption in Samba. See the encryption part of +the samba HOWTO Collection</member> + +<member>disable this new behaviour in NT. See the section about +Windows NT in the chapter "Portability" of the samba HOWTO collection +</member> +</simplelist> +</para> +</sect1> + +<sect1> +<title>smbclient ignores -N !</title> + +<para> +<quote>When getting the list of shares available on a host using the command +<command>smbclient -N -L</command> +the program always prompts for the password if the server is a Samba server. +It also ignores the "-N" argument when querying some (but not all) of our +NT servers. +</quote> +</para> +<para> +No, it does not ignore -N, it is just that your server rejected the +null password in the connection, so smbclient prompts for a password +to try again. +</para> + +<para> +To get the behaviour that you probably want use <command>smbclient -L host -U%</command> +</para> + +<para> +This will set both the username and password to null, which is +an anonymous login for SMB. Using -N would only set the password +to null, and this is not accepted as an anonymous login for most +SMB servers. +</para> + +</sect1> + +<sect1> +<title>The data on the CD-Drive I've shared seems to be corrupted!</title> + +<para> +Some OSes (notably Linux) default to auto detection of file type on +cdroms and do cr/lf translation. This is a very bad idea when use with +Samba. It causes all sorts of stuff ups. +</para> + +<para> +To overcome this problem use conv=binary when mounting the cdrom +before exporting it with Samba. +</para> + +</sect1> + +<sect1> +<title>Why can users access home directories of other users?</title> + +<para> +<quote> +We are unable to keep individual users from mapping to any other user's +home directory once they have supplied a valid password! They only need +to enter their own password. I have not found *any* method that I can +use to configure samba to enforce that only a user may map their own +home directory. +</quote> +</para> + +<para><quote> +User xyzzy can map his home directory. Once mapped user xyzzy can also map +*anyone* elses home directory! +</quote></para> + +<para> +This is not a security flaw, it is by design. Samba allows +users to have *exactly* the same access to the UNIX filesystem +as they would if they were logged onto the UNIX box, except +that it only allows such views onto the file system as are +allowed by the defined shares. +</para> + +<para> +This means that if your UNIX home directories are set up +such that one user can happily cd into another users +directory and do an ls, the UNIX security solution is to +change the UNIX file permissions on the users home directories +such that the cd and ls would be denied. +</para> + +<para> +Samba tries very hard not to second guess the UNIX administrators +security policies, and trusts the UNIX admin to set +the policies and permissions he or she desires. +</para> + +<para> +Samba does allow the setup you require when you have set the +"only user = yes" option on the share, is that you have not set the +valid users list for the share. +</para> + +<para> +Note that only user works in conjunction with the users= list, +so to get the behavior you require, add the line : +<programlisting> +users = %S +</programlisting> +this is equivalent to: +<programlisting> +valid users = %S +</programlisting> +to the definition of the [homes] share, as recommended in +the smb.conf man page. +</para> + +</sect1> + +<sect1> +<title>Until a few minutes after samba has started, clients get the error "Domain Controller Unavailable"</title> +<para> +A domain controller has to announce on the network who it is. This usually takes a while. +</para> +</sect1> + +<sect1> +<title>I'm getting "open_oplock_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested" in the logs</title> +<para>Your loopback device isn't working correctly. Make sure it's running. +</para> +</sect1> + +</chapter> diff --git a/docs/docbook/faq/features.xml b/docs/docbook/faq/features.xml new file mode 100644 index 0000000000..66b05379cc --- /dev/null +++ b/docs/docbook/faq/features.xml @@ -0,0 +1,374 @@ +<chapter id="FAQ-features"> + +<title>Features</title> + +<sect1> +<title>How can I prevent my samba server from being used to distribute the Nimda worm?</title> + +<para>Author: HASEGAWA Yosuke (translated by <ulink url="monyo@samba.gr.jp">TAKAHASHI Motonobu</ulink>)</para> + +<para> +Nimba Worm is infected through shared disks on a network, as well as through +Microsoft IIS, Internet Explorer and mailer of Outlook series. +</para> + +<para> +At this time, the worm copies itself by the name *.nws and *.eml on +the shared disk, moreover, by the name of Riched20.dll in the folder +where *.doc file is included. +</para> + +<para> +To prevent infection through the shared disk offered by Samba, set +up as follows: +</para> + +<para> +<programlisting> +[global] + ... + # This can break Administration installations of Office2k. + # in that case, don't veto the riched20.dll + veto files = /*.eml/*.nws/riched20.dll/ +</programlisting> +</para> + +<para> +By setting the "veto files" parameter, matched files on the Samba +server are completely hidden from the clients and making it impossible +to access them at all. +</para> + +<para> +In addition to it, the following setting is also pointed out by the +samba-jp:09448 thread: when the +"readme.txt.{3050F4D8-98B5-11CF-BB82-00AA00BDCE0B}" file exists on +a Samba server, it is visible only as "readme.txt" and dangerous +code may be executed if this file is double-clicked. +</para> + +<para> +Setting the following, +<programlisting> + veto files = /*.{*}/ +</programlisting> +any files having CLSID in its file extension will be inaccessible from any +clients. +</para> + +<para> +This technical article is created based on the discussion of +samba-jp:09448 and samba-jp:10900 threads. +</para> +</sect1> + +<sect1> +<title>How can I use samba as a fax server?</title> + +<para>Contributor: <ulink url="mailto:zuber@berlin.snafu.de">Gerhard Zuber</ulink></para> + +<para>Requirements: +<simplelist> +<member>UNIX box (Linux preferred) with SAMBA and a faxmodem</member> +<member>ghostscript package</member> +<member>mgetty+sendfax package</member> +<member>pbm package (portable bitmap tools)</member> +</simplelist> +</para> + +<para>First, install and configure the required packages. Be sure to read the mgetty+sendfax +manual carefully.</para> + +<sect2> +<title>Tools for printing faxes</title> + +<para>Your incomed faxes are in: +<filename>/var/spool/fax/incoming</filename>. Print it with:</para> + +<para><programlisting> +for i in * +do +g3cat $i | g3tolj | lpr -P hp +done +</programlisting> +</para> + +<para> +g3cat is in the tools-section, g3tolj is in the contrib-section +for printing to HP lasers. +</para> + +<para> +If you want to produce files for displaying and printing with Windows, use +some tools from the pbm-package like the following command: <command>g3cat $i | g3topbm - | ppmtopcx - >$i.pcx</command> +and view it with your favourite Windows tool (maybe paintbrush) +</para> + +</sect2> + +<sect2> +<title>Making the fax-server</title> + +<para>fetch the file <filename>mgetty+sendfax/frontends/winword/faxfilter</filename> and place it in <filename>/usr/local/etc/mgetty+sendfax/</filename>(replace /usr/local/ with whatever place you installed mgetty+sendfax)</para> + +<para>prepare your faxspool file as mentioned in this file +edit fax/faxspool.in and reinstall or change the final +/usr/local/bin/faxspool too. +</para> + +<para><programlisting> +if [ "$user" = "root" -o "$user" = "fax" -o \ + "$user" = "lp" -o "$user" = "daemon" -o "$user" = "bin" ] +</programlisting></para> + +<para>find the first line and change it to the second.</para> + +<para> +make sure you have pbmtext (from the pbm-package). This is +needed for creating the small header line on each page. +</para> + +<para>Prepare your faxheader <filename>/usr/local/etc/mgetty+sendfax/faxheader</filename></para> + +<para> +Edit your /etc/printcap file: +<programlisting> +# FAX +lp3|fax:\ + :lp=/dev/null:\ + :sd=/usr/spool/lp3:\ + :if=/usr/local/etc/mgetty+sendfax/faxfilter:sh:sf:mx#0:\ + :lf=/usr/spool/lp3/fax-log: +</programlisting></para> + +<para>Now, edit your <filename>smb.conf</filename> so you have a smb based printer named "fax"</para> + +</sect2> + +<sect2> +<title>Installing the client drivers</title> + +<para> +Now you have a printer called "fax" which can be used via +TCP/IP-printing (lpd-system) or via SAMBA (windows printing). +</para> + +<para> +On every system you are able to produce postscript-files you +are ready to fax. +</para> + +<para> +On Windows 3.1 95 and NT: +</para> + +<para> +Install a printer wich produces postscript output, + e.g. apple laserwriter +</para> + +<para>Connect the "fax" to your printer.</para> + +<para> +Now write your first fax. Use your favourite wordprocessor, +write, winword, notepad or whatever you want, and start +with the headerpage. +</para> + +<para> +Usually each fax has a header page. It carries your name, +your address, your phone/fax-number. +</para> + +<para> +It carries also the recipient, his address and his *** fax +number ***. Now here is the trick: +</para> + +<para> +Use the text: +<programlisting> +Fax-Nr: 123456789 +</programlisting> +as the recipients fax-number. Make sure this text does not +occur in regular text ! Make sure this text is not broken +by formatting information, e.g. format it as a single entity. +(Windows Write and Win95 Wordpad are functional, maybe newer + versions of Winword are breaking formatting information). +</para> + +<para> +The trick is that postscript output is human readable and +the faxfilter program scans the text for this pattern and +uses the found number as the fax-destination-number. +</para> + +<para> +Now print your fax through the fax-printer and it will be +queued for later transmission. Use faxrunq for sending the +queue out. +</para> + +</sect2> + +<sect2> +<title>Example smb.conf</title> + +<para><programlisting> +[global] + printcap name = /etc/printcap + print command = /usr/bin/lpr -r -P %p %s + lpq command = /usr/bin/lpq -P %p + lprm command = /usr/bin/lprm -P %p %j + +[fax] + comment = FAX (mgetty+sendfax) + path = /tmp + printable = yes + public = yes + writable = no + create mode = 0700 + browseable = yes + guest ok = no +</programlisting></para> + +</sect2> +</sect1> + +<sect1> +<title>Samba doesn't work well together with DHCP!</title> + +<para> +We wish to help those folks who wish to use the ISC DHCP Server and provide +sample configuration settings. Most operating systems today come ship with +the ISC DHCP Server. ISC DHCP is available from: +<ulink url="ftp://ftp.isc.org/isc/dhcp">ftp://ftp.isc.org/isc/dhcp</ulink> +</para> + +<para> +Incorrect configuration of MS Windows clients (Windows9X, Windows ME, Windows +NT/2000) will lead to problems with browsing and with general network +operation. Windows 9X/ME users often report problems where the TCP/IP and related +network settings will inadvertantly become reset at machine start-up resulting +in loss of configuration settings. This results in increased maintenance +overheads as well as serious user frustration. +</para> + +<para> +In recent times users on one mailing list incorrectly attributed the cause of +network operating problems to incorrect configuration of Samba. +</para> + +<para> +One user insisted that the only way to provent Windows95 from periodically +performing a full system reset and hardware detection process on start-up was +to install the NetBEUI protocol in addition to TCP/IP. This assertion is not +correct. +</para> + +<para> +In the first place, there is NO need for NetBEUI. All Microsoft Windows clients +natively run NetBIOS over TCP/IP, and that is the only protocol that is +recognised by Samba. Installation of NetBEUI and/or NetBIOS over IPX will +cause problems with browse list operation on most networks. Even Windows NT +networks experience these problems when incorrectly configured Windows95 +systems share the same name space. It is important that only those protocols +that are strictly needed for site specific reasons should EVER be installed. +</para> + +<para> +Secondly, and totally against common opinion, DHCP is NOT an evil design but is +an extension of the BOOTP protocol that has been in use in Unix environments +for many years without any of the melt-down problems that some sensationalists +would have us believe can be experienced with DHCP. In fact, DHCP in covered by +rfc1541 and is a very safe method of keeping an MS Windows desktop environment +under control and for ensuring stable network operation. +</para> + +<para> +Please note that MS Windows systems as of MS Windows NT 3.1 and MS Windows 95 +store all network configuration settings a registry. There are a few reports +from MS Windows network administrators that warrant mention here. It would appear +that when one sets certain MS TCP/IP protocol settings (either directly or via +DHCP) that these do get written to the registry. Even though a subsequent +change of setting may occur the old value may persist in the registry. This +has been known to create serious networking problems. +</para> + +<para> +An example of this occurs when a manual TCP/IP environment is configured to +include a NetBIOS Scope. In this event, when the administrator then changes the +configuration of the MS TCP/IP protocol stack, without first deleting the +current settings, by simply checking the box to configure the MS TCP/IP stack +via DHCP then the NetBIOS Scope that is still persistent in the registry WILL be +applied to the resulting DHCP offered settings UNLESS the DHCP server also sets +a NetBIOS Scope. It may therefore be prudent to forcibly apply a NULL NetBIOS +Scope from your DHCP server. The can be done in the dhcpd.conf file with the +parameter: +<command>option netbios-scope "";</command> +</para> + +<para> +While it is true that the Microsoft DHCP server that comes with Windows NT +Server provides only a sub-set of rfc1533 functionality this is hardly an issue +in those sites that already have a large investment and commitment to Unix +systems and technologies. The current state of the art of the DHCP Server +specification in covered in rfc2132. +</para> + +</sect1> + +<sect1> +<title>How can I assign NetBIOS names to clients with DHCP?</title> + +<para> +SMB network clients need to be configured so that all standard TCP/IP name to +address resolution works correctly. Once this has been achieved the SMB +environment provides additional tools and services that act as helper agents in +the translation of SMB (NetBIOS) names to their appropriate IP Addresses. One +such helper agent is the NetBIOS Name Server (NBNS) or as Microsoft called it +in their Windows NT Server implementation WINS (Windows Internet Name Server). +</para> + +<para> +A client needs to be configured so that it has a unique Machine (Computer) +Name. +</para> + +<para> +This can be done, but needs a few NT registry hacks and you need to be able to +speak UNICODE, which is of course no problem for a True Wizzard(tm) :) +Instructions on how to do this (including a small util for less capable +Wizzards) can be found at +</para> + +<para><ulink url="http://www.unixtools.org/~nneul/sw/nt/dhcp-netbios-hostname.html">http://www.unixtools.org/~nneul/sw/nt/dhcp-netbios-hostname.html</ulink></para> + +</sect1> + +<sect1> +<title>How do I convert between unix and dos text formats?</title> + +<para> +Jim barry has written an <ulink url="ftp://samba.org/pub/samba/contributed/fixcrlf.zip"> +excellent drag-and-drop cr/lf converter for +windows</ulink>. Just drag your file onto the icon and it converts the file. +</para> + +<para> +The utilities unix2dos and dos2unix(in the mtools package) should do +the job under unix. +</para> + +</sect1> + +<sect1> +<title>Does samba have wins replication support?</title> + +<para> +At the time of writing there is currently being worked on a wins replication implementation(wrepld). +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/faq/general.xml b/docs/docbook/faq/general.xml new file mode 100644 index 0000000000..54c620b382 --- /dev/null +++ b/docs/docbook/faq/general.xml @@ -0,0 +1,131 @@ +<chapter id="FAQ-general"> +<title>General Information</title> + +<sect1> +<title>Where can I get it?</title> +<para> +The Samba suite is available at the <ulink url="http://samba.org/">samba website</ulink>. +</para> +</sect1> + +<sect1> +<title>What do the version numbers mean?</title> +<para> +It is not recommended that you run a version of Samba with the word +"alpha" in its name unless you know what you are doing and are willing +to do some debugging. Many, many people just get the latest +recommended stable release version and are happy. If you are brave, by +all means take the plunge and help with the testing and development - +but don't install it on your departmental server. Samba is typically +very stable and safe, and this is mostly due to the policy of many +public releases. +</para> + +<para> +How the scheme works: +<simplelist> +<member>When major changes are made the version number is increased. For +example, the transition from 1.9.15 to 1.9.16. However, this version +number will not appear immediately and people should continue to use +1.9.15 for production systems (see next point.)</member> + +<member>Just after major changes are made the software is considered +unstable, and a series of alpha releases are distributed, for example +1.9.16alpha1. These are for testing by those who know what they are +doing. The "alpha" in the filename will hopefully scare off those who +are just looking for the latest version to install.</member> + +<member>When the release manager, currently Jerry, thinks that the alphas have stabilised to the point +where he would recommend new users install it, he renames it to the +same version number without the alpha, for example 1.9.16.</member> + +<member>Inevitably bugs are found in the "stable" releases and minor patch +levels are released which give us the pXX series, for example 1.9.16p2.</member> +</simplelist> +</para> + +<para> +So the progression goes: + +<programlisting> +1.9.15p7 (production) +1.9.15p8 (production) +1.9.16alpha1 (test sites only) +: +1.9.16alpha20 (test sites only) +1.9.16 (production) +1.9.16p1 (production) +</programlisting> +</para> + +<para> +The above system means that whenever someone looks at the samba ftp +site they will be able to grab the highest numbered release without an +alpha in the name and be sure of getting the current recommended +version. +</para> + +</sect1> + +<sect1> +<title>What platforms are supported?</title> +<para> +Many different platforms have run Samba successfully. The platforms +most widely used and thus best tested are Linux and SunOS.</para> + +<para> +At time of writing, there is support (or has been support for in earlier +versions): +</para> + +<simplelist> +<member>A/UX 3.0</member> +<member>AIX</member> +<member>Altos Series 386/1000</member> +<member>Amiga</member> +<member>Apollo Domain/OS sr10.3</member> +<member>BSDI </member> +<member>B.O.S. (Bull Operating System)</member> +<member>Cray, Unicos 8.0</member> +<member>Convex</member> +<member>DGUX. </member> +<member>DNIX.</member> +<member>FreeBSD</member> +<member>HP-UX</member> +<member>Intergraph. </member> +<member>Linux with/without shadow passwords and quota</member> +<member>LYNX 2.3.0</member> +<member>MachTen (a unix like system for Macintoshes)</member> +<member>Motorola 88xxx/9xx range of machines</member> +<member>NetBSD</member> +<member>NEXTSTEP Release 2.X, 3.0 and greater (including OPENSTEP for Mach).</member> +<member>OS/2 using EMX 0.9b</member> +<member>OSF1</member> +<member>QNX 4.22</member> +<member>RiscIX. </member> +<member>RISCOs 5.0B</member> +<member>SEQUENT. </member> +<member>SCO (including: 3.2v2, European dist., OpenServer 5)</member> +<member>SGI.</member> +<member>SMP_DC.OSx v1.1-94c079 on Pyramid S series</member> +<member>SONY NEWS, NEWS-OS (4.2.x and 6.1.x)</member> +<member>SUNOS 4</member> +<member>SUNOS 5.2, 5.3, and 5.4 (Solaris 2.2, 2.3, and '2.4 and later')</member> +<member>Sunsoft ISC SVR3V4</member> +<member>SVR4</member> +<member>System V with some berkely extensions (Motorola 88k R32V3.2).</member> +<member>ULTRIX.</member> +<member>UNIXWARE</member> +<member>UXP/DS</member> +</simplelist> + +</sect1> + +<sect1> +<title>How do I subscribe to the Samba Mailing Lists?</title> +<para> +Look at <ulink url="http://samba.org/samba/archives.html">the samba mailing list page</ulink> +</para> +</sect1> + +</chapter> diff --git a/docs/docbook/faq/install.xml b/docs/docbook/faq/install.xml new file mode 100644 index 0000000000..f8341dc65a --- /dev/null +++ b/docs/docbook/faq/install.xml @@ -0,0 +1,333 @@ +<chapter id="FAQ-Install"> +<title>Compiling and installing Samba on a Unix host</title> + +<sect1> +<title>I can't see the Samba server in any browse lists!</title> +<para> +See Browsing.html in the docs directory of the samba source +for more information on browsing. +</para> + +<para> +If your GUI client does not permit you to select non-browsable +servers, you may need to do so on the command line. For example, under +Lan Manager you might connect to the above service as disk drive M: +thusly: +<programlisting> + net use M: \\mary\fred +</programlisting> +The details of how to do this and the specific syntax varies from +client to client - check your client's documentation. +</para> +</sect1> + +<sect1> +<title>Some files that I KNOW are on the server don't show up when I view the files from my client!</title> +<para>See the next question.</para> +</sect1> + +<sect1> +<title>Some files on the server show up with really wierd filenames when I view the files from my client!</title> +<para> +If you check what files are not showing up, you will note that they +are files which contain upper case letters or which are otherwise not +DOS-compatible (ie, they are not legal DOS filenames for some reason). +</para> + +<para> +The Samba server can be configured either to ignore such files +completely, or to present them to the client in "mangled" form. If you +are not seeing the files at all, the Samba server has most likely been +configured to ignore them. Consult the man page smb.conf(5) for +details of how to change this - the parameter you need to set is +"mangled names = yes". +</para> +</sect1> + +<sect1> +<title>My client reports "cannot locate specified computer" or similar</title> +<para> +This indicates one of three things: You supplied an incorrect server +name, the underlying TCP/IP layer is not working correctly, or the +name you specified cannot be resolved. +</para> + +<para> +After carefully checking that the name you typed is the name you +should have typed, try doing things like pinging a host or telnetting +to somewhere on your network to see if TCP/IP is functioning OK. If it +is, the problem is most likely name resolution. +</para> + +<para> +If your client has a facility to do so, hardcode a mapping between the +hosts IP and the name you want to use. For example, with Lan Manager +or Windows for Workgroups you would put a suitable entry in the file +LMHOSTS. If this works, the problem is in the communication between +your client and the netbios name server. If it does not work, then +there is something fundamental wrong with your naming and the solution +is beyond the scope of this document. +</para> + +<para> +If you do not have any server on your subnet supplying netbios name +resolution, hardcoded mappings are your only option. If you DO have a +netbios name server running (such as the Samba suite's nmbd program), +the problem probably lies in the way it is set up. Refer to Section +Two of this FAQ for more ideas. +</para> + +<para> +By the way, remember to REMOVE the hardcoded mapping before further +tests :-) +</para> + +</sect1> + +<sect1> +<title>My client reports "cannot locate specified share name" or similar</title> +<para> +This message indicates that your client CAN locate the specified +server, which is a good start, but that it cannot find a service of +the name you gave. +</para> + +<para> +The first step is to check the exact name of the service you are +trying to connect to (consult your system administrator). Assuming it +exists and you specified it correctly (read your client's docs on how +to specify a service name correctly), read on: +</para> + +<simplelist> +<member>Many clients cannot accept or use service names longer than eight characters.</member> +<member>Many clients cannot accept or use service names containing spaces.</member> +<member>Some servers (not Samba though) are case sensitive with service names.</member> +<member>Some clients force service names into upper case.</member> +</simplelist> +</sect1> + +<sect1> +<title>Printing doesn't work</title> +<para> +Make sure that the specified print command for the service you are +connecting to is correct and that it has a fully-qualified path (eg., +use "/usr/bin/lpr" rather than just "lpr"). +</para> + +<para> +Make sure that the spool directory specified for the service is +writable by the user connected to the service. In particular the user +"nobody" often has problems with printing, even if it worked with an +earlier version of Samba. Try creating another guest user other than +"nobody". +</para> + +<para> +Make sure that the user specified in the service is permitted to use +the printer. +</para> + +<para> +Check the debug log produced by smbd. Search for the printer name and +see if the log turns up any clues. Note that error messages to do with +a service ipc$ are meaningless - they relate to the way the client +attempts to retrieve status information when using the LANMAN1 +protocol. +</para> + +<para> +If using WfWg then you need to set the default protocol to TCP/IP, not +Netbeui. This is a WfWg bug. +</para> + +<para> +If using the Lanman1 protocol (the default) then try switching to +coreplus. Also not that print status error messages don't mean +printing won't work. The print status is received by a different +mechanism. +</para> +</sect1> + +<sect1> +<title>My client reports "This server is not configured to list shared resources"</title> +<para> +Your guest account is probably invalid for some reason. Samba uses the +guest account for browsing in smbd. Check that your guest account is +valid. +</para> + +<para>See also 'guest account' in smb.conf man page.</para> + +</sect1> + +<sect1> +<title>Log message "you appear to have a trapdoor uid system" </title> +<para> +This can have several causes. It might be because you are using a uid +or gid of 65535 or -1. This is a VERY bad idea, and is a big security +hole. Check carefully in your /etc/passwd file and make sure that no +user has uid 65535 or -1. Especially check the "nobody" user, as many +broken systems are shipped with nobody setup with a uid of 65535. +</para> + +<para>It might also mean that your OS has a trapdoor uid/gid system :-)</para> + +<para> +This means that once a process changes effective uid from root to +another user it can't go back to root. Unfortunately Samba relies on +being able to change effective uid from root to non-root and back +again to implement its security policy. If your OS has a trapdoor uid +system this won't work, and several things in Samba may break. Less +things will break if you use user or server level security instead of +the default share level security, but you may still strike +problems. +</para> + +<para> +The problems don't give rise to any security holes, so don't panic, +but it does mean some of Samba's capabilities will be unavailable. +In particular you will not be able to connect to the Samba server as +two different uids at once. This may happen if you try to print as a +"guest" while accessing a share as a normal user. It may also affect +your ability to list the available shares as this is normally done as +the guest user. +</para> + +<para> +Complain to your OS vendor and ask them to fix their system. +</para> + +<para> +Note: the reason why 65535 is a VERY bad choice of uid and gid is that +it casts to -1 as a uid, and the setreuid() system call ignores (with +no error) uid changes to -1. This means any daemon attempting to run +as uid 65535 will actually run as root. This is not good! +</para> + +</sect1> + +<sect1> +<title>Why are my file's timestamps off by an hour, or by a few hours?</title> +<para> +This is from Paul Eggert eggert@twinsun.com. +</para> + +<para> +Most likely it's a problem with your time zone settings. +</para> + +<para> +Internally, Samba maintains time in traditional Unix format, +namely, the number of seconds since 1970-01-01 00:00:00 Universal Time +(or ``GMT''), not counting leap seconds. +</para> + +<para> +On the server side, Samba uses the Unix TZ variable to convert +internal timestamps to and from local time. So on the server side, there are +two things to get right. +<simplelist> +<member>The Unix system clock must have the correct Universal time. Use the shell command "sh -c 'TZ=UTC0 date'" to check this.</member> +<member>The TZ environment variable must be set on the server before Samba is invoked. The details of this depend on the server OS, but typically you must edit a file whose name is /etc/TIMEZONE or /etc/default/init, or run the command `zic -l'.</member> +</simplelist> +</para> + +<para>TZ must have the correct value.</para> + +<para> +If possible, use geographical time zone settings +(e.g. TZ='America/Los_Angeles' or perhaps + TZ=':US/Pacific'). These are supported by most +popular Unix OSes, are easier to get right, and are +more accurate for historical timestamps. If your +operating system has out-of-date tables, you should be +able to update them from the public domain time zone +tables at <ulink url="ftp://elsie.nci.nih.gov/pub/">ftp://elsie.nci.nih.gov/pub/</ulink>. +</para> + +<para>If your system does not support geographical timezone +settings, you must use a Posix-style TZ strings, e.g. +TZ='PST8PDT,M4.1.0/2,M10.5.0/2' for US Pacific time. +Posix TZ strings can take the following form (with optional + items in brackets): +<programlisting> + StdOffset[Dst[Offset],Date/Time,Date/Time] +</programlisting> + where: +</para> + +<para><simplelist> +<member>`Std' is the standard time designation (e.g. `PST').</member> +<member>`Offset' is the number of hours behind UTC (e.g. `8'). +Prepend a `-' if you are ahead of UTC, and +append `:30' if you are at a half-hour offset. +Omit all the remaining items if you do not use +daylight-saving time.</member> + +<member>`Dst' is the daylight-saving time designation +(e.g. `PDT').</member> + +<member>The optional second `Offset' is the number of +hours that daylight-saving time is behind UTC. +The default is 1 hour ahead of standard time. +</member> + +<member>`Date/Time,Date/Time' specify when daylight-saving +time starts and ends. The format for a date is +`Mm.n.d', which specifies the dth day (0 is Sunday) +of the nth week of the mth month, where week 5 means +the last such day in the month. The format for a +time is [h]h[:mm[:ss]], using a 24-hour clock. +</member> + +</simplelist> +</para> + +<para> +Other Posix string formats are allowed but you don't want +to know about them.</para> + +<para> +On the client side, you must make sure that your client's clock and +time zone is also set appropriately. [[I don't know how to do this.]] +Samba traditionally has had many problems dealing with time zones, due +to the bizarre ways that Microsoft network protocols handle time +zones. +</para> +</sect1> + +<sect1> +<title>How do I set the printer driver name correctly?</title> +<para>Question: +<quote> On NT, I opened "Printer Manager" and "Connect to Printer". + Enter ["\\ptdi270\ps1"] in the box of printer. I got the + following error message + </quote></para> + <para> + <programlisting> + You do not have sufficient access to your machine + to connect to the selected printer, since a driver + needs to be installed locally. + </programlisting> + </para> + + <para>Answer:</para> + + <para>In the more recent versions of Samba you can now set the "printer +driver" in smb.conf. This tells the client what driver to use. For +example:</para> +<para><programlisting> + printer driver = HP LaserJet 4L +</programlisting></para> +<para>With this, NT knows to use the right driver. You have to get this string +exactly right.</para> + +<para>To find the exact string to use, you need to get to the dialog box in +your client where you select which printer driver to install. The +correct strings for all the different printers are shown in a listbox +in that dialog box.</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/faq/printing.xml b/docs/docbook/faq/printing.xml new file mode 100644 index 0000000000..be2acbd905 --- /dev/null +++ b/docs/docbook/faq/printing.xml @@ -0,0 +1,38 @@ +<chapter id="FAQ-Printing"> +<!-- Kurt Pfeifle's HOWTO chapter on printing should make this obsolete --> +<chapterinfo> +<author> + <firstname>Ronan</firstname><surname>Waide</surname> +</author> +</chapterinfo> + +<title>Printing problems</title> + +<sect1> +<title>setdriver or cupsaddsmb failes</title> +<para> +setdriver expects the following setup: + +<simplelist> +<member>you are a printer admin, or root. this is the smb.conf printer admin group, not the Printer Operators group in NT. I've not tried the latter, but I don't believe it will work based on the current code.</member> +<member>printer admins has to be defined in [global]</member> +<member>upload the driver files to \\server\print$\w32x86 and win40 as appropriate. DON'T put them in the 0 or 2 subdirectories.</member> +<member>Make sure that the user you're connecting as is able to write to the print$ directories</member> +<member>Use adddriver (with appropriate parameters) to create the driver. note, this will not just update samba's notion of drivers, it will also move the files from the w32x86 and win40 directories to an appropriate subdirectory (based on driver version, I think, but not important enough for me to find out)</member> +<member>Use setdriver to associate the driver with a printer</member> +</simplelist> +</para> + +<para> +The setdriver call will fail if the printer doesn't already exist in +samba's view of the world. Either create the printer in cups and +restart samba, or create an add printer command (see smb.conf doco) +and use RPC calls to create a printer. NB the add printer command MUST +return a single line of text indicating which port the printer was +added on. If it doesn't, Samba won't reload the printer +definitions. Although samba doesn't really support the notion of +ports, suitable add printer command and enumport command settings can +allow you pretty good remote control of the samba printer setup. +</para> +</sect1> +</chapter> diff --git a/docs/docbook/faq/sambafaq.xml b/docs/docbook/faq/sambafaq.xml new file mode 100644 index 0000000000..d5dc3ae40f --- /dev/null +++ b/docs/docbook/faq/sambafaq.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE book SYSTEM "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY general SYSTEM "general.xml"> +<!ENTITY install SYSTEM "install.xml"> +<!ENTITY errors SYSTEM "errors.xml"> +<!ENTITY clientapp SYSTEM "clientapp.xml"> +<!ENTITY features SYSTEM "features.xml"> +<!ENTITY config SYSTEM "config.xml"> +<!ENTITY printing SYSTEM "printing.xml"> +]> + +<book id="Samba-FAQ"> +<title>Samba FAQ</title> + +<bookinfo> + <author><surname>Samba Team</surname></author> + <pubdate>October 2002</pubdate> +</bookinfo> + +<dedication> +<para> +This is the Frequently Asked Questions (FAQ) document for +Samba, the free and very popular SMB server product. An SMB server +allows file and printer connections from clients such as Windows, +OS/2, Linux and others. Current to version 3.0. Please send any +corrections to the samba documentation mailinglist at +<ulink url="mailto:samba-doc@samba.org">samba-doc@samba.org</ulink>. +This FAQ was based on the old Samba FAQ by Dan Shearer and Paul Blackman, +and the old samba text documents which were mostly written by John Terpstra. +</para> +</dedication> + +<toc/> + +&general; +&install; +&config; +&clientapp; +&errors; +&features; +&printing; +</book> diff --git a/docs/docbook/manpages/.cvsignore b/docs/docbook/manpages/.cvsignore new file mode 100644 index 0000000000..2d6c32d7f2 --- /dev/null +++ b/docs/docbook/manpages/.cvsignore @@ -0,0 +1 @@ +smb.conf.5.xml
\ No newline at end of file diff --git a/docs/docbook/manpages/editreg.1.xml b/docs/docbook/manpages/editreg.1.xml new file mode 100644 index 0000000000..3427552356 --- /dev/null +++ b/docs/docbook/manpages/editreg.1.xml @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="editreg.1"> + +<refmeta> + <refentrytitle>editreg</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>editreg</refname> + <refpurpose>A utility to report and change SIDs in registry files + </refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>editreg</command> + <arg choice="opt">-v</arg> + <arg choice="opt">-c file</arg> + <arg choice="req">file</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>editreg</command> is a utility that + can visualize windows registry files (currently only NT4) and apply + so-called commandfiles to them. + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>registry_file</term> + <listitem><para>Registry file to view or edit. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-v,--verbose</term> + <listitem><para>Increases verbosity of messages. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-c commandfile</term> + <listitem><para>Read commands to execute on <filename>registry_file</filename> from <filename>commandfile</filename>. Currently not yet supported! + </para></listitem> + </varlistentry> + + &stdarg.help; + + </variablelist> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The editreg man page was written by Jelmer Vernooij. </para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/findsmb.1.xml b/docs/docbook/manpages/findsmb.1.xml new file mode 100644 index 0000000000..e5ec26c4df --- /dev/null +++ b/docs/docbook/manpages/findsmb.1.xml @@ -0,0 +1,153 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="findsmb.1"> + +<refmeta> + <refentrytitle>findsmb</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>findsmb</refname> + <refpurpose>list info about machines that respond to SMB + name queries on a subnet</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>findsmb</command> + <arg choice="opt">subnet broadcast address</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This perl script is part of the <citerefentry> + <refentrytitle>Samba</refentrytitle><manvolnum>7</manvolnum></citerefentry> + suite.</para> + + <para><command>findsmb</command> is a perl script that + prints out several pieces of information about machines + on a subnet that respond to SMB name query requests. + It uses <citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry> + and <citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry> + to obtain this information. + </para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-r</term> + <listitem><para>Controls whether <command>findsmb</command> takes + bugs in Windows95 into account when trying to find a Netbios name + registered of the remote machine. This option is disabled by default + because it is specific to Windows 95 and Windows 95 machines only. + If set, <citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry> + will be called with <constant>-B</constant> option.</para></listitem> + </varlistentry> + <varlistentry> + <term>subnet broadcast address</term> + <listitem><para>Without this option, <command>findsmb + </command> will probe the subnet of the machine where + <citerefentry><refentrytitle>findsmb</refentrytitle><manvolnum>1</manvolnum></citerefentry> + is run. This value is passed to + <citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry> + as part of the <constant>-B</constant> option.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>EXAMPLES</title> + + <para>The output of <command>findsmb</command> lists the following + information for all machines that respond to the initial + <command>nmblookup</command> for any name: IP address, NetBIOS name, + Workgroup name, operating system, and SMB server version.</para> + + <para>There will be a '+' in front of the workgroup name for + machines that are local master browsers for that workgroup. There + will be an '*' in front of the workgroup name for + machines that are the domain master browser for that workgroup. + Machines that are running Windows, Windows 95 or Windows 98 will + not show any information about the operating system or server + version.</para> + + <para>The command with <constant>-r</constant> option + must be run on a system without <citerefentry> + <refentrytitle>nmbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> running. + + If <command>nmbd</command> is running on the system, you will + only get the IP address and the DNS name of the machine. To + get proper responses from Windows 95 and Windows 98 machines, + the command must be run as root and with <constant>-r</constant> + option on a machine without <command>nmbd</command> running.</para> + + <para>For example, running <command>findsmb</command> + without <constant>-r</constant> option set would yield output similar + to the following</para> + +<screen> +IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION +--------------------------------------------------------------------- +192.168.35.10 MINESET-TEST1 [DMVENGR] +192.168.35.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2.0.6] +192.168.35.56 HERBNT2 [HERB-NT] +192.168.35.63 GANDALF [MVENGR] [Unix] [Samba 2.0.5a for IRIX] +192.168.35.65 SAUNA [WORKGROUP] [Unix] [Samba 1.9.18p10] +192.168.35.71 FROGSTAR [ENGR] [Unix] [Samba 2.0.0 for IRIX] +192.168.35.78 HERBDHCP1 +[HERB] +192.168.35.88 SCNT2 +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0] +192.168.35.93 FROGSTAR-PC [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager] +192.168.35.97 HERBNT1 *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0] +</screen> + +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry> + <refentrytitle>nmbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry>, and <citerefentry><refentrytitle>nmblookup</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> + </para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink + url="ftp://ftp.icce.rug.nl/pub/unix/">ftp://ftp.icce.rug.nl/pub/unix/</ulink>) + and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/lmhosts.5.xml b/docs/docbook/manpages/lmhosts.5.xml new file mode 100644 index 0000000000..12d69a7e56 --- /dev/null +++ b/docs/docbook/manpages/lmhosts.5.xml @@ -0,0 +1,120 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="lmhosts.5"> + +<refmeta> + <refentrytitle>lmhosts</refentrytitle> + <manvolnum>5</manvolnum> +</refmeta> + + +<refnamediv> + <refname>lmhosts</refname> + <refpurpose>The Samba NetBIOS hosts file</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <para><filename>lmhosts</filename> is the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> NetBIOS name to IP address mapping file.</para> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This file is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><filename>lmhosts</filename> is the <emphasis>Samba + </emphasis> NetBIOS name to IP address mapping file. It + is very similar to the <filename>/etc/hosts</filename> file + format, except that the hostname component must correspond + to the NetBIOS naming format.</para> +</refsect1> + +<refsect1> + <title>FILE FORMAT</title> + <para>It is an ASCII file containing one line for NetBIOS name. + The two fields on each line are separated from each other by + white space. Any entry beginning with '#' is ignored. Each line + in the lmhosts file contains the following information:</para> + + <itemizedlist> + <listitem><para>IP Address - in dotted decimal format.</para> + </listitem> + + <listitem><para>NetBIOS Name - This name format is a + maximum fifteen character host name, with an optional + trailing '#' character followed by the NetBIOS name type + as two hexadecimal digits.</para> + + <para>If the trailing '#' is omitted then the given IP + address will be returned for all names that match the given + name, whatever the NetBIOS name type in the lookup.</para> + </listitem> + </itemizedlist> + + <para>An example follows:</para> + + <programlisting> +# +# Sample Samba lmhosts file. +# +192.9.200.1 TESTPC +192.9.200.20 NTSERVER#20 +192.9.200.21 SAMBASERVER + </programlisting> + + <para>Contains three IP to NetBIOS name mappings. The first + and third will be returned for any queries for the names "TESTPC" + and "SAMBASERVER" respectively, whatever the type component of + the NetBIOS name requested.</para> + + <para>The second mapping will be returned only when the "0x20" name + type for a name "NTSERVER" is queried. Any other name type will not + be resolved.</para> + + <para>The default location of the <filename>lmhosts</filename> file + is in the same directory as the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file.</para> + +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry> + <refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry>, and <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> + </para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at + <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/net.8.xml b/docs/docbook/manpages/net.8.xml new file mode 100644 index 0000000000..c7874e68fd --- /dev/null +++ b/docs/docbook/manpages/net.8.xml @@ -0,0 +1,905 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; + +<!-- This one is only used for adding users using RAP --> +<!ENTITY net.arg.flags ' +<varlistentry> +<term>-F flags</term> +<listitem><para> +FIXME. Defaults to 0x21 +</para></listitem> +</varlistentry>'> + +<!-- This one is only used by shutdown (RPC) --> +<!ENTITY net.arg.shutdown ' +<varlistentry> +<term>-r</term> +<listitem><para> +Reboot after shutdown. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>-f</term> +<listitem><para> +Force shutting down all applications. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>-t timeout</term> +<listitem><para> +Timeout before system will be shut down. An interactive +user of the system can use this time to cancel the shutdown. +</para></listitem> +</varlistentry>'> +]> + +<refentry id="net.8"> + +<refmeta> + <refentrytitle>net</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>net</refname> + <refpurpose>Tool for administration of Samba and remote + CIFS servers. + </refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>net</command> + <arg choice="req"><ads|rap|rpc></arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-w workgroup</arg> + <arg choice="opt">-W myworkgroup</arg> + <arg choice="opt">-U user</arg> + <arg choice="opt">-I ip-address</arg> + <arg choice="opt">-p port</arg> + <arg choice="opt">-n myname</arg> + <arg choice="opt">-s conffile</arg> + <arg choice="opt">-S server</arg> + <arg choice="opt">-l</arg> + <arg choice="opt">-P</arg> + <arg choice="opt">-D debuglevel</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>The samba net utility is meant to work just like the net utility + available for windows and DOS. The first argument should be used + to specify the protocol to use when executing a certain command. + ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3) + clients and RPC can be used for NT4 and Windows 2000. If this + argument is omitted, net will try to determine it automatically. + Not all commands are available on all protocols. + </para> + +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + &stdarg.help; + + <varlistentry> + <term>-w target-workgroup</term> + <listitem><para> + Sets target workgroup or domain. You have to specify + either this option or the IP address or the name of a server. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-W workgroup</term> + <listitem><para> + Sets client workgroup or domain + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-U user</term> + <listitem><para> + User name to use + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-I ip-address</term> + <listitem><para> + IP address of target server to use. You have to + specify either this option or a target workgroup or + a target server. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-p port</term> + <listitem><para> + Port on the target server to connect to (usually 139 or 445). + Defaults to trying 445 first, then 139. + </para></listitem> + </varlistentry> + + &stdarg.netbios.name; + &stdarg.configfile; + + <varlistentry> + <term>-S server</term> + <listitem><para> + Name of target server. You should specify either + this option or a target workgroup or a target IP address. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-l</term> + <listitem><para> + When listing data, give more information on each item. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-P</term> + <listitem><para> + Make queries to the external server using the machine account of the local server. + </para></listitem> + </varlistentry> + + &stdarg.debug; + </variablelist> +</refsect1> + +<refsect1> +<title>COMMANDS</title> + +<refsect2> + <title>TIME</title> + + <para>The <command>NET TIME</command> command allows you to view the time on a remote server + or synchronise the time on the local server with the time on the remote server.</para> + +<refsect3> +<title>TIME</title> + +<para>Without any options, the <command>NET TIME</command> command +displays the time on the remote server. +</para> + +</refsect3> + +<refsect3> +<title>TIME SYSTEM</title> + +<para> Displays the time on the remote server in a format ready for <command>/bin/date</command></para> + +</refsect3> + +<refsect3> +<title>TIME SET</title> +<para>Tries to set the date and time of the local server to that on +the remote server using <command>/bin/date</command>. </para> + +</refsect3> + +<refsect3> +<title>TIME ZONE</title> + +<para>Displays the timezone in hours from GMT on the remote computer.</para> + +</refsect3> +</refsect2> + +<refsect2> +<title>[RPC|ADS] JOIN [TYPE] [-U username[%password]] [options]</title> + +<para> +Join a domain. If the account already exists on the server, and +[TYPE] is MEMBER, the machine will attempt to join automatically. +(Assuming that the machine has been created in server manager) +Otherwise, a password will be prompted for, and a new account may +be created.</para> + +<para> +[TYPE] may be PDC, BDC or MEMBER to specify the type of server +joining the domain. +</para> +</refsect2> + +<refsect2> +<title>[RPC] OLDJOIN [options]</title> + +<para>Join a domain. Use the OLDJOIN option to join the domain +using the old style of domain joining - you need to create a trust +account in server manager first.</para> +</refsect2> + +<refsect2> +<title>[RPC|ADS] USER</title> + +<refsect3> +<title>[RPC|ADS] USER DELETE <replaceable>target</replaceable></title> + +<para>Delete specified user</para> + +</refsect3> + +<refsect3> +<title>[RPC|ADS] USER LIST</title> + +<para>List all users</para> + +</refsect3> + +<refsect3> +<title>[RPC|ADS] USER INFO <replaceable>target</replaceable></title> + +<para>List the domain groups of a the specified user.</para> + +</refsect3> + +<refsect3> +<title>[RPC|ADS] USER ADD <replaceable>name</replaceable> [password] [-F user flags] [-C comment]</title> + +<para>Add specified user.</para> +</refsect3> +</refsect2> + +<refsect2> +<title>[RPC|ADS] GROUP</title> + +<refsect3> +<title>[RPC|ADS] GROUP [misc options] [targets]</title> +<para>List user groups.</para> +</refsect3> + +<refsect3> +<title>[RPC|ADS] GROUP DELETE <replaceable>name</replaceable> [misc. options]</title> + +<para>Delete specified group.</para> + +</refsect3> + +<refsect3> +<title>[RPC|ADS] GROUP ADD <replaceable>name</replaceable> [-C comment]</title> + +<para>Create specified group.</para> + +</refsect3> +</refsect2> + +<refsect2> +<title>[RAP|RPC] SHARE</title> + +<refsect3> +<title>[RAP|RPC] SHARE [misc. options] [targets]</title> + +<para>Enumerates all exported resources (network shares) on target server.</para> + +</refsect3> + +<refsect3> +<title>[RAP|RPC] SHARE ADD <replaceable>name=serverpath</replaceable> [-C comment] [-M maxusers] [targets]</title> + +<para>Adds a share from a server (makes the export active). Maxusers +specifies the number of users that can be connected to the +share simultaneously.</para> + +</refsect3> + +<refsect3> +<title>SHARE DELETE <replaceable>sharenam</replaceable></title> + +<para>Delete specified share.</para> +</refsect3> +</refsect2> + +<refsect2> +<title>[RPC|RAP] FILE</title> + +<refsect3> +<title>[RPC|RAP] FILE</title> + +<para>List all open files on remote server.</para> + +</refsect3> + +<refsect3> +<title>[RPC|RAP] FILE CLOSE <replaceable>fileid</replaceable></title> + +<para>Close file with specified <replaceable>fileid</replaceable> on +remote server.</para> + +</refsect3> + +<refsect3> +<title>[RPC|RAP] FILE INFO <replaceable>fileid</replaceable></title> + +<para> +Print information on specified <replaceable>fileid</replaceable>. +Currently listed are: file-id, username, locks, path, permissions. +</para> + +</refsect3> + +<refsect3> +<title>[RAP|RPC] FILE USER</title> + +¬.implemented; + +</refsect3> + +</refsect2> + +<refsect2> +<title>SESSION</title> + +<refsect3> +<title>RAP SESSION</title> + +<para>Without any other options, SESSION enumerates all active SMB/CIFS +sessions on the target server.</para> + +</refsect3> + +<refsect3> +<title>RAP SESSION DELETE|CLOSE <replaceable>CLIENT_NAME</replaceable></title> + +<para>Close the specified sessions.</para> + +</refsect3> + +<refsect3> +<title>RAP SESSION INFO <replaceable>CLIENT_NAME</replaceable></title> + +<para>Give a list with all the open files in specified session.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP SERVER <replaceable>DOMAIN</replaceable></title> + +<para>List all servers in specified domain or workgroup. Defaults +to local domain.</para> + +</refsect2> + +<refsect2> +<title>RAP DOMAIN</title> + +<para>Lists all domains and workgroups visible on the +current network.</para> + +</refsect2> + +<refsect2> +<title>RAP PRINTQ</title> + +<refsect3> +<title>RAP PRINTQ LIST <replaceable>QUEUE_NAME</replaceable></title> + +<para>Lists the specified print queue and print jobs on the server. +If the <replaceable>QUEUE_NAME</replaceable> is omitted, all +queues are listed.</para> + +</refsect3> + +<refsect3> +<title>RAP PRINTQ DELETE <replaceable>JOBID</replaceable></title> + +<para>Delete job with specified id.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP VALIDATE <replaceable>user</replaceable> [<replaceable>password</replaceable>]</title> + +<para> +Validate whether the specified user can log in to the +remote server. If the password is not specified on the commandline, it +will be prompted. +</para> + +¬.implemented; + +</refsect2> + +<refsect2> +<title>RAP GROUPMEMBER</title> + +<refsect3> +<title>RAP GROUPMEMBER LIST <replaceable>GROUP</replaceable></title> + +<para>List all members of the specified group.</para> + +</refsect3> + +<refsect3> +<title>RAP GROUPMEMBER DELETE <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title> + +<para>Delete member from group.</para> + +</refsect3> + +<refsect3> +<title>RAP GROUPMEMBER ADD <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title> + +<para>Add member to group.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP ADMIN <replaceable>command</replaceable></title> + +<para>Execute the specified <replaceable>command</replaceable> on +the remote server. Only works with OS/2 servers. +</para> + +¬.implemented; + +</refsect2> + +<refsect2> +<title>RAP SERVICE</title> + +<refsect3> +<title>RAP SERVICE START <replaceable>NAME</replaceable> [arguments...]</title> + +<para>Start the specified service on the remote server. Not implemented yet.</para> + +¬.implemented; + +</refsect3> + +<refsect3> +<title>RAP SERVICE STOP</title> + +<para>Stop the specified service on the remote server.</para> + +¬.implemented; + +</refsect3> + +</refsect2> + +<refsect2> +<title>RAP PASSWORD <replaceable>USER</replaceable> <replaceable>OLDPASS</replaceable> <replaceable>NEWPASS</replaceable></title> + +<para> +Change password of <replaceable>USER</replaceable> from <replaceable>OLDPASS</replaceable> to <replaceable>NEWPASS</replaceable>. +</para> + +</refsect2> + +<refsect2> +<title>LOOKUP</title> + +<refsect3> +<title>LOOKUP HOST <replaceable>HOSTNAME</replaceable> [<replaceable>TYPE</replaceable>]</title> + +<para> +Lookup the IP address of the given host with the specified type (netbios suffix). +The type defaults to 0x20 (workstation). +</para> + +</refsect3> + +<refsect3> +<title>LOOKUP LDAP [<replaceable>DOMAIN</replaceable></title> + +<para>Give IP address of LDAP server of specified <replaceable>DOMAIN</replaceable>. Defaults to local domain.</para> + +</refsect3> + +<refsect3> +<title>LOOKUP KDC [<replaceable>REALM</replaceable>]</title> + +<para>Give IP address of KDC for the specified <replaceable>REALM</replaceable>. +Defaults to local realm.</para> + +</refsect3> + +<refsect3> +<title>LOOKUP DC [<replaceable>DOMAIN</replaceable>]</title> + +<para>Give IP's of Domain Controllers for specified <replaceable> +DOMAIN</replaceable>. Defaults to local domain.</para> + +</refsect3> + +<refsect3> +<title>LOOKUP MASTER <replaceable>DOMAIN</replaceable></title> + +<para>Give IP of master browser for specified <replaceable>DOMAIN</replaceable> +or workgroup. Defaults to local domain.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>CACHE</title> + +<para>Samba uses a general caching interface called 'gencache'. It +can be controlled using 'NET CACHE'.</para> + +<para>All the timeout parameters support the suffixes: + +<simplelist> +<member>s - Seconds</member> +<member>m - Minutes</member> +<member>h - Hours</member> +<member>d - Days</member> +<member>w - Weeks</member> +</simplelist> + +</para> + +<refsect3> +<title>CACHE ADD <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title> + +<para>Add specified key+data to the cache with the given timeout.</para> + +</refsect3> + +<refsect3> +<title>CACHE DEL <replaceable>key</replaceable></title> + +<para>Delete key from the cache.</para> + +</refsect3> + +<refsect3> +<title>CACHE SET <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title> + +<para>Update data of existing cache entry.</para> + +</refsect3> + +<refsect3> +<title>CACHE SEARCH <replaceable>PATTERN</replaceable></title> + +<para>Search for the specified pattern in the cache data.</para> + +</refsect3> + +<refsect3> +<title>CACHE LIST</title> + +<para> +List all current items in the cache. +</para> + +</refsect3> + +<refsect3> +<title>CACHE FLUSH</title> + +<para>Remove all the current items from the cache.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>GETLOCALSID [DOMAIN]</title> + +<para>Print the SID of the specified domain, or if the parameter is +omitted, the SID of the domain the local server is in.</para> + +</refsect2> + +<refsect2> +<title>SETLOCALSID S-1-5-21-x-y-z</title> + +<para>Sets domain sid for the local server to the specified SID.</para> + +</refsect2> + +<refsect2> +<title>GROUPMAP</title> + +<para>Manage the mappings between Windows group SIDs and UNIX groups. +Parameters take the for "parameter=value". Common options include:</para> + +<itemizedlist> +<listitem><para>unixgroup - Name of the UNIX group</para></listitem> +<listitem><para>ntgroup - Name of the Windows NT group (must be + resolvable to a SID</para></listitem> +<listitem><para>rid - Unsigned 32-bit integer</para></listitem> +<listitem><para>sid - Full SID in the form of "S-1-..."</para></listitem> +<listitem><para>type - Type of the group; either 'domain', 'local', + or 'builtin'</para></listitem> +<listitem><para>comment - Freeform text description of the group</para></listitem> +</itemizedlist> + +<refsect3> +<title>GROUPMAP ADD</title> + +<para>Add a new group mapping entry</para> + +<para>net groupmap add {rid=int|sid=string} unixgroup=string [type={domain|local|builtin}] [ntgroup=string] [comment=string]</para> + +</refsect3> + +<refsect3> +<title>GROUPMAP DELETE</title> + +<para>Delete a group mapping entry</para> + +<para>net groupmap delete {ntgroup=string|sid=SID}</para> + +</refsect3> + +<refsect3> +<title>GROUPMAP MODIFY</title> + +<para>Update en existing group entry</para> + +<para>net groupmap modify {ntgroup=string|sid=SID} [unixgroup=string] [comment=string] [type={domain|local}</para> +</refsect3> + +<refsect3> +<title>GROUPMAP LIST</title> + +<para>List existing group mapping entries</para> + +<para>net groupmap list [verbose] [ntgroup=string] [sid=SID]</para> + +</refsect3> +</refsect2> + + + +<refsect2> +<title>MAXRID</title> + +<para>Prints out the highest RID currently in use on the local +server (by the active 'passdb backend'). +</para> + +</refsect2> + +<refsect2> +<title>RPC INFO</title> + +<para>Print information about the domain of the remote server, +such as domain name, domain sid and number of users and groups. +</para> + +</refsect2> + +<refsect2> +<title>[RPC|ADS] TESTJOIN</title> + +<para>Check whether participation in a domain is still valid.</para> + +</refsect2> + +<refsect2> +<title>[RPC|ADS] CHANGETRUSTPW</title> + +<para>Force change of domain trust password.</para> + +</refsect2> + +<refsect2> +<title>RPC TRUSTDOM</title> + +<refsect3> +<title>RPC TRUSTDOM ADD <replaceable>DOMAIN</replaceable></title> + +<para>Add a interdomain trust account for +<replaceable>DOMAIN</replaceable> to the remote server. +</para> + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM DEL <replaceable>DOMAIM</replaceable></title> + +<para>Remove interdomain trust account for +<replaceable>DOMAIN</replaceable> from the remote server. +</para> + +¬.implemented; + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM ESTABLISH <replaceable>DOMAIN</replaceable></title> + +<para> +Establish a trust relationship to a trusting domain. +Interdomain account must already be created on the remote PDC. +</para> + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM REVOKE <replaceable>DOMAIN</replaceable></title> +<para>Abandon relationship to trusted domain</para> + +</refsect3> + +<refsect3> +<title>RPC TRUSTDOM LIST</title> + +<para>List all current interdomain trust relationships.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>RPC ABORTSHUTDOWN</title> + +<para>Abort the shutdown of a remote server.</para> + +</refsect2> + +<refsect2> +<title>SHUTDOWN [-t timeout] [-r] [-f] [-C message]</title> + +<para>Shut down the remote server.</para> + +<variablelist> +&net.arg.shutdown; +<varlistentry> +<term>-C message</term> +<listitem><para>Display the specified message on the screen to +announce the shutdown.</para></listitem> +</varlistentry> +</variablelist> + +</refsect2> + +<refsect2> +<title>SAMDUMP</title> + +<para>Print out sam database of remote server. You need +to run this on either a BDC. <!-- +Is that correct? - Jelmer --></para> +</refsect2> + +<refsect2> +<title>VAMPIRE</title> + +<para>Export users, aliases and groups from remote server to +local server. Can only be run an a BDC. +</para> + +</refsect2> + +<refsect2> +<title>GETSID</title> + +<para>Fetch domain SID and store it in the local <filename>secrets.tdb</filename>. </para> + +</refsect2> + +<refsect2> +<title>ADS LEAVE</title> + +<para>Make the remote host leave the domain it is part of. </para> + +</refsect2> + +<refsect2> +<title>ADS STATUS</title> + +<para>Print out status of machine account of the local machine in ADS. +Prints out quite some debug info. Aimed at developers, regular +users should use <command>NET ADS TESTJOIN</command>.</para> + +</refsect2> + +<refsect2> +<title>ADS PRINTER</title> + +<refsect3> +<title>ADS PRINTER INFO [<replaceable>PRINTER</replaceable>] [<replaceable>SERVER</replaceable>]</title> + +<para> +Lookup info for <replaceable>PRINTER</replaceable> on <replaceable>SERVER</replaceable>. The printer name defaults to "*", the +server name defaults to the local host.</para> + +</refsect3> + +<refsect3> +<title>ADS PRINTER PUBLISH <replaceable>PRINTER</replaceable></title> + +<para>Publish specified printer using ADS.</para> + +</refsect3> + +<refsect3> +<title>ADS PRINTER REMOVE <replaceable>PRINTER</replaceable></title> + +<para>Remove specified printer from ADS directory.</para> + +</refsect3> + +</refsect2> + +<refsect2> +<title>ADS SEARCH <replaceable>EXPRESSION</replaceable> <replaceable>ATTRIBUTES...</replaceable></title> + +<para>Perform a raw LDAP search on a ADS server and dump the results. The +expression is a standard LDAP search expression, and the +attributes are a list of LDAP fields to show in the results.</para> + +<para>Example: <userinput>net ads search '(objectCategory=group)' sAMAccountName</userinput> +</para> + +</refsect2> + +<refsect2> +<title>ADS DN <replaceable>DN</replaceable> <replaceable>(attributes)</replaceable></title> + +<para> +Perform a raw LDAP search on a ADS server and dump the results. The +DN standard LDAP DN, and the attributes are a list of LDAP fields +to show in the result. +</para> + +<para>Example: <userinput>net ads dn 'CN=administrator,CN=Users,DC=my,DC=domain' SAMAccountName</userinput></para> + +</refsect2> + +<refsect2> +<title>WORKGROUP</title> + +<para>Print out workgroup name for specified kerberos realm.</para> + +</refsect2> + + +<refsect2> +<title>HELP [COMMAND]</title> + +<para>Gives usage information for the specified command.</para> + +</refsect2> + +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is complete for version 3.0 of the Samba + suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The net manpage was written by Jelmer Vernooij.</para> + +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/nmbd.8.xml b/docs/docbook/manpages/nmbd.8.xml new file mode 100644 index 0000000000..a98d189839 --- /dev/null +++ b/docs/docbook/manpages/nmbd.8.xml @@ -0,0 +1,302 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="nmbd.8"> + +<refmeta> + <refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>nmbd</refname> + <refpurpose>NetBIOS name server to provide NetBIOS + over IP naming services to clients</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>nmbd</command> + <arg choice="opt">-D</arg> + <arg choice="opt">-F</arg> + <arg choice="opt">-S</arg> + <arg choice="opt">-a</arg> + <arg choice="opt">-i</arg> + <arg choice="opt">-o</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-V</arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-H <lmhosts file></arg> + <arg choice="opt">-l <log directory></arg> + <arg choice="opt">-n <primary netbios name></arg> + <arg choice="opt">-p <port number></arg> + <arg choice="opt">-s <configuration file></arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + <para>This program is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>nmbd</command> is a server that understands + and can reply to NetBIOS over IP name service requests, like + those produced by SMB/CIFS clients such as Windows 95/98/ME, + Windows NT, Windows 2000, Windows XP and LanManager clients. It also + participates in the browsing protocols which make up the + Windows "Network Neighborhood" view.</para> + + <para>SMB/CIFS clients, when they start up, may wish to + locate an SMB/CIFS server. That is, they wish to know what + IP number a specified host is using.</para> + + <para>Amongst other services, <command>nmbd</command> will + listen for such requests, and if its own NetBIOS name is + specified it will respond with the IP number of the host it + is running on. Its "own NetBIOS name" is by + default the primary DNS name of the host it is running on, + but this can be overridden with the <emphasis>-n</emphasis> + option (see OPTIONS below). Thus <command>nmbd</command> will + reply to broadcast queries for its own name(s). Additional + names for <command>nmbd</command> to respond on can be set + via parameters in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> configuration file.</para> + + <para><command>nmbd</command> can also be used as a WINS + (Windows Internet Name Server) server. What this basically means + is that it will act as a WINS database server, creating a + database from name registration requests that it receives and + replying to queries from clients for these names.</para> + + <para>In addition, <command>nmbd</command> can act as a WINS + proxy, relaying broadcast queries from clients that do + not understand how to talk the WINS protocol to a WINS + server.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-D</term> + <listitem><para>If specified, this parameter causes + <command>nmbd</command> to operate as a daemon. That is, + it detaches itself and runs in the background, fielding + requests on the appropriate port. By default, <command>nmbd</command> + will operate as a daemon if launched from a command shell. + nmbd can also be operated from the <command>inetd</command> + meta-daemon, although this is not recommended. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-F</term> + <listitem><para>If specified, this parameter causes + the main <command>nmbd</command> process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + <command>nmbd</command> under process supervisors such + as <command>supervise</command> and <command>svscan</command> + from Daniel J. Bernstein's <command>daemontools</command> + package, or the AIX process monitor. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-S</term> + <listitem><para>If specified, this parameter causes + <command>nmbd</command> to log to standard output rather + than a file.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-i</term> + <listitem><para>If this parameter is specified it causes the + server to run "interactively", not as a daemon, even if the + server is executed on the command line of a shell. Setting this + parameter negates the implicit daemon mode when run from the + command line. <command>nmbd</command> also logs to standard + output, as if the <constant>-S</constant> parameter had been + given. </para></listitem> + </varlistentry> + + &stdarg.help; + + <varlistentry> + <term>-H <filename></term> + <listitem><para>NetBIOS lmhosts file. The lmhosts + file is a list of NetBIOS names to IP addresses that + is loaded by the nmbd server and used via the name + resolution mechanism <ulink url="smb.conf.5.html#nameresolveorder"><parameter>name resolve + order</parameter></ulink> described in <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> to resolve any + NetBIOS name queries needed by the server. Note + that the contents of this file are <emphasis>NOT</emphasis> + used by <command>nmbd</command> to answer any name queries. + Adding a line to this file affects name NetBIOS resolution + from this host <emphasis>ONLY</emphasis>.</para> + + <para>The default path to this file is compiled into + Samba as part of the build process. Common defaults + are <filename>/usr/local/samba/lib/lmhosts</filename>, + <filename>/usr/samba/lib/lmhosts</filename> or + <filename>/etc/samba/lmhosts</filename>. See the <citerefentry><refentrytitle>lmhosts</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> man page for details on the contents of this file.</para></listitem> + </varlistentry> + + &popt.common.samba; + + <varlistentry> + <term>-p <UDP port number></term> + <listitem><para>UDP port number is a positive integer value. + This option changes the default UDP port number (normally 137) + that <command>nmbd</command> responds to name queries on. Don't + use this option unless you are an expert, in which case you + won't need help!</para></listitem> + </varlistentry> + + </variablelist> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>/etc/inetd.conf</filename></term> + <listitem><para>If the server is to be run by the + <command>inetd</command> meta-daemon, this file + must contain suitable startup information for the + meta-daemon. See the <ulink + url="install.html">install</ulink> document + for details. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/etc/rc</filename></term> + <listitem><para>or whatever initialization script your + system uses).</para> + + <para>If running the server as a daemon at startup, + this file will need to contain an appropriate startup + sequence for the server. See the <ulink + url="install.html">"How to Install and Test SAMBA"</ulink> document + for details.</para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/etc/services</filename></term> + <listitem><para>If running the server via the + meta-daemon <command>inetd</command>, this file + must contain a mapping of service name (e.g., netbios-ssn) + to service port (e.g., 139) and protocol type (e.g., tcp). + See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink> + document for details.</para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/usr/local/samba/lib/smb.conf</filename></term> + <listitem><para>This is the default location of + the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> server + configuration file. Other common places that systems + install this file are <filename>/usr/samba/lib/smb.conf</filename> + and <filename>/etc/samba/smb.conf</filename>.</para> + + <para>When run as a WINS server (see the + <ulink url="smb.conf.5.html#WINSSUPPORT"><constant>wins support</constant></ulink> + parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> man page), + <command>nmbd</command> + will store the WINS database in the file <filename>wins.dat</filename> + in the <filename>var/locks</filename> directory configured under + wherever Samba was configured to install itself.</para> + + <para>If <command>nmbd</command> is acting as a <emphasis> + browse master</emphasis> (see the <ulink + url="smb.conf.5.html#LOCALMASTER"><constant>local master</constant></ulink> + parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> man page, <command>nmbd</command> + will store the browsing database in the file <filename>browse.dat + </filename> in the <filename>var/locks</filename> directory + configured under wherever Samba was configured to install itself. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>SIGNALS</title> + + <para>To shut down an <command>nmbd</command> process it is recommended + that SIGKILL (-9) <emphasis>NOT</emphasis> be used, except as a last + resort, as this may leave the name database in an inconsistent state. + The correct way to terminate <command>nmbd</command> is to send it + a SIGTERM (-15) signal and wait for it to die on its own.</para> + + <para><command>nmbd</command> will accept SIGHUP, which will cause + it to dump out its namelists into the file <filename>namelist.debug + </filename> in the <filename>/usr/local/samba/var/locks</filename> + directory (or the <filename>var/locks</filename> directory configured + under wherever Samba was configured to install itself). This will also + cause <command>nmbd</command> to dump out its server database in + the <filename>log.nmb</filename> file.</para> + + <para>The debug log level of nmbd may be raised or lowered + using <citerefentry><refentrytitle>smbcontrol</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> (SIGUSR[1|2] signals + are no longer used since Samba 2.2). This is to allow + transient problems to be diagnosed, whilst still running + at a normally low log level.</para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para> + <citerefentry><refentrytitle>inetd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testprns</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, and the Internet + RFC's <filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>. + In addition the CIFS (formerly SMB) specification is available + as a link from the Web page <ulink url="http://samba.org/cifs/"> + http://samba.org/cifs/</ulink>.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/nmblookup.1.xml b/docs/docbook/manpages/nmblookup.1.xml new file mode 100644 index 0000000000..3da0649dd5 --- /dev/null +++ b/docs/docbook/manpages/nmblookup.1.xml @@ -0,0 +1,224 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="nmblookup"> + +<refmeta> + <refentrytitle>nmblookup</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>nmblookup</refname> + <refpurpose>NetBIOS over TCP/IP client used to lookup NetBIOS + names</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>nmblookup</command> + <arg choice="opt">-M</arg> + <arg choice="opt">-R</arg> + <arg choice="opt">-S</arg> + <arg choice="opt">-r</arg> + <arg choice="opt">-A</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-B <broadcast address></arg> + <arg choice="opt">-U <unicast address></arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-s <smb config file></arg> + <arg choice="opt">-i <NetBIOS scope></arg> + <arg choice="opt">-T</arg> + <arg choice="opt">-f</arg> + <arg choice="req">name</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>nmblookup</command> is used to query NetBIOS names + and map them to IP addresses in a network using NetBIOS over TCP/IP + queries. The options allow the name queries to be directed at a + particular IP broadcast area or to a particular machine. All queries + are done over UDP.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-M</term> + <listitem><para>Searches for a master browser by looking + up the NetBIOS name <replaceable>name</replaceable> with a + type of <constant>0x1d</constant>. If <replaceable> + name</replaceable> is "-" then it does a lookup on the special name + <constant>__MSBROWSE__</constant>. Please note that in order to + use the name "-", you need to make sure "-" isn't parsed as an + argument, e.g. use : + <userinput>nmblookup -M -- -</userinput>.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-R</term> + <listitem><para>Set the recursion desired bit in the packet + to do a recursive lookup. This is used when sending a name + query to a machine running a WINS server and the user wishes + to query the names in the WINS server. If this bit is unset + the normal (broadcast responding) NetBIOS processing code + on a machine is used instead. See RFC1001, RFC1002 for details. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-S</term> + <listitem><para>Once the name query has returned an IP + address then do a node status query as well. A node status + query returns the NetBIOS names registered by a host. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-r</term> + <listitem><para>Try and bind to UDP port 137 to send and receive UDP + datagrams. The reason for this option is a bug in Windows 95 + where it ignores the source port of the requesting packet + and only replies to UDP port 137. Unfortunately, on most UNIX + systems root privilege is needed to bind to this port, and + in addition, if the <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon is running on this machine it also binds to this port. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-A</term> + <listitem><para>Interpret <replaceable>name</replaceable> as + an IP Address and do a node status query on this address.</para> + </listitem> + </varlistentry> + + + + &popt.common.connection; + &stdarg.help; + + <varlistentry> + <term>-B <broadcast address></term> + <listitem><para>Send the query to the given broadcast address. Without + this option the default behavior of nmblookup is to send the + query to the broadcast address of the network interfaces as + either auto-detected or defined in the <ulink + url="smb.conf.5.html#INTERFACES"><parameter>interfaces</parameter> + </ulink> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-U <unicast address></term> + <listitem><para>Do a unicast query to the specified address or + host <replaceable>unicast address</replaceable>. This option + (along with the <parameter>-R</parameter> option) is needed to + query a WINS server.</para></listitem> + </varlistentry> + + + &popt.common.samba; + + <varlistentry> + <term>-T</term> + <listitem><para>This causes any IP addresses found in the + lookup to be looked up via a reverse DNS lookup into a + DNS name, and printed out before each</para> + + <para><emphasis>IP address .... NetBIOS name</emphasis></para> + + <para> pair that is the normal output.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-f</term> + <listitem><para> + Show which flags apply to the name that has been looked up. Possible + answers are zero or more of: Response, Authoritative, + Truncated, Recursion_Desired, Recursion_Available, Broadcast. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>name</term> + <listitem><para>This is the NetBIOS name being queried. Depending + upon the previous options this may be a NetBIOS name or IP address. + If a NetBIOS name then the different name types may be specified + by appending '#<type>' to the name. This name may also be + '*', which will return all registered names within a broadcast + area.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>EXAMPLES</title> + + <para><command>nmblookup</command> can be used to query + a WINS server (in the same way <command>nslookup</command> is + used to query DNS servers). To query a WINS server, <command>nmblookup</command> + must be called like this:</para> + + <para><command>nmblookup -U server -R 'name'</command></para> + + <para>For example, running :</para> + + <para><command>nmblookup -U samba.org -R 'IRIX#1B'</command></para> + + <para>would query the WINS server samba.org for the domain + master browser (1B name type) for the IRIX workgroup.</para> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry>, and <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/ntlm_auth.1.xml b/docs/docbook/manpages/ntlm_auth.1.xml new file mode 100644 index 0000000000..a37b5b3b7d --- /dev/null +++ b/docs/docbook/manpages/ntlm_auth.1.xml @@ -0,0 +1,130 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="ntlm-auth.1"> + +<refmeta> + <refentrytitle>ntlm_auth</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>ntlm_auth</refname> + <refpurpose>tool to allow external access to Winbind's NTLM authentication function</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>ntlm_auth</command> + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-l logfile</arg> + <arg choice="opt">-s <smb config file></arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>ntlm_auth</command> is a helper utility that authenticates + users using NT/LM authentication. It returns 0 if the users is authenticated + successfully and 1 if access was denied. ntlm_auth uses winbind to access + the user and authentication data for a domain. This utility + is only to be used by other programs (currently squid). + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>--helper-protocol=PROTO</term> + <listitem><para> + Operate as a stdio-based helper + </para></listitem> + </varlistentry> + + <varlistentry> + <term>--username=USERNAME</term> + <listitem><para> + Specify username of user to authenticate + </para></listitem> + </varlistentry> + + <varlistentry> + <term>--domain=DOMAIN</term> + <listitem><para> + Specify domain of user to authenticate + </para></listitem> + </varlistentry> + + <varlistentry> + <term>--workstation=WORKSTATION</term> + <listitem><para> + Specify the workstation the user authenticated from + </para></listitem> + </varlistentry> + + <varlistentry> + <term>--challenge=STRING</term> + <listitem><para>challenge (HEX encoded)</para></listitem> + </varlistentry> + + <varlistentry> + <term>--lm-response=RESPONSE</term> + <listitem><para>LM Response to the challenge (HEX encoded)</para></listitem> + </varlistentry> + + <varlistentry> + <term>--nt-response=RESPONSE</term> + <listitem><para>NT or NTLMv2 Response to the challenge (HEX encoded)</para></listitem> + </varlistentry> + + <varlistentry> + <term>--password=PASSWORD</term> + <listitem><para>User's plaintext password</para></listitem> + </varlistentry> + + <varlistentry> + <term>--request-lm-key</term> + <listitem><para>Retreive LM session key</para></listitem> + </varlistentry> + + <varlistentry> + <term>--request-nt-key</term> + <listitem><para>Request NT key</para></listitem> + </varlistentry> + + &popt.common.samba; + &stdarg.help; + + </variablelist> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The ntlm_auth manpage was written by Jelmer Vernooij.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/pdbedit.8.xml b/docs/docbook/manpages/pdbedit.8.xml new file mode 100644 index 0000000000..6d5127a855 --- /dev/null +++ b/docs/docbook/manpages/pdbedit.8.xml @@ -0,0 +1,378 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="pdbedit.8"> + +<refmeta> + <refentrytitle>pdbedit</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>pdbedit</refname> + <refpurpose>manage the SAM database</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>pdbedit</command> + <arg choice="opt">-l</arg> + <arg choice="opt">-v</arg> + <arg choice="opt">-w</arg> + <arg choice="opt">-u username</arg> + <arg choice="opt">-f fullname</arg> + <arg choice="opt">-h homedir</arg> + <arg choice="opt">-D drive</arg> + <arg choice="opt">-S script</arg> + <arg choice="opt">-p profile</arg> + <arg choice="opt">-a</arg> + <arg choice="opt">-m</arg> + <arg choice="opt">-x</arg> + <arg choice="opt">-i passdb-backend</arg> + <arg choice="opt">-e passdb-backend</arg> + <arg choice="opt">-g</arg> + <arg choice="opt">-b passdb-backend</arg> + <arg choice="opt">-g</arg> + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-s configfile</arg> + <arg choice="opt">-P account-policy</arg> + <arg choice="opt">-C value</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>The pdbedit program is used to manage the users accounts + stored in the sam database and can only be run by root.</para> + + <para>The pdbedit tool uses the passdb modular interface and is + independent from the kind of users database used (currently there + are smbpasswd, ldap, nis+ and tdb based and more can be added + without changing the tool).</para> + + <para>There are five main ways to use pdbedit: adding a user account, + removing a user account, modifing a user account, listing user + accounts, importing users accounts.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + <variablelist> + <varlistentry> + <term>-l</term> + <listitem><para>This option lists all the user accounts + present in the users database. + This option prints a list of user/uid pairs separated by + the ':' character.</para> + <para>Example: <command>pdbedit -l</command></para> + <para><screen> +sorce:500:Simo Sorce +samba:45:Test User +</screen></para> + </listitem> + </varlistentry> + + + + <varlistentry> + <term>-v</term> + <listitem><para>This option enables the verbose listing format. + It causes pdbedit to list the users in the database, printing + out the account fields in a descriptive format.</para> + + <para>Example: <command>pdbedit -l -v</command></para> + <para><screen> +--------------- +username: sorce +user ID/Group: 500/500 +user RID/GRID: 2000/2001 +Full Name: Simo Sorce +Home Directory: \\BERSERKER\sorce +HomeDir Drive: H: +Logon Script: \\BERSERKER\netlogon\sorce.bat +Profile Path: \\BERSERKER\profile +--------------- +username: samba +user ID/Group: 45/45 +user RID/GRID: 1090/1091 +Full Name: Test User +Home Directory: \\BERSERKER\samba +HomeDir Drive: +Logon Script: +Profile Path: \\BERSERKER\profile +</screen></para> + </listitem> + </varlistentry> + + + + <varlistentry> + <term>-w</term> + <listitem><para>This option sets the "smbpasswd" listing format. + It will make pdbedit list the users in the database, printing + out the account fields in a format compatible with the + <filename>smbpasswd</filename> file format. (see the + <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for details)</para> + + <para>Example: <command>pdbedit -l -w</command></para> + <screen> +sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX ]:LCT-00000000: +samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX ]:LCT-3BFA1E8D: +</screen> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-u username</term> + <listitem><para>This option specifies the username to be + used for the operation requested (listing, adding, removing). + It is <emphasis>required</emphasis> in add, remove and modify + operations and <emphasis>optional</emphasis> in list + operations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-f fullname</term> + <listitem><para>This option can be used while adding or + modifing a user account. It will specify the user's full + name. </para> + + <para>Example: <command>-f "Simo Sorce"</command></para> + </listitem> + </varlistentry> + + + + <varlistentry> + <term>-h homedir</term> + <listitem><para>This option can be used while adding or + modifing a user account. It will specify the user's home + directory network path.</para> + + <para>Example: <command>-h "\\\\BERSERKER\\sorce"</command> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-D drive</term> + <listitem><para>This option can be used while adding or + modifing a user account. It will specify the windows drive + letter to be used to map the home directory.</para> + + <para>Example: <command>-d "H:"</command> + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-S script</term> + <listitem><para>This option can be used while adding or + modifing a user account. It will specify the user's logon + script path.</para> + + <para>Example: <command>-s "\\\\BERSERKER\\netlogon\\sorce.bat"</command> + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-p profile</term> + <listitem><para>This option can be used while adding or + modifing a user account. It will specify the user's profile + directory.</para> + + <para>Example: <command>-p "\\\\BERSERKER\\netlogon"</command> + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-a</term> + <listitem><para>This option is used to add a user into the + database. This command needs a user name specified with + the -u switch. When adding a new user, pdbedit will also + ask for the password to be used.</para> + + <para>Example: <command>pdbedit -a -u sorce</command> +<programlisting>new password: +retype new password +</programlisting> +</para> + </listitem> + </varlistentry> + + + + <varlistentry> + <term>-m</term> + <listitem><para>This option may only be used in conjunction + with the <parameter>-a</parameter> option. It will make + pdbedit to add a machine trust account instead of a user + account (-u username will provide the machine name).</para> + + <para>Example: <command>pdbedit -a -m -u w2k-wks</command> + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-x</term> + <listitem><para>This option causes pdbedit to delete an account + from the database. It needs a username specified with the + -u switch.</para> + + <para>Example: <command>pdbedit -x -u bob</command></para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-i passdb-backend</term> + <listitem><para>Use a different passdb backend to retrieve users + than the one specified in smb.conf. Can be used to import data into + your local user database.</para> + + <para>This option will ease migration from one passdb backend to + another.</para> + + <para>Example: <command>pdbedit -i smbpasswd:/etc/smbpasswd.old + </command></para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-e passdb-backend</term> + <listitem><para>Exports all currently available users to the + specified password database backend.</para> + + <para>This option will ease migration from one passdb backend to + another and will ease backing up.</para> + + <para>Example: <command>pdbedit -e smbpasswd:/root/samba-users.backup</command></para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-g</term> + <listitem><para>If you specify <parameter>-g</parameter>, + then <parameter>-i in-backend -e out-backend</parameter> + applies to the group mapping instead of the user database.</para> + + <para>This option will ease migration from one passdb backend to + another and will ease backing up.</para> + + </listitem> + </varlistentry> + + <varlistentry> + <term>-g</term> + <listitem><para>If you specify <parameter>-g</parameter>, + then <parameter>-i in-backend -e out-backend</parameter> + applies to the group mapping instead of the user database.</para> + + <para>This option will ease migration from one passdb backend to + another and will ease backing up.</para> + + </listitem> + </varlistentry> + + <varlistentry> + <term>-b passdb-backend</term> + <listitem><para>Use a different default passdb backend. </para> + + <para>Example: <command>pdbedit -b xml:/root/pdb-backup.xml -l</command></para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-P account-policy</term> + <listitem><para>Display an account policy</para> + <para>Valid policies are: minimum password age, reset count minutes, disconnect time, + user must logon to change password, password history, lockout duration, min password length, + maximum password age and bad lockout attempt.</para> + + <para>Example: <command>pdbedit -P "bad lockout attempt"</command></para> +<para><programlisting> +account policy value for bad lockout attempt is 0 +</programlisting></para> + + </listitem> + </varlistentry> + + <varlistentry> + <term>-C account-policy-value</term> + <listitem><para>Sets an account policy to a specified value. + This option may only be used in conjunction + with the <parameter>-P</parameter> option. + </para> + + <para>Example: <command>pdbedit -P "bad lockout attempt" -C 3</command></para> +<para><programlisting> +account policy value for bad lockout attempt was 0 +account policy value for bad lockout attempt is now 3 +</programlisting></para> + </listitem> + </varlistentry> + + &stdarg.help; + &popt.common.samba; + + </variablelist> +</refsect1> + + +<refsect1> + <title>NOTES</title> + + <para>This command may be used only by root.</para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 2.2 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry></para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/profiles.1.xml b/docs/docbook/manpages/profiles.1.xml new file mode 100644 index 0000000000..1dbff39efa --- /dev/null +++ b/docs/docbook/manpages/profiles.1.xml @@ -0,0 +1,89 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="profiles.1"> + +<refmeta> + <refentrytitle>profiles</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>profiles</refname> + <refpurpose>A utility to report and change SIDs in registry files + </refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>profiles</command> + <arg choice="opt">-v</arg> + <arg choice="opt">-c SID</arg> + <arg choice="opt">-n SID</arg> + <arg choice="req">file</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>profiles</command> is a utility that + reports and changes SIDs in windows registry files. It currently only + supports NT. + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>file</term> + <listitem><para>Registry file to view or edit. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-v,--verbose</term> + <listitem><para>Increases verbosity of messages. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-c SID1 -n SID2</term> + <listitem><para>Change all occurences of SID1 in <filename>file</filename> by SID2. + </para></listitem> + </varlistentry> + + &stdarg.help; + + </variablelist> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The profiles man page was written by Jelmer Vernooij. </para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/rpcclient.1.xml b/docs/docbook/manpages/rpcclient.1.xml new file mode 100644 index 0000000000..c6775d9721 --- /dev/null +++ b/docs/docbook/manpages/rpcclient.1.xml @@ -0,0 +1,471 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="rpcclient.1"> + +<refmeta> + <refentrytitle>rpcclient</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>rpcclient</refname> + <refpurpose>tool for executing client side + MS-RPC functions</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>rpcclient</command> + <arg choice="opt">-A authfile</arg> + <arg choice="opt">-c <command string></arg> + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-l logfile</arg> + <arg choice="opt">-N</arg> + <arg choice="opt">-s <smb config file></arg> + <arg choice="opt">-U username[%password]</arg> + <arg choice="opt">-W workgroup</arg> + <arg choice="opt">-N</arg> + <arg choice="opt">-I destinationIP</arg> + <arg choice="req">server</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>rpcclient</command> is a utility initially developed + to test MS-RPC functionality in Samba itself. It has undergone + several stages of development and stability. Many system administrators + have now written scripts around it to manage Windows NT clients from + their UNIX workstation. </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>server</term> + <listitem><para>NetBIOS name of Server to which to connect. + The server can be any SMB/CIFS server. The name is + resolved using the <ulink url="smb.conf.5.html#NAMERESOLVEORDER"> + <parameter>name resolve order</parameter></ulink> line from <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-c|--command='command string'</term> + <listitem><para>execute semicolon separated commands (listed + below)) </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-I IP-address</term> + <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to. + It should be specified in standard "a.b.c.d" notation. </para> + + <para>Normally the client would attempt to locate a named + SMB/CIFS server by looking it up via the NetBIOS name resolution + mechanism described above in the <parameter>name resolve order</parameter> + parameter above. Using this parameter will force the client + to assume that the server is on the machine with the specified IP + address and the NetBIOS name component of the resource being + connected to will be ignored. </para> + + <para>There is no default for this parameter. If not supplied, + it will be determined automatically by the client as described + above. </para></listitem> + </varlistentry> + + &popt.common.samba; + &popt.common.credentials; + &popt.common.connection; + &stdarg.help; + </variablelist> +</refsect1> + + +<refsect1> + <title>COMMANDS</title> + + <refsect2> + <title>LSARPC</title> + + <variablelist> + <varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry> + + <varlistentry><term>lookupsids</term><listitem><para>Resolve a list + of SIDs to usernames. + </para></listitem></varlistentry> + + <varlistentry><term>lookupnames</term><listitem><para>Resolve a list + of usernames to SIDs. + </para></listitem></varlistentry> + + <varlistentry><term>enumtrusts</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry> + + <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry> + + <varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry> + + <varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry> + + <varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry> + + <varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry> + + <varlistentry><term>lsaenumacctwithright</term><listitem><para>Enumerate accounts with a right</para></listitem></varlistentry> + + <varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry> + + <varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry> + + <varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry> + + <varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry> + + </variablelist> + </refsect2> + + <refsect2> + <title>LSARPC-DS</title> + + <variablelist> + <varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry> + </variablelist> + + <para> </para> + + <para><emphasis>DFS</emphasis></para> + <variablelist> + <varlistentry><term>dfsexist</term><listitem><para>Query DFS support</para></listitem></varlistentry> + <varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry> + <varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry> + <varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry> + <varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry> + </variablelist> + + </refsect2> + + <refsect2> + <title>REG</title> + <variablelist> + <varlistentry><term>shutdown</term><listitem><para>Remote Shutdown</para></listitem></varlistentry> + <varlistentry><term>abortshutdown</term><listitem><para>Abort Shutdown</para></listitem></varlistentry> + </variablelist> + + </refsect2> + + <refsect2> + <title>SRVSVC</title> + + <variablelist> + <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry> + + <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry> + + <varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry> + + <varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry> + + </variablelist> + + </refsect2> + + <refsect2> + <title>SAMR</title> + + <variablelist> + <varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry> + <varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry> + <varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry> + <varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry> + <varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry> + <varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry> + <varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry> + <varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry> + <varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry> + <varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry> + <varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry> + <varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry> + <varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry> + <varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry> + <varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry> + <varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry> + <varlistentry><term>lookupdomain</term><listitem><para>Look up domain</para></listitem></varlistentry> + </variablelist> + + </refsect2> + + <refsect2> + <title>SPOOLSS</title> + + <variablelist> + <varlistentry><term>adddriver <arch> <config></term> + <listitem><para> + Execute an AddPrinterDriver() RPC to install the printer driver + information on the server. Note that the driver files should + already exist in the directory returned by + <command>getdriverdir</command>. Possible values for + <parameter>arch</parameter> are the same as those for + the <command>getdriverdir</command> command. + The <parameter>config</parameter> parameter is defined as + follows: </para> + +<para><programlisting> +Long Printer Name:\ +Driver File Name:\ +Data File Name:\ +Config File Name:\ +Help File Name:\ +Language Monitor Name:\ +Default Data Type:\ +Comma Separated list of Files +</programlisting></para> + + <para>Any empty fields should be enter as the string "NULL". </para> + + <para>Samba does not need to support the concept of Print Monitors + since these only apply to local printers whose driver can make + use of a bi-directional link for communication. This field should + be "NULL". On a remote NT print server, the Print Monitor for a + driver must already be installed prior to adding the driver or + else the RPC will fail. </para></listitem></varlistentry> + + <varlistentry><term>addprinter <printername> + <sharename> <drivername> <port></term> + <listitem><para> + Add a printer on the remote server. This printer + will be automatically shared. Be aware that the printer driver + must already be installed on the server (see <command>adddriver</command>) + and the <parameter>port</parameter>must be a valid port name (see + <command>enumports</command>.</para> + </listitem></varlistentry> + + + <varlistentry><term>deldriver</term><listitem><para>Delete the + specified printer driver for all architectures. This + does not delete the actual driver files from the server, + only the entry from the server's list of drivers. + </para></listitem></varlistentry> + + <varlistentry><term>enumdata</term><listitem><para>Enumerate all + printer setting data stored on the server. On Windows NT clients, + these values are stored in the registry, while Samba servers + store them in the printers TDB. This command corresponds + to the MS Platform SDK GetPrinterData() function (* This + command is currently unimplemented).</para></listitem></varlistentry> + + <varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry> + + <varlistentry><term>enumjobs <printer></term> + <listitem><para>List the jobs and status of a given printer. + This command corresponds to the MS Platform SDK EnumJobs() + function</para></listitem></varlistentry> + + <varlistentry><term>enumkey</term><listitem><para>Enumerate + printer keys</para></listitem></varlistentry> + + <varlistentry><term>enumports [level]</term> + <listitem><para> + Executes an EnumPorts() call using the specified + info level. Currently only info levels 1 and 2 are supported. + </para></listitem></varlistentry> + + + + <varlistentry><term>enumdrivers [level]</term> + <listitem><para> + Execute an EnumPrinterDrivers() call. This lists the various installed + printer drivers for all architectures. Refer to the MS Platform SDK + documentation for more details of the various flags and calling + options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry> + + + + <varlistentry><term>enumprinters [level]</term> + <listitem><para>Execute an EnumPrinters() call. This lists the various installed + and share printers. Refer to the MS Platform SDK documentation for + more details of the various flags and calling options. Currently + supported info levels are 0, 1, and 2.</para></listitem></varlistentry> + + + + + <varlistentry><term>getdata <printername> <valuename;></term> + <listitem><para>Retrieve the data for a given printer setting. See + the <command>enumdata</command> command for more information. + This command corresponds to the GetPrinterData() MS Platform + SDK function. </para></listitem></varlistentry> + + <varlistentry><term>getdataex</term><listitem><para>Get + printer driver data with + keyname</para></listitem></varlistentry> + + + <varlistentry><term>getdriver <printername></term> + <listitem><para> + Retrieve the printer driver information (such as driver file, + config file, dependent files, etc...) for + the given printer. This command corresponds to the GetPrinterDriver() + MS Platform SDK function. Currently info level 1, 2, and 3 are supported. + </para></listitem></varlistentry> + + + <varlistentry><term>getdriverdir <arch></term> + <listitem><para> + Execute a GetPrinterDriverDirectory() + RPC to retrieve the SMB share name and subdirectory for + storing printer driver files for a given architecture. Possible + values for <parameter>arch</parameter> are "Windows 4.0" + (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows + Alpha_AXP", and "Windows NT R4000". </para></listitem></varlistentry> + + + + <varlistentry><term>getprinter <printername></term> + <listitem><para>Retrieve the current printer information. This command + corresponds to the GetPrinter() MS Platform SDK function. + </para></listitem></varlistentry> + + <varlistentry><term>getprintprocdir</term><listitem><para>Get + print processor + directory</para></listitem></varlistentry> + + <varlistentry><term>openprinter <printername></term> + <listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC + against a given printer. </para></listitem></varlistentry> + + <varlistentry><term>setdriver <printername> + <drivername></term> + <listitem><para>Execute a SetPrinter() command to update the printer driver + associated with an installed printer. The printer driver must + already be correctly installed on the print server. </para> + + <para>See also the <command>enumprinters</command> and + <command>enumdrivers</command> commands for obtaining a list of + of installed printers and drivers.</para></listitem></varlistentry> + + <varlistentry><term>addform</term><listitem><para>Add form</para></listitem></varlistentry> + <varlistentry><term>setform</term><listitem><para>Set form</para></listitem></varlistentry> + <varlistentry><term>getform</term><listitem><para>Get form</para></listitem></varlistentry> + <varlistentry><term>deleteform</term><listitem><para>Delete form</para></listitem></varlistentry> + <varlistentry><term>enumforms</term><listitem><para>Enumerate form</para></listitem></varlistentry> + <varlistentry><term>setprinter</term><listitem><para>Set printer comment</para></listitem></varlistentry> + <varlistentry><term>setprinterdata</term><listitem><para>Set REG_SZ printer data</para></listitem></varlistentry> + <varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry> + + + </variablelist> + + </refsect2> + + <refsect2> + <title>NETLOGON</title> + + <variablelist> + + <varlistentry><term>logonctrl2</term> + <listitem><para>Logon Control 2</para></listitem> + </varlistentry> + + <varlistentry><term>logonctrl</term> + <listitem><para>Logon Control</para></listitem> + </varlistentry> + + <varlistentry><term>samsync</term> + <listitem><para>Sam Synchronisation</para></listitem> + </varlistentry> + + <varlistentry><term>samdeltas</term> + <listitem><para>Query Sam Deltas</para></listitem> + </varlistentry> + + <varlistentry><term>samlogon</term> + <listitem><para>Sam Logon</para></listitem> + </varlistentry> + + </variablelist> + </refsect2> + + <refsect2> + <title>GENERAL COMMANDS</title> + + <variablelist> + <varlistentry><term>debuglevel</term><listitem><para>Set the current + debug level used to log information.</para></listitem></varlistentry> + + <varlistentry><term>help (?)</term><listitem><para>Print a listing of all + known commands or extended help on a particular command. + </para></listitem></varlistentry> + + <varlistentry><term>quit (exit)</term><listitem><para>Exit <command>rpcclient + </command>.</para></listitem></varlistentry> + </variablelist> + </refsect2> + +</refsect1> + +<refsect1> + <title>BUGS</title> + + <para><command>rpcclient</command> is designed as a developer testing tool + and may not be robust in certain areas (such as command line parsing). + It has been known to generate a core dump upon failures when invalid + parameters where passed to the interpreter. </para> + + <para>From Luke Leighton's original rpcclient man page:</para> + + <para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has + been developed from examining Network traces. No documentation is + available from the original creators (Microsoft) on how MSRPC over + SMB works, or how the individual MSRPC services work. Microsoft's + implementation of these services has been demonstrated (and reported) + to be... a bit flaky in places. </para> + + <para>The development of Samba's implementation is also a bit rough, + and as more of the services are understood, it can even result in + versions of <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or services. Additionally, + the developers are sending reports to Microsoft, and problems found + or reported to Microsoft are fixed in Service Packs, which may + result in incompatibilities.</para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original rpcclient man page was written by Matthew + Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. + The conversion to DocBook for Samba 2.2 was done by Gerald + Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was + done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/samba.7.xml b/docs/docbook/manpages/samba.7.xml new file mode 100644 index 0000000000..6abde609b9 --- /dev/null +++ b/docs/docbook/manpages/samba.7.xml @@ -0,0 +1,378 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="samba.7"> + +<refmeta> + <refentrytitle>samba</refentrytitle> + <manvolnum>7</manvolnum> +</refmeta> + + +<refnamediv> + <refname>Samba</refname> + <refpurpose>A Windows SMB/CIFS fileserver for UNIX</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis><command>Samba</command></cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>The Samba software suite is a collection of programs + that implements the Server Message Block (commonly abbreviated + as SMB) protocol for UNIX systems. This protocol is sometimes + also referred to as the Common Internet File System (CIFS). For a + more thorough description, see <ulink url="http://www.ubiqx.org/cifs/"> + http://www.ubiqx.org/cifs/</ulink>. Samba also implements the NetBIOS + protocol in nmbd.</para> + + <variablelist> + <varlistentry> + <term><citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>smbd</command> daemon provides the file and print services to + SMB clients, such as Windows 95/98, Windows NT, Windows + for Workgroups or LanManager. The configuration file + for this daemon is described in <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>nmbd</command> + daemon provides NetBIOS nameservice and browsing + support. The configuration file for this daemon + is described in <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry></para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbclient</command> + program implements a simple ftp-like client. This + is useful for accessing SMB shares on other compatible + servers (such as Windows NT), and can also be used + to allow a UNIX box to print to a printer attached to + any SMB server (such as a PC running Windows NT).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>testparm</command> + utility is a simple syntax checker for Samba's <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> configuration file.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>testprns</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>testprns</command> + utility supports testing printer names defined + in your <filename>printcap</filename> file used + by Samba.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbstatus</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbstatus</command> + tool provides access to information about the + current connections to <command>smbd</command>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>nmblookup</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>nmblookup</command> + tools allows NetBIOS name queries to be made + from a UNIX host.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbgroupedit</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>smbgroupedit</command> + tool allows for mapping unix groups to NT Builtin, + Domain, or Local groups. Also it allows setting + priviledges for that group, such as saAddUser, etc.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>smbpasswd</command> + command is a tool for changing LanMan and Windows NT + password hashes on Samba and Windows NT servers.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbcacls</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbcacls</command> command is + a tool to set ACL's on remote CIFS servers. </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbsh</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbsh</command> command is + a program that allows you to run a unix shell with + with an overloaded VFS.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbtree</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbtree</command> command + is a text-based network neighborhood tool.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbtar</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>smbtar</command> can make + backups of data on CIFS/SMB servers.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbspool</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para><command>smbspool</command> is a + helper utility for printing on printers connected + to CIFS servers. </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbcontrol</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>smbcontrol</command> is a utility + that can change the behaviour of running samba daemons. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>rpcclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>rpcclient</command> is a utility + that can be used to execute RPC commands on remote + CIFS servers.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>pdbedit</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>pdbedit</command> command + can be used to maintain the local user database on + a samba server.</para></listitem></varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>findsmb</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para>The <command>findsmb</command> command + can be used to find SMB servers on the local network. + </para></listitem></varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>net</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para>The <command>net</command> command + is supposed to work similar to the DOS/Windows + NET.EXE command.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>swat</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para><command>swat</command> is a web-based + interface to configuring <filename>smb.conf</filename>. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></term> + <listitem><para><command>winbindd</command> is a daemon + that is used for integrating authentication and + the user database into unix.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>wbinfo</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>wbinfo</command> is a utility + that retrieves and stores information related to winbind. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>editreg</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>editreg</command> is a command-line + utility that can edit windows registry files. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>profiles</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>profiles</command> is a command-line + utility that can be used to replace all occurences of + a certain SID with another SID. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>vfstest</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>vfstest</command> is a utility + that can be used to test vfs modules.</para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>ntlm_auth</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>ntlm_auth</command> is a helper-utility + for external programs wanting to do NTLM-authentication. + </para></listitem></varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbmount</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbumount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbmount</refentrytitle><manvolnum>8</manvolnum></citerefentry></term> + <listitem><para><command>smbmount</command>,<command>smbmnt</command> and <command>smbmnt</command> are commands that can be used to + mount CIFS/SMB shares on Linux. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><citerefentry><refentrytitle>smbcquotas</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></term> + <listitem><para><command>smbcquotas</command> is a tool that + can set remote QUOTA's on server with NTFS 5. </para> + </listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>COMPONENTS</title> + + <para>The Samba suite is made up of several components. Each + component is described in a separate manual page. It is strongly + recommended that you read the documentation that comes with Samba + and the manual pages of those components that you use. If the + manual pages and documents aren't clear enough then please visit + <ulink url="http://devel.samba.org/">http://devel.samba.org</ulink> + for information on how to file a bug report or submit a patch.</para> + + <para>If you require help, visit the Samba webpage at + <ulink url="http://samba.org/">http://www.samba.org/</ulink> and + explore the many option available to you. + </para> +</refsect1> + +<refsect1> + <title>AVAILABILITY</title> + + <para>The Samba software suite is licensed under the + GNU Public License(GPL). A copy of that license should + have come with the package in the file COPYING. You are + encouraged to distribute copies of the Samba suite, but + please obey the terms of this license.</para> + + <para>The latest version of the Samba suite can be + obtained via anonymous ftp from samba.org in the + directory pub/samba/. It is also available on several + mirror sites worldwide.</para> + + <para>You may also find useful information about Samba + on the newsgroup <ulink url="news:comp.protocols.smb"> + comp.protocol.smb</ulink> and the Samba mailing + list. Details on how to join the mailing list are given in + the README file that comes with Samba.</para> + + <para>If you have access to a WWW viewer (such as Mozilla + or Konqueror) then you will also find lots of useful information, + including back issues of the Samba mailing list, at + <ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>.</para> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the + Samba suite. </para> +</refsect1> + +<refsect1> + <title>CONTRIBUTIONS</title> + + <para>If you wish to contribute to the Samba project, + then I suggest you join the Samba mailing list at + <ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>. + </para> + + <para>If you have patches to submit, visit + <ulink url="http://devel.samba.org/">http://devel.samba.org/</ulink> + for information on how to do it properly. We prefer patches + in <command>diff -u</command> format.</para> +</refsect1> + +<refsect1> + <title>CONTRIBUTORS</title> + + <para>Contributors to the project are now too numerous + to mention here but all deserve the thanks of all Samba + users. To see a full list, look at <ulink + url="ftp://samba.org/pub/samba/alpha/change-log"> + ftp://samba.org/pub/samba/alpha/change-log</ulink> + for the pre-CVS changes and at <ulink + url="ftp://samba.org/pub/samba/alpha/cvs.log"> + ftp://samba.org/pub/samba/alpha/cvs.log</ulink> + for the contributors to Samba post-CVS. CVS is the Open Source + source code control system used by the Samba Team to develop + Samba. The project would have been unmanageable without it.</para> + + <para>In addition, several commercial organizations now help + fund the Samba Team with money and equipment. For details see + the Samba Web pages at <ulink + url="http://samba.org/samba/samba-thanks.html"> + http://samba.org/samba/samba-thanks.html</ulink>.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML + 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbcacls.1.xml b/docs/docbook/manpages/smbcacls.1.xml new file mode 100644 index 0000000000..ab4fe517eb --- /dev/null +++ b/docs/docbook/manpages/smbcacls.1.xml @@ -0,0 +1,264 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbcacls.1"> + +<refmeta> + <refentrytitle>smbcacls</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbcacls</refname> + <refpurpose>Set or get ACLs on an NT file or directory names</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbcacls</command> + <arg choice="req">//server/share</arg> + <arg choice="req">filename</arg> + <arg choice="opt">-D acls</arg> + <arg choice="opt">-M acls</arg> + <arg choice="opt">-A acls</arg> + <arg choice="opt">-S acls</arg> + <arg choice="opt">-C name</arg> + <arg choice="opt">-G name</arg> + <arg choice="opt">-n</arg> + <arg choice="opt">-t</arg> + <arg choice="opt">-U username</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-d</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>The <command>smbcacls</command> program manipulates NT Access Control + Lists (ACLs) on SMB file shares. </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <para>The following options are available to the <command>smbcacls</command> program. + The format of ACLs is described in the section ACL FORMAT </para> + + + <variablelist> + <varlistentry> + <term>-A acls</term> + <listitem><para>Add the ACLs specified to the ACL list. Existing + access control entries are unchanged. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-M acls</term> + <listitem><para>Modify the mask value (permissions) for the ACLs + specified on the command line. An error will be printed for each + ACL specified that was not already present in the ACL list + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-D acls</term> + <listitem><para>Delete any ACLs specified on the command line. + An error will be printed for each ACL specified that was not + already present in the ACL list. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-S acls</term> + <listitem><para>This command sets the ACLs on the file with + only the ones specified on the command line. All other ACLs are + erased. Note that the ACL specified must contain at least a revision, + type, owner and group for the call to succeed. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-U username</term> + <listitem><para>Specifies a username used to connect to the + specified service. The username may be of the form "username" in + which case the user is prompted to enter in a password and the + workgroup specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file is + used, or "username%password" or "DOMAIN\username%password" and the + password and workgroup names are used as provided. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-C name</term> + <listitem><para>The owner of a file or directory can be changed + to the name given using the <parameter>-C</parameter> option. + The name can be a sid in the form S-1-x-y-z or a name resolved + against the server specified in the first argument. </para> + + <para>This command is a shortcut for -M OWNER:name. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-G name</term> + <listitem><para>The group owner of a file or directory can + be changed to the name given using the <parameter>-G</parameter> + option. The name can be a sid in the form S-1-x-y-z or a name + resolved against the server specified n the first argument. + </para> + + <para>This command is a shortcut for -M GROUP:name.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-n</term> + <listitem><para>This option displays all ACL information in numeric + format. The default is to convert SIDs to names and ACE types + and masks to a readable string format. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-t</term> + <listitem><para> + Don't actually do anything, only validate the correctness of + the arguments. + </para></listitem> + </varlistentry> + + &stdarg.help; + &popt.common.samba; + </variablelist> +</refsect1> + + +<refsect1> + <title>ACL FORMAT</title> + + <para>The format of an ACL is one or more ACL entries separated by + either commas or newlines. An ACL entry is one of the following: </para> + +<para><programlisting> +REVISION:<revision number> +OWNER:<sid or name> +GROUP:<sid or name> +ACL:<sid or name>:<type>/<flags>/<mask> +</programlisting></para> + + + <para>The revision of the ACL specifies the internal Windows + NT ACL revision for the security descriptor. + If not specified it defaults to 1. Using values other than 1 may + cause strange behaviour. </para> + + <para>The owner and group specify the owner and group sids for the + object. If a SID in the format CWS-1-x-y-z is specified this is used, + otherwise the name specified is resolved using the server on which + the file or directory resides. </para> + + <para>ACLs specify permissions granted to the SID. This SID again + can be specified in CWS-1-x-y-z format or as a name in which case + it is resolved against the server on which the file or directory + resides. The type, flags and mask values determine the type of + access granted to the SID. </para> + + <para>The type can be either 0 or 1 corresponding to ALLOWED or + DENIED access to the SID. The flags values are generally + zero for file ACLs and either 9 or 2 for directory ACLs. Some + common flags are: </para> + + <itemizedlist> + <listitem><para><constant>#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1</constant></para></listitem> + <listitem><para><constant>#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2</constant></para></listitem> + <listitem><para><constant>#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4</constant></para></listitem> + <listitem><para><constant>#define SEC_ACE_FLAG_INHERIT_ONLY 0x8</constant></para></listitem> + </itemizedlist> + + <para>At present flags can only be specified as decimal or + hexadecimal values.</para> + + <para>The mask is a value which expresses the access right + granted to the SID. It can be given as a decimal or hexadecimal value, + or by using one of the following text strings which map to the NT + file permissions of the same name. </para> + + <itemizedlist> + <listitem><para><emphasis>R</emphasis> - Allow read access </para></listitem> + <listitem><para><emphasis>W</emphasis> - Allow write access</para></listitem> + <listitem><para><emphasis>X</emphasis> - Execute permission on the object</para></listitem> + <listitem><para><emphasis>D</emphasis> - Delete the object</para></listitem> + <listitem><para><emphasis>P</emphasis> - Change permissions</para></listitem> + <listitem><para><emphasis>O</emphasis> - Take ownership</para></listitem> + </itemizedlist> + + + <para>The following combined permissions can be specified:</para> + + + <itemizedlist> + <listitem><para><emphasis>READ</emphasis> - Equivalent to 'RX' + permissions</para></listitem> + <listitem><para><emphasis>CHANGE</emphasis> - Equivalent to 'RXWD' permissions + </para></listitem> + <listitem><para><emphasis>FULL</emphasis> - Equivalent to 'RWXDPO' + permissions</para></listitem> + </itemizedlist> + </refsect1> + +<refsect1> + <title>EXIT STATUS</title> + + <para>The <command>smbcacls</command> program sets the exit status + depending on the success or otherwise of the operations performed. + The exit status may be one of the following values. </para> + + <para>If the operation succeeded, smbcacls returns and exit + status of 0. If <command>smbcacls</command> couldn't connect to the specified server, + or there was an error getting or setting the ACLs, an exit status + of 1 is returned. If there was an error parsing any command line + arguments, an exit status of 2 is returned. </para> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para><command>smbcacls</command> was written by Andrew Tridgell + and Tim Potter.</para> + + <para>The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done + by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbclient.1.xml b/docs/docbook/manpages/smbclient.1.xml new file mode 100644 index 0000000000..8e52e878dd --- /dev/null +++ b/docs/docbook/manpages/smbclient.1.xml @@ -0,0 +1,958 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbclient.1"> + +<refmeta> + <refentrytitle>smbclient</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbclient</refname> + <refpurpose>ftp-like client to access SMB/CIFS resources + on servers</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbclient</command> + <arg choice="req">servicename</arg> + <arg choice="opt">password</arg> + <arg choice="opt">-b <buffer size></arg> + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-D Directory</arg> + <arg choice="opt">-U username</arg> + <arg choice="opt">-W workgroup</arg> + <arg choice="opt">-M <netbios name></arg> + <arg choice="opt">-m maxprotocol</arg> + <arg choice="opt">-A authfile</arg> + <arg choice="opt">-N</arg> + <arg choice="opt">-l logfile</arg> + <arg choice="opt">-L <netbios name></arg> + <arg choice="opt">-I destinationIP</arg> + <arg choice="opt">-E</arg> + <arg choice="opt">-c <command string></arg> + <arg choice="opt">-i scope</arg> + <arg choice="opt">-O <socket options></arg> + <arg choice="opt">-p port</arg> + <arg choice="opt">-R <name resolve order></arg> + <arg choice="opt">-s <smb config file></arg> + <arg choice="opt">-T<c|x>IXFqgbNan</arg> + <arg choice="opt">-k</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>smbclient</command> is a client that can + 'talk' to an SMB/CIFS server. It offers an interface + similar to that of the ftp program (see <citerefentry><refentrytitle>ftp</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>). + Operations include things like getting files from the server + to the local machine, putting files from the local machine to + the server, retrieving directory information from the server + and so on. </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>servicename</term> + <listitem><para>servicename is the name of the service + you want to use on the server. A service name takes the form + <filename>//server/service</filename> where <parameter>server + </parameter> is the NetBIOS name of the SMB/CIFS server + offering the desired service and <parameter>service</parameter> + is the name of the service offered. Thus to connect to + the service "printer" on the SMB/CIFS server "smbserver", + you would use the servicename <filename>//smbserver/printer + </filename></para> + + <para>Note that the server name required is NOT necessarily + the IP (DNS) host name of the server ! The name required is + a NetBIOS server name, which may or may not be the + same as the IP hostname of the machine running the server. + </para> + + <para>The server name is looked up according to either + the <parameter>-R</parameter> parameter to <command>smbclient</command> or + using the name resolve order parameter in + the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file, + allowing an administrator to change the order and methods + by which server names are looked up. </para></listitem> + </varlistentry> + + <varlistentry> + <term>password</term> + <listitem><para>The password required to access the specified + service on the specified server. If this parameter is + supplied, the <parameter>-N</parameter> option (suppress + password prompt) is assumed. </para> + + <para>There is no default password. If no password is supplied + on the command line (either by using this parameter or adding + a password to the <parameter>-U</parameter> option (see + below)) and the <parameter>-N</parameter> option is not + specified, the client will prompt for a password, even if + the desired service does not require one. (If no password is + required, simply press ENTER to provide a null password.) + </para> + + <para>Note: Some servers (including OS/2 and Windows for + Workgroups) insist on an uppercase password. Lowercase + or mixed case passwords may be rejected by these servers. + </para> + + <para>Be cautious about including passwords in scripts. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-R <name resolve order></term> + <listitem><para>This option is used by the programs in the Samba + suite to determine what naming services and in what order to resolve + host names to IP addresses. The option takes a space-separated + string of different name resolution options.</para> + + <para>The options are :"lmhosts", "host", "wins" and "bcast". They + cause names to be resolved as follows:</para> + + <itemizedlist> + <listitem><para><constant>lmhosts</constant>: Lookup an IP + address in the Samba lmhosts file. If the line in lmhosts has + no name type attached to the NetBIOS name (see + the <citerefentry><refentrytitle>lmhosts</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for details) then + any name type matches for lookup.</para> + </listitem> + + <listitem><para><constant>host</constant>: Do a standard host + name to IP address resolution, using the system <filename>/etc/hosts + </filename>, NIS, or DNS lookups. This method of name resolution + is operating system dependent, for instance on IRIX or Solaris this + may be controlled by the <filename>/etc/nsswitch.conf</filename> + file). Note that this method is only used if the NetBIOS name + type being queried is the 0x20 (server) name type, otherwise + it is ignored.</para> + </listitem> + + <listitem><para><constant>wins</constant>: Query a name with + the IP address listed in the <parameter>wins server</parameter> + parameter. If no WINS server has + been specified this method will be ignored.</para> + </listitem> + + <listitem><para><constant>bcast</constant>: Do a broadcast on + each of the known local interfaces listed in the + <parameter>interfaces</parameter> + parameter. This is the least reliable of the name resolution + methods as it depends on the target host being on a locally + connected subnet.</para> + </listitem> + </itemizedlist> + + <para>If this parameter is not set then the name resolve order + defined in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file parameter + (name resolve order) will be used. </para> + + <para>The default order is lmhosts, host, wins, bcast and without + this parameter or any entry in the <parameter>name resolve order + </parameter> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file the name resolution + methods will be attempted in this order. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-M NetBIOS name</term> + <listitem><para>This options allows you to send messages, using + the "WinPopup" protocol, to another computer. Once a connection is + established you then type your message, pressing ^D (control-D) to + end. </para> + + <para>If the receiving computer is running WinPopup the user will + receive the message and probably a beep. If they are not running + WinPopup the message will be lost, and no error message will + occur. </para> + + <para>The message is also automatically truncated if the message + is over 1600 bytes, as this is the limit of the protocol. + </para> + + <para>One useful trick is to cat the message through + <command>smbclient</command>. For example: <command> + cat mymessage.txt | smbclient -M FRED </command> will + send the message in the file <filename>mymessage.txt</filename> + to the machine FRED. </para> + + <para>You may also find the <parameter>-U</parameter> and + <parameter>-I</parameter> options useful, as they allow you to + control the FROM and TO parts of the message. </para> + + <para>See the <parameter>message command</parameter> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for a description of how to handle incoming + WinPopup messages in Samba. </para> + + <para><emphasis>Note</emphasis>: Copy WinPopup into the startup group + on your WfWg PCs if you want them to always be able to receive + messages. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-p port</term> + <listitem><para>This number is the TCP port number that will be used + when making connections to the server. The standard (well-known) + TCP port number for an SMB/CIFS server is 139, which is the + default. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-l logfilename</term> + <listitem><para>If specified, <replaceable>logfilename</replaceable> specifies a base filename + into which operational data from the running client will be + logged. </para> + + <para>The default base name is specified at compile time.</para> + + <para>The base name is used to generate actual log file names. + For example, if the name specified was "log", the debug file + would be <filename>log.client</filename>.</para> + + <para>The log file generated is never removed by the client. + </para></listitem> + </varlistentry> + + + &stdarg.help; + + <varlistentry> + <term>-I IP-address</term> + <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to. + It should be specified in standard "a.b.c.d" notation. </para> + + <para>Normally the client would attempt to locate a named + SMB/CIFS server by looking it up via the NetBIOS name resolution + mechanism described above in the <parameter>name resolve order</parameter> + parameter above. Using this parameter will force the client + to assume that the server is on the machine with the specified IP + address and the NetBIOS name component of the resource being + connected to will be ignored. </para> + + <para>There is no default for this parameter. If not supplied, + it will be determined automatically by the client as described + above. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-E</term> + <listitem><para>This parameter causes the client to write messages + to the standard error stream (stderr) rather than to the standard + output stream. </para> + + <para>By default, the client writes messages to standard output + - typically the user's tty. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-L</term> + <listitem><para>This option allows you to look at what services + are available on a server. You use it as <command>smbclient -L + host</command> and a list should appear. The <parameter>-I + </parameter> option may be useful if your NetBIOS names don't + match your TCP/IP DNS host names or if you are trying to reach a + host on another network. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-t terminal code</term> + <listitem><para>This option tells <command>smbclient</command> how to interpret + filenames coming from the remote server. Usually Asian language + multibyte UNIX implementations use different character sets than + SMB/CIFS servers (<emphasis>EUC</emphasis> instead of <emphasis> + SJIS</emphasis> for example). Setting this parameter will let + <command>smbclient</command> convert between the UNIX filenames and + the SMB filenames correctly. This option has not been seriously tested + and may have some problems. </para> + + <para>The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8, + CWjunet, CWhex, CWcap. This is not a complete list, check the Samba + source code for the complete list. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-b buffersize</term> + <listitem><para>This option changes the transmit/send buffer + size when getting or putting a file from/to the server. The default + is 65520 bytes. Setting this value smaller (to 1200 bytes) has been + observed to speed up file transfers to and from a Win9x server. + </para></listitem> + </varlistentry> + + &popt.common.samba; + &popt.common.credentials; + &popt.common.connection; + + <varlistentry> + <term>-T tar options</term> + <listitem><para>smbclient may be used to create <command>tar(1) + </command> compatible backups of all the files on an SMB/CIFS + share. The secondary tar flags that can be given to this option + are : </para> + + <itemizedlist> + <listitem><para><parameter>c</parameter> - Create a tar file on UNIX. + Must be followed by the name of a tar file, tape device + or "-" for standard output. If using standard output you must + turn the log level to its lowest value -d0 to avoid corrupting + your tar file. This flag is mutually exclusive with the + <parameter>x</parameter> flag. </para></listitem> + + <listitem><para><parameter>x</parameter> - Extract (restore) a local + tar file back to a share. Unless the -D option is given, the tar + files will be restored from the top level of the share. Must be + followed by the name of the tar file, device or "-" for standard + input. Mutually exclusive with the <parameter>c</parameter> flag. + Restored files have their creation times (mtime) set to the + date saved in the tar file. Directories currently do not get + their creation dates restored properly. </para></listitem> + + <listitem><para><parameter>I</parameter> - Include files and directories. + Is the default behavior when filenames are specified above. Causes + tar files to be included in an extract or create (and therefore + everything else to be excluded). See example below. Filename globbing + works in one of two ways. See r below. </para></listitem> + + <listitem><para><parameter>X</parameter> - Exclude files and directories. + Causes tar files to be excluded from an extract or create. See + example below. Filename globbing works in one of two ways now. + See <parameter>r</parameter> below. </para></listitem> + + <listitem><para><parameter>b</parameter> - Blocksize. Must be followed + by a valid (greater than zero) blocksize. Causes tar file to be + written out in blocksize*TBLOCK (usually 512 byte) blocks. + </para></listitem> + + <listitem><para><parameter>g</parameter> - Incremental. Only back up + files that have the archive bit set. Useful only with the + <parameter>c</parameter> flag. </para></listitem> + + <listitem><para><parameter>q</parameter> - Quiet. Keeps tar from printing + diagnostics as it works. This is the same as tarmode quiet. + </para></listitem> + + <listitem><para><parameter>r</parameter> - Regular expression include + or exclude. Uses regular expression matching for + excluding or excluding files if compiled with HAVE_REGEX_H. + However this mode can be very slow. If not compiled with + HAVE_REGEX_H, does a limited wildcard match on '*' and '?'. + </para></listitem> + + <listitem><para><parameter>N</parameter> - Newer than. Must be followed + by the name of a file whose date is compared against files found + on the share during a create. Only files newer than the file + specified are backed up to the tar file. Useful only with the + <parameter>c</parameter> flag. </para></listitem> + + <listitem><para><parameter>a</parameter> - Set archive bit. Causes the + archive bit to be reset when a file is backed up. Useful with the + <parameter>g</parameter> and <parameter>c</parameter> flags. + </para></listitem> + </itemizedlist> + + <para><emphasis>Tar Long File Names</emphasis></para> + + <para><command>smbclient</command>'s tar option now supports long + file names both on backup and restore. However, the full path + name of the file must be less than 1024 bytes. Also, when + a tar archive is created, <command>smbclient</command>'s tar option places all + files in the archive with relative names, not absolute names. + </para> + + <para><emphasis>Tar Filenames</emphasis></para> + + <para>All file names can be given as DOS path names (with '\\' + as the component separator) or as UNIX path names (with '/' as + the component separator). </para> + + <para><emphasis>Examples</emphasis></para> + + <para>Restore from tar file <filename>backup.tar</filename> into myshare on mypc + (no password on share). </para> + + <para><command>smbclient //mypc/yshare "" -N -Tx backup.tar + </command></para> + + <para>Restore everything except <filename>users/docs</filename> + </para> + + <para><command>smbclient //mypc/myshare "" -N -TXx backup.tar + users/docs</command></para> + + <para>Create a tar file of the files beneath <filename> + users/docs</filename>. </para> + + <para><command>smbclient //mypc/myshare "" -N -Tc + backup.tar users/docs </command></para> + + <para>Create the same tar file as above, but now use + a DOS path name. </para> + + <para><command>smbclient //mypc/myshare "" -N -tc backup.tar + users\edocs </command></para> + + <para>Create a tar file of all the files and directories in + the share. </para> + + <para><command>smbclient //mypc/myshare "" -N -Tc backup.tar * + </command></para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-D initial directory</term> + <listitem><para>Change to initial directory before starting. Probably + only of any use with the tar -T option. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-c command string</term> + <listitem><para>command string is a semicolon-separated list of + commands to be executed instead of prompting from stdin. <parameter> + -N</parameter> is implied by <parameter>-c</parameter>.</para> + + <para>This is particularly useful in scripts and for printing stdin + to the server, e.g. <command>-c 'print -'</command>. </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>OPERATIONS</title> + + <para>Once the client is running, the user is presented with + a prompt : </para> + + <para><prompt>smb:\> </prompt></para> + + <para>The backslash ("\\") indicates the current working directory + on the server, and will change if the current working directory + is changed. </para> + + <para>The prompt indicates that the client is ready and waiting to + carry out a user command. Each command is a single word, optionally + followed by parameters specific to that command. Command and parameters + are space-delimited unless these notes specifically + state otherwise. All commands are case-insensitive. Parameters to + commands may or may not be case sensitive, depending on the command. + </para> + + <para>You can specify file names which have spaces in them by quoting + the name with double quotes, for example "a long file name". </para> + + <para>Parameters shown in square brackets (e.g., "[parameter]") are + optional. If not given, the command will use suitable defaults. Parameters + shown in angle brackets (e.g., "<parameter>") are required. + </para> + + + <para>Note that all commands operating on the server are actually + performed by issuing a request to the server. Thus the behavior may + vary from server to server, depending on how the server was implemented. + </para> + + <para>The commands available are given here in alphabetical order. </para> + + <variablelist> + <varlistentry> + <term>? [command]</term> + <listitem><para>If <replaceable>command</replaceable> is specified, the ? command will display + a brief informative message about the specified command. If no + command is specified, a list of available commands will + be displayed. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>! [shell command]</term> + <listitem><para>If <replaceable>shell command</replaceable> is specified, the ! + command will execute a shell locally and run the specified shell + command. If no command is specified, a local shell will be run. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>altname file</term> + <listitem><para>The client will request that the server return + the "alternate" name (the 8.3 name) for a file or directory. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>cancel jobid0 [jobid1] ... [jobidN]</term> + <listitem><para>The client will request that the server cancel + the printjobs identified by the given numeric print job ids. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>chmod file mode in octal</term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + change the UNIX permissions to the given octal mode, in standard UNIX format. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>chown file uid gid</term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + change the UNIX user and group ownership to the given decimal values. Note there is + currently no way to remotely look up the UNIX uid and gid values for a given name. + This may be addressed in future versions of the CIFS UNIX extensions. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>cd [directory name]</term> + <listitem><para>If "directory name" is specified, the current + working directory on the server will be changed to the directory + specified. This operation will fail if for any reason the specified + directory is inaccessible. </para> + + <para>If no directory name is specified, the current working + directory on the server will be reported. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>del <mask></term> + <listitem><para>The client will request that the server attempt + to delete all files matching <replaceable>mask</replaceable> from the current working + directory on the server. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>dir <mask></term> + <listitem><para>A list of the files matching <replaceable>mask</replaceable> in the current + working directory on the server will be retrieved from the server + and displayed. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>exit</term> + <listitem><para>Terminate the connection with the server and exit + from the program. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>get <remote file name> [local file name]</term> + <listitem><para>Copy the file called <filename>remote file name</filename> from + the server to the machine running the client. If specified, name + the local copy <filename>local file name</filename>. Note that all transfers in + <command>smbclient</command> are binary. See also the + lowercase command. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>help [command]</term> + <listitem><para>See the ? command above. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>lcd [directory name]</term> + <listitem><para>If <replaceable>directory name</replaceable> is specified, the current + working directory on the local machine will be changed to + the directory specified. This operation will fail if for any + reason the specified directory is inaccessible. </para> + + <para>If no directory name is specified, the name of the + current working directory on the local machine will be reported. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>link source destination</term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + create a hard link between the source and destination files. The source file + must not exist. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>lowercase</term> + <listitem><para>Toggle lowercasing of filenames for the get and + mget commands. </para> + + <para>When lowercasing is toggled ON, local filenames are converted + to lowercase when using the get and mget commands. This is + often useful when copying (say) MSDOS files from a server, because + lowercase filenames are the norm on UNIX systems. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>ls <mask></term> + <listitem><para>See the dir command above. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>mask <mask></term> + <listitem><para>This command allows the user to set up a mask + which will be used during recursive operation of the mget and + mput commands. </para> + + <para>The masks specified to the mget and mput commands act as + filters for directories rather than files when recursion is + toggled ON. </para> + + <para>The mask specified with the mask command is necessary + to filter files within those directories. For example, if the + mask specified in an mget command is "source*" and the mask + specified with the mask command is "*.c" and recursion is + toggled ON, the mget command will retrieve all files matching + "*.c" in all directories below and including all directories + matching "source*" in the current working directory. </para> + + <para>Note that the value for mask defaults to blank (equivalent + to "*") and remains so until the mask command is used to change it. + It retains the most recently specified value indefinitely. To + avoid unexpected results it would be wise to change the value of + mask back to "*" after using the mget or mput commands. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>md <directory name></term> + <listitem><para>See the mkdir command. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>mget <mask></term> + <listitem><para>Copy all files matching <replaceable>mask</replaceable> from the server to + the machine running the client. </para> + + <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive + operation and non-recursive operation - refer to the recurse and + mask commands for more information. Note that all transfers in + <command>smbclient</command> are binary. See also the lowercase command. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>mkdir <directory name></term> + <listitem><para>Create a new directory on the server (user access + privileges permitting) with the specified name. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>mput <mask></term> + <listitem><para>Copy all files matching <replaceable>mask</replaceable> in the current working + directory on the local machine to the current working directory on + the server. </para> + + <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive + operation and non-recursive operation - refer to the recurse and mask + commands for more information. Note that all transfers in <command>smbclient</command> + are binary. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>print <file name></term> + <listitem><para>Print the specified file from the local machine + through a printable service on the server. </para> + + <para>See also the printmode command.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>printmode <graphics or text></term> + <listitem><para>Set the print mode to suit either binary data + (such as graphical information) or text. Subsequent print + commands will use the currently set print mode. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>prompt</term> + <listitem><para>Toggle prompting for filenames during operation + of the mget and mput commands. </para> + + <para>When toggled ON, the user will be prompted to confirm + the transfer of each file during these commands. When toggled + OFF, all specified files will be transferred without prompting. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>put <local file name> [remote file name]</term> + <listitem><para>Copy the file called <filename>local file name</filename> from the + machine running the client to the server. If specified, + name the remote copy <filename>remote file name</filename>. Note that all transfers + in <command>smbclient</command> are binary. See also the lowercase command. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>queue</term> + <listitem><para>Displays the print queue, showing the job id, + name, size and current status. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>quit</term> + <listitem><para>See the exit command. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>rd <directory name></term> + <listitem><para>See the rmdir command. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>recurse</term> + <listitem><para>Toggle directory recursion for the commands mget + and mput. </para> + + <para>When toggled ON, these commands will process all directories + in the source directory (i.e., the directory they are copying + from ) and will recurse into any that match the mask specified + to the command. Only files that match the mask specified using + the mask command will be retrieved. See also the mask command. + </para> + + <para>When recursion is toggled OFF, only files from the current + working directory on the source machine that match the mask specified + to the mget or mput commands will be copied, and any mask specified + using the mask command will be ignored. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>rm <mask></term> + <listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current + working directory on the server. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>rmdir <directory name></term> + <listitem><para>Remove the specified directory (user access + privileges permitting) from the server. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>setmode <filename> <perm=[+|\-]rsha></term> + <listitem><para>A version of the DOS attrib command to set + file permissions. For example: </para> + + <para><command>setmode myfile +r </command></para> + + <para>would make myfile read only. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>symlink source destination</term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + create a symbolic hard link between the source and destination files. The source file + must not exist. Note that the server will not create a link to any path that lies + outside the currently connected share. This is enforced by the Samba server. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>tar <c|x>[IXbgNa]</term> + <listitem><para>Performs a tar operation - see the <parameter>-T + </parameter> command line option above. Behavior may be affected + by the tarmode command (see below). Using g (incremental) and N + (newer) will affect tarmode settings. Note that using the "-" option + with tar x may not work - use the command line option instead. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>blocksize <blocksize></term> + <listitem><para>Blocksize. Must be followed by a valid (greater + than zero) blocksize. Causes tar file to be written out in + <replaceable>blocksize</replaceable>*TBLOCK (usually 512 byte) blocks. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>tarmode <full|inc|reset|noreset></term> + <listitem><para>Changes tar's behavior with regard to archive + bits. In full mode, tar will back up everything regardless of the + archive bit setting (this is the default mode). In incremental mode, + tar will only back up files with the archive bit set. In reset mode, + tar will reset the archive bit on all files it backs up (implies + read/write share). </para></listitem> + </varlistentry> + + + </variablelist> +</refsect1> + +<refsect1> + <title>NOTES</title> + + <para>Some servers are fussy about the case of supplied usernames, + passwords, share names (AKA service names) and machine names. + If you fail to connect try giving all parameters in uppercase. + </para> + + <para>It is often necessary to use the -n option when connecting + to some types of servers. For example OS/2 LanManager insists + on a valid NetBIOS name being used, so you need to supply a valid + name that would be known to the server.</para> + + <para>smbclient supports long file names where the server + supports the LANMAN2 protocol or above. </para> +</refsect1> + +<refsect1> + <title>ENVIRONMENT VARIABLES</title> + + <para>The variable <envar>USER</envar> may contain the + username of the person using the client. This information is + used only if the protocol level is high enough to support + session-level passwords.</para> + + + <para>The variable <envar>PASSWD</envar> may contain + the password of the person using the client. This information is + used only if the protocol level is high enough to support + session-level passwords. </para> + + <para>The variable <envar>LIBSMB_PROG</envar> may contain + the path, executed with system(), which the client should connect + to instead of connecting to a server. This functionality is primarily + intended as a development aid, and works best when using a LMHOSTS + file</para> +</refsect1> + + +<refsect1> + <title>INSTALLATION</title> + + <para>The location of the client program is a matter for + individual system administrators. The following are thus + suggestions only. </para> + + <para>It is recommended that the smbclient software be installed + in the <filename>/usr/local/samba/bin/</filename> or <filename> + /usr/samba/bin/</filename> directory, this directory readable + by all, writeable only by root. The client program itself should + be executable by all. The client should <emphasis>NOT</emphasis> be + setuid or setgid! </para> + + <para>The client log files should be put in a directory readable + and writeable only by the user. </para> + + <para>To test the client, you will need to know the name of a + running SMB/CIFS server. It is possible to run <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> as an ordinary user - running that server as a daemon + on a user-accessible port (typically any port number over 1024) + would provide a suitable test server. </para> +</refsect1> + + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>Most diagnostics issued by the client are logged in a + specified log file. The log file name is specified at compile time, + but may be overridden on the command line. </para> + + <para>The number and nature of diagnostics available depends + on the debug level used by the client. If you have problems, + set the debug level to 3 and peruse the log files. </para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 2.2 of the Samba suite.</para> +</refsect1> + + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbcontrol.1.xml b/docs/docbook/manpages/smbcontrol.1.xml new file mode 100644 index 0000000000..a0fda2b315 --- /dev/null +++ b/docs/docbook/manpages/smbcontrol.1.xml @@ -0,0 +1,291 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbcontrol.1"> + +<refmeta> + <refentrytitle>smbcontrol</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbcontrol</refname> + <refpurpose>send messages to smbd, nmbd or winbindd processes</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbcontrol</command> + <arg>-i</arg> + <arg>-s</arg> + </cmdsynopsis> + + <cmdsynopsis> + <command>smbcontrol</command> + <arg>destination</arg> + <arg>message-type</arg> + <arg>parameter</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>smbcontrol</command> is a very small program, which + sends messages to a <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, a <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, or a <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon running on the system.</para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + &stdarg.help; + &stdarg.configfile; + <varlistentry> + <term>-i</term> + <listitem><para>Run interactively. Individual commands + of the form destination message-type parameters can be entered + on STDIN. An empty command line or a "q" will quit the + program.</para></listitem> + </varlistentry> + + <varlistentry> + <term>destination</term> + <listitem><para>One of <parameter>nmbd</parameter>, <parameter>smbd</parameter> or a process ID.</para> + + <para>The <parameter>smbd</parameter> destination causes the + message to "broadcast" to all smbd daemons.</para> + + <para>The <parameter>nmbd</parameter> destination causes the + message to be sent to the nmbd daemon specified in the + <filename>nmbd.pid</filename> file.</para> + + <para>If a single process ID is given, the message is sent + to only that process.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>message-type</term> + <listitem><para>Type of message to send. See + the section <constant>MESSAGE-TYPES</constant> for details. + </para></listitem></varlistentry> + + + + <varlistentry> + <term>parameters</term> + <listitem><para>any parameters required for the message-type</para> + </listitem> + </varlistentry> + </variablelist> + +</refsect1> + +<refsect1> + <title>MESSAGE-TYPES</title> + + <para>Available message types are:</para> + + <variablelist> + <varlistentry><term>close-share</term> + <listitem><para>Order smbd to close the client + connections to the named share. Note that this doesn't affect client + connections to any other shares. This message-type takes an argument of the + share name for which client connections will be closed, or the + "*" character which will close all currently open shares. + This may be useful if you made changes to the access controls on the share. + This message can only be sent to <constant>smbd</constant>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>debug</term> + <listitem><para>Set debug level to the value specified by the + parameter. This can be sent to any of the destinations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>force-election</term> + <listitem><para>This message causes the <command>nmbd</command> daemon to + force a new browse master election. </para> + </listitem></varlistentry> + + <varlistentry> + <term>ping</term> + <listitem><para> + Send specified number of "ping" messages and + wait for the same number of reply "pong" messages. This can be sent to + any of the destinations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>profile</term> + <listitem><para>Change profile settings of a daemon, based on the + parameter. The parameter can be "on" to turn on profile stats + collection, "off" to turn off profile stats collection, "count" + to enable only collection of count stats (time stats are + disabled), and "flush" to zero the current profile stats. This can + be sent to any smbd or nmbd destinations.</para> + </listitem></varlistentry> + + <varlistentry> + <term>debuglevel</term> + <listitem><para> + Request debuglevel of a certain daemon and write it to stdout. This + can be sent to any of the destinations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>profilelevel</term> + <listitem><para> + Request profilelevel of a certain daemon and write it to stdout. + This can be sent to any smbd or nmbd destinations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>printnotify</term> + <listitem><para> + Order smbd to send a printer notify message to any Windows NT clients + connected to a printer. This message-type takes the following arguments: + </para> + + <variablelist> + + <varlistentry> + <term>queuepause printername</term> + <listitem><para>Send a queue pause change notify + message to the printer specified.</para></listitem> + </varlistentry> + + <varlistentry> + <term>queueresume printername</term> + <listitem><para>Send a queue resume change notify + message for the printer specified.</para></listitem> + </varlistentry> + + <varlistentry> + <term>jobpause printername unixjobid</term> + <listitem><para>Send a job pause change notify + message for the printer and unix jobid + specified.</para></listitem> + </varlistentry> + + <varlistentry> + <term>jobresume printername unixjobid</term> + <listitem><para>Send a job resume change notify + message for the printer and unix jobid + specified.</para></listitem> + </varlistentry> + + <varlistentry> + <term>jobdelete printername unixjobid</term> + <listitem><para>Send a job delete change notify + message for the printer and unix jobid + specified.</para></listitem> + </varlistentry> + </variablelist> + + <para> + Note that this message only sends notification that an + event has occured. It doesn't actually cause the + event to happen. + </para> + + <para>This message can only be sent to <constant>smbd</constant>. </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>samsync</term> + <listitem><para>Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to <constant>smbd</constant>. </para> + <note><para>Not working at the moment</para></note> + </listitem> + </varlistentry> + + <varlistentry> + <term>samrepl</term> + <listitem><para>Send sam replication message, with specified serial. Can only be sent to <constant>smbd</constant>. Should not be used manually.</para></listitem> + </varlistentry> + + <varlistentry> + <term>dmalloc-mark</term> + <listitem><para>Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem> + </varlistentry> + + <varlistentry> + <term>dmalloc-log-changed</term> + <listitem><para> + Dump the pointers that have changed since the mark set by dmalloc-mark. + Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem> + </varlistentry> + + <varlistentry> + <term>shutdown</term> + <listitem><para>Shut down specified daemon. Can be sent to both smbd and nmbd.</para></listitem> + </varlistentry> + + <varlistentry> + <term>pool-usage</term> + <listitem><para>Print a human-readable description of all + talloc(pool) memory usage by the specified daemon/process. Available + for both smbd and nmbd.</para></listitem> + </varlistentry> + + <varlistentry> + <term>drvupgrade</term> + <listitem><para>Force clients of printers using specified driver + to update their local version of the driver. Can only be + sent to smbd.</para></listitem> + </varlistentry> + +</variablelist> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbcquotas.1.xml b/docs/docbook/manpages/smbcquotas.1.xml new file mode 100644 index 0000000000..90166beaf1 --- /dev/null +++ b/docs/docbook/manpages/smbcquotas.1.xml @@ -0,0 +1,183 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbcquotas.1"> + +<refmeta> + <refentrytitle>smbcquotas</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbcquotas</refname> + <refpurpose>Set or get QUOTAs of NTFS 5 shares</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbcquotas</command> + <arg choice="req">//server/share</arg> + <arg choice="opt">-u user</arg> + <arg choice="opt">-L</arg> + <arg choice="opt">-F</arg> + <arg choice="opt">-S QUOTA_SET_COMMAND</arg> + <arg choice="opt">-n</arg> + <arg choice="opt">-t</arg> + <arg choice="opt">-v</arg> + + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-s configfile</arg> + <arg choice="opt">-l logfilebase</arg> + <arg choice="opt">-V</arg> + + <arg choice="opt">-U username</arg> + <arg choice="opt">-N</arg> + <arg choice="opt">-k</arg> + <arg choice="opt">-A</arg> + + + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>The <command>smbcquotas</command> program manipulates NT Quotas on SMB file shares. </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <para>The following options are available to the <command>smbcquotas</command> program. </para> + + + <variablelist> + <varlistentry> + <term>-u user</term> + <listitem><para> Specifies the user of whom the quotas are get or set. + By default the current user's username will be used.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-L</term> + <listitem><para>Lists all quota records of the share.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-F</term> + <listitem><para>Show the share quota status and default limits.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-S QUOTA_SET_COMMAND</term> + <listitem><para>This command set/modify quotas for a user or on the share, + depending on the QUOTA_SET_COMMAND parameter witch is described later</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-n</term> + <listitem><para>This option displays all QUOTA information in numeric + format. The default is to convert SIDs to names and QUOTA limits + to a readable string format. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-t</term> + <listitem><para> + Don't actually do anything, only validate the correctness of + the arguments. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-v</term> + <listitem><para> + Be verbose. + </para></listitem> + </varlistentry> + + &stdarg.help; + &popt.common.samba; + &popt.common.credentials; + </variablelist> +</refsect1> + + +<refsect1> + <title>QUOTA_SET_COMAND</title> + + <para>The format of an ACL is one or more ACL entries separated by + either commas or newlines. An ACL entry is one of the following: </para> + + <para> + for user setting quotas for the specified by -u or the current username: + </para> + + <para><userinput> + UQLIM:<username><softlimit><hardlimit> + </userinput></para> + + <para> + for setting the share quota defaults limits: + </para> + + <para><userinput> + FSQLIM:<softlimit><hardlimit> + </userinput></para> + + <para> + for changing the share quota settings: + </para> + + <para><userinput> + FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT + </userinput></para> +</refsect1> + +<refsect1> + <title>EXIT STATUS</title> + + <para>The <command>smbcquotas</command> program sets the exit status + depending on the success or otherwise of the operations performed. + The exit status may be one of the following values. </para> + + <para>If the operation succeeded, smbcquotas returns an exit + status of 0. If <command>smbcquotas</command> couldn't connect to the specified server, + or when there was an error getting or setting the quota(s), an exit status + of 1 is returned. If there was an error parsing any command line + arguments, an exit status of 2 is returned. </para> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para><command>smbcacls</command> was written by Stefan Metzmacher.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbd.8.xml b/docs/docbook/manpages/smbd.8.xml new file mode 100644 index 0000000000..0566c67fcb --- /dev/null +++ b/docs/docbook/manpages/smbd.8.xml @@ -0,0 +1,376 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbd.8"> + +<refmeta> + <refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbd</refname> + <refpurpose>server to provide SMB/CIFS services to clients</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbd</command> + <arg choice="opt">-D</arg> + <arg choice="opt">-F</arg> + <arg choice="opt">-S</arg> + <arg choice="opt">-i</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-V</arg> + <arg choice="opt">-b</arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-l <log directory></arg> + <arg choice="opt">-p <port number></arg> + <arg choice="opt">-O <socket option></arg> + <arg choice="opt">-s <configuration file></arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + <para>This program is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>smbd</command> is the server daemon that + provides filesharing and printing services to Windows clients. + The server provides filespace and printer services to + clients using the SMB (or CIFS) protocol. This is compatible + with the LanManager protocol, and can service LanManager + clients. These include MSCLIENT 3.0 for DOS, Windows for + Workgroups, Windows 95/98/ME, Windows NT, Windows 2000, + OS/2, DAVE for Macintosh, and smbfs for Linux.</para> + + <para>An extensive description of the services that the + server can provide is given in the man page for the + configuration file controlling the attributes of those + services (see <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>. This man page will not describe the + services, but will concentrate on the administrative aspects + of running the server.</para> + + <para>Please note that there are significant security + implications to running this server, and the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> manual page should be regarded as mandatory reading before + proceeding with installation.</para> + + <para>A session is created whenever a client requests one. + Each client gets a copy of the server for each session. This + copy then services all connections made by the client during + that session. When all connections from its client are closed, + the copy of the server for that client terminates.</para> + + <para>The configuration file, and any files that it includes, + are automatically reloaded every minute, if they change. You + can force a reload by sending a SIGHUP to the server. Reloading + the configuration file will not affect connections to any service + that is already established. Either the user will have to + disconnect from the service, or <command>smbd</command> killed and restarted.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-D</term> + <listitem><para>If specified, this parameter causes + the server to operate as a daemon. That is, it detaches + itself and runs in the background, fielding requests + on the appropriate port. Operating the server as a + daemon is the recommended way of running <command>smbd</command> for + servers that provide more than casual use file and + print services. This switch is assumed if <command>smbd + </command> is executed on the command line of a shell. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-F</term> + <listitem><para>If specified, this parameter causes + the main <command>smbd</command> process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + <command>smbd</command> under process supervisors such + as <command>supervise</command> and <command>svscan</command> + from Daniel J. Bernstein's <command>daemontools</command> + package, or the AIX process monitor. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-S</term> + <listitem><para>If specified, this parameter causes + <command>smbd</command> to log to standard output rather + than a file.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-i</term> + <listitem><para>If this parameter is specified it causes the + server to run "interactively", not as a daemon, even if the + server is executed on the command line of a shell. Setting this + parameter negates the implicit deamon mode when run from the + command line. <command>smbd</command> also logs to standard + output, as if the <command>-S</command> parameter had been + given. + </para></listitem> + </varlistentry> + + &popt.common.samba; + &stdarg.help; + + <varlistentry> + <term>-b</term> + <listitem><para>Prints information about how + Samba was built.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-l <log directory></term> + <listitem><para>If specified, + <replaceable>log directory</replaceable> + specifies a log directory into which the "log.smbd" log + file will be created for informational and debug + messages from the running server. The log + file generated is never removed by the server although + its size may be controlled by the <ulink + url="smb.conf.5.html#maxlogsize"><parameter>max log size</parameter></ulink> + option in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file. <emphasis>Beware:</emphasis> + If the directory specified does not exist, <command>smbd</command> + will log to the default debug log location defined at compile time. + </para> + + <para>The default log directory is specified at + compile time.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-p <port number></term> + <listitem><para><replaceable>port number</replaceable> is a positive integer + value. The default value if this parameter is not + specified is 139.</para> + + <para>This number is the port number that will be + used when making connections to the server from client + software. The standard (well-known) port number for the + SMB over TCP is 139, hence the default. If you wish to + run the server as an ordinary user rather than + as root, most systems will require you to use a port + number greater than 1024 - ask your system administrator + for help if you are in this situation.</para> + + <para>In order for the server to be useful by most + clients, should you configure it on a port other + than 139, you will require port redirection services + on port 139, details of which are outlined in rfc1002.txt + section 4.3.5.</para> + + <para>This parameter is not normally specified except + in the above situation.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>/etc/inetd.conf</filename></term> + <listitem><para>If the server is to be run by the + <command>inetd</command> meta-daemon, this file + must contain suitable startup information for the + meta-daemon. See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink> + document for details. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/etc/rc</filename></term> + <listitem><para>or whatever initialization script your + system uses).</para> + + <para>If running the server as a daemon at startup, + this file will need to contain an appropriate startup + sequence for the server. See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink> + document for details.</para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/etc/services</filename></term> + <listitem><para>If running the server via the + meta-daemon <command>inetd</command>, this file + must contain a mapping of service name (e.g., netbios-ssn) + to service port (e.g., 139) and protocol type (e.g., tcp). + See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink> + document for details.</para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/usr/local/samba/lib/smb.conf</filename></term> + <listitem><para>This is the default location of the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> server configuration file. Other common places that systems + install this file are <filename>/usr/samba/lib/smb.conf</filename> + and <filename>/etc/samba/smb.conf</filename>.</para> + + <para>This file describes all the services the server + is to make available to clients. See <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for more information.</para> + </listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>LIMITATIONS</title> + <para>On some systems <command>smbd</command> cannot change uid back + to root after a setuid() call. Such systems are called + trapdoor uid systems. If you have such a system, + you will be unable to connect from a client (such as a PC) as + two different users at once. Attempts to connect the + second user will result in access denied or + similar.</para> +</refsect1> + +<refsect1> + <title>ENVIRONMENT VARIABLES</title> + + <variablelist> + <varlistentry> + <term><envar>PRINTER</envar></term> + <listitem><para>If no printer name is specified to + printable services, most systems will use the value of + this variable (or <constant>lp</constant> if this variable is + not defined) as the name of the printer to use. This + is not specific to the server, however.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>PAM INTERACTION</title> + <para>Samba uses PAM for authentication (when presented with a plaintext + password), for account checking (is this account disabled?) and for + session management. The degree too which samba supports PAM is restricted + by the limitations of the SMB protocol and the <ulink url="smb.conf.5.html#OBEYPAMRESRICTIONS"><parameter>obey + pam restricions</parameter></ulink> <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> paramater. When this is set, the following restrictions apply: + </para> + + <itemizedlist> + <listitem><para><emphasis>Account Validation</emphasis>: All accesses to a + samba server are checked + against PAM to see if the account is vaild, not disabled and is permitted to + login at this time. This also applies to encrypted logins. + </para></listitem> + + <listitem><para><emphasis>Session Management</emphasis>: When not using share + level secuirty, users must pass PAM's session checks before access + is granted. Note however, that this is bypassed in share level secuirty. + Note also that some older pam configuration files may need a line + added for session support. + </para></listitem> + </itemizedlist> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>Most diagnostics issued by the server are logged + in a specified log file. The log file name is specified + at compile time, but may be overridden on the command line.</para> + + <para>The number and nature of diagnostics available depends + on the debug level used by the server. If you have problems, set + the debug level to 3 and peruse the log files.</para> + + <para>Most messages are reasonably self-explanatory. Unfortunately, + at the time this man page was created, there are too many diagnostics + available in the source code to warrant describing each and every + diagnostic. At this stage your best bet is still to grep the + source code and inspect the conditions that gave rise to the + diagnostics you are seeing.</para> +</refsect1> + +<refsect1> + <title>SIGNALS</title> + + <para>Sending the <command>smbd</command> a SIGHUP will cause it to + reload its <filename>smb.conf</filename> configuration + file within a short period of time.</para> + + <para>To shut down a user's <command>smbd</command> process it is recommended + that <command>SIGKILL (-9)</command> <emphasis>NOT</emphasis> + be used, except as a last resort, as this may leave the shared + memory area in an inconsistent state. The safe way to terminate + an <command>smbd</command> is to send it a SIGTERM (-15) signal and wait for + it to die on its own.</para> + + <para>The debug log level of <command>smbd</command> may be raised + or lowered using <citerefentry><refentrytitle>smbcontrol</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> program (SIGUSR[1|2] signals are no longer + used since Samba 2.2). This is to allow transient problems to be diagnosed, + whilst still running at a normally low log level.</para> + + <para>Note that as the signal handlers send a debug write, + they are not re-entrant in <command>smbd</command>. This you should wait until + <command>smbd</command> is in a state of waiting for an incoming SMB before + issuing them. It is possible to make the signal handlers safe + by un-blocking the signals before the select call and re-blocking + them after, however this would affect performance.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>hosts_access</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>inetd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testprns</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>, and the + Internet RFC's <filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>. + In addition the CIFS (formerly SMB) specification is available + as a link from the Web page <ulink url="http://samba.org/cifs/"> + http://samba.org/cifs/</ulink>.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbmnt.8.xml b/docs/docbook/manpages/smbmnt.8.xml new file mode 100644 index 0000000000..86596f3ded --- /dev/null +++ b/docs/docbook/manpages/smbmnt.8.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbmnt.8"> + +<refmeta> + <refentrytitle>smbmnt</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbmnt</refname> + <refpurpose>helper utility for mounting SMB filesystems</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbmnt</command> + <arg choice="req">mount-point</arg> + <arg choice="opt">-s <share></arg> + <arg choice="opt">-r</arg> + <arg choice="opt">-u <uid></arg> + <arg choice="opt">-g <gid></arg> + <arg choice="opt">-f <mask></arg> + <arg choice="opt">-d <mask></arg> + <arg choice="opt">-o <options></arg> + <arg choice="opt">-h</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para><command>smbmnt</command> is a helper application used + by the smbmount program to do the actual mounting of SMB shares. + <command>smbmnt</command> can be installed setuid root if you want + normal users to be able to mount their SMB shares.</para> + + <para>A setuid smbmnt will only allow mounts on directories owned + by the user, and that the user has write permission on.</para> + + <para>The <command>smbmnt</command> program is normally invoked + by <citerefentry><refentrytitle>smbmount</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>. It should not be invoked directly by users. </para> + + <para>smbmount searches the normal PATH for smbmnt. You must ensure + that the smbmnt version in your path matches the smbmount used.</para> + +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-r</term> + <listitem><para>mount the filesystem read-only + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-u uid</term> + <listitem><para>specify the uid that the files will + be owned by </para></listitem> + </varlistentry> + + <varlistentry> + <term>-g gid</term> + <listitem><para>specify the gid that the files will be + owned by </para></listitem> + </varlistentry> + + <varlistentry> + <term>-f mask</term> + <listitem><para>specify the octal file mask applied + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-d mask</term> + <listitem><para>specify the octal directory mask + applied </para></listitem> + </varlistentry> + + <varlistentry> + <term>-o options</term> + <listitem><para> + list of options that are passed as-is to smbfs, if this + command is run on a 2.4 or higher Linux kernel. + </para></listitem> + </varlistentry> + + &stdarg.help; + + </variablelist> +</refsect1> + + +<refsect1> + <title>AUTHOR</title> + + <para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.</para> + + <para>The current maintainer of smbfs and the userspace + tools <command>smbmount</command>, <command>smbumount</command>, + and <command>smbmnt</command> is <ulink + url="mailto:urban@teststation.com">Urban Widmark</ulink>. + The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink> + is the preferred place to ask questions regarding these programs. + </para> + + <para>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbmount.8.xml b/docs/docbook/manpages/smbmount.8.xml new file mode 100644 index 0000000000..356b4f8f61 --- /dev/null +++ b/docs/docbook/manpages/smbmount.8.xml @@ -0,0 +1,335 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbmount.8"> + +<refmeta> + <refentrytitle>smbmount</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbmount</refname> + <refpurpose>mount an smbfs filesystem</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbmount</command> + <arg choice="req">service</arg> + <arg choice="req">mount-point</arg> + <arg choice="opt">-o options</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para><command>smbmount</command> mounts a Linux SMB filesystem. It + is usually invoked as <command>mount.smbfs</command> by + the <citerefentry><refentrytitle>mount</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> command when using the + "-t smbfs" option. This command only works in Linux, and the kernel must + support the smbfs filesystem. </para> + + <para>Options to <command>smbmount</command> are specified as a comma-separated + list of key=value pairs. It is possible to send options other + than those listed here, assuming that smbfs supports them. If + you get mount failures, check your kernel log for errors on + unknown options.</para> + + <para><command>smbmount</command> is a daemon. After mounting it keeps running until + the mounted smbfs is umounted. It will log things that happen + when in daemon mode using the "machine name" smbmount, so + typically this output will end up in <filename>log.smbmount</filename>. The <command> + smbmount</command> process may also be called mount.smbfs.</para> + + <para><emphasis>NOTE:</emphasis> <command>smbmount</command> + calls <citerefentry><refentrytitle>smbmnt</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to do the actual mount. You + must make sure that <command>smbmnt</command> is in the path so + that it can be found. </para> + +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>username=<arg></term> + <listitem><para>specifies the username to connect as. If + this is not given, then the environment variable <envar> + USER</envar> is used. This option can also take the + form "user%password" or "user/workgroup" or + "user/workgroup%password" to allow the password and workgroup + to be specified as part of the username.</para></listitem> + </varlistentry> + + <varlistentry> + <term>password=<arg></term> + <listitem><para>specifies the SMB password. If this + option is not given then the environment variable + <envar>PASSWD</envar> is used. If it can find + no password <command>smbmount</command> will prompt + for a passeword, unless the guest option is + given. </para> + + <para> + Note that passwords which contain the argument delimiter + character (i.e. a comma ',') will failed to be parsed correctly + on the command line. However, the same password defined + in the PASSWD environment variable or a credentials file (see + below) will be read correctly. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>credentials=<filename></term> + <listitem><para>specifies a file that contains a username and/or password. +The format of the file is: +<programlisting> +username = <value> +password = <value> +</programlisting></para> + + <para>This is preferred over having passwords in plaintext in a + shared file, such as <filename>/etc/fstab</filename>. Be sure to protect any + credentials file properly. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>krb</term> + <listitem><para>Use kerberos (Active Directory). </para></listitem> + </varlistentry> + + <varlistentry> + <term>netbiosname=<arg></term> + <listitem><para>sets the source NetBIOS name. It defaults + to the local hostname. </para></listitem> + </varlistentry> + + <varlistentry> + <term>uid=<arg></term> + <listitem><para>sets the uid that will own all files on + the mounted filesystem. + It may be specified as either a username or a numeric uid. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>gid=<arg></term> + <listitem><para>sets the gid that will own all files on + the mounted filesystem. + It may be specified as either a groupname or a numeric + gid. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>port=<arg></term> + <listitem><para>sets the remote SMB port number. The default + is 139. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>fmask=<arg></term> + <listitem><para>sets the file mask. This determines the + permissions that remote files have in the local filesystem. + The default is based on the current umask. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>dmask=<arg></term> + <listitem><para>Sets the directory mask. This determines the + permissions that remote directories have in the local filesystem. + The default is based on the current umask. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>debug=<arg></term> + <listitem><para>Sets the debug level. This is useful for + tracking down SMB connection problems. A suggested value to + start with is 4. If set too high there will be a lot of + output, possibly hiding the useful output.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>ip=<arg></term> + <listitem><para>Sets the destination host or IP address. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>workgroup=<arg></term> + <listitem><para>Sets the workgroup on the destination </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>sockopt=<arg></term> + <listitem><para>Sets the TCP socket options. See the <ulink + url="smb.conf.5.html#SOCKETOPTIONS"><citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry></ulink> <parameter>socket options</parameter> option. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>scope=<arg></term> + <listitem><para>Sets the NetBIOS scope </para></listitem> + </varlistentry> + + <varlistentry> + <term>guest</term> + <listitem><para>Don't prompt for a password </para></listitem> + </varlistentry> + + <varlistentry> + <term>ro</term> + <listitem><para>mount read-only </para></listitem> + </varlistentry> + + <varlistentry> + <term>rw</term><listitem><para>mount read-write </para></listitem> + </varlistentry> + + <varlistentry> + <term>iocharset=<arg></term> + <listitem><para> + sets the charset used by the Linux side for codepage + to charset translations (NLS). Argument should be the + name of a charset, like iso8859-1. (Note: only kernel + 2.4.0 or later) + </para></listitem> + </varlistentry> + + <varlistentry> + <term>codepage=<arg></term> + <listitem><para> + sets the codepage the server uses. See the iocharset + option. Example value cp850. (Note: only kernel 2.4.0 + or later) + </para></listitem> + </varlistentry> + + <varlistentry> + <term>ttl=<arg></term> + <listitem><para> + sets how long a directory listing is cached in milliseconds + (also affects visibility of file size and date + changes). A higher value means that changes on the + server take longer to be noticed but it can give + better performance on large directories, especially + over long distances. Default is 1000ms but something + like 10000ms (10 seconds) is probably more reasonable + in many cases. + (Note: only kernel 2.4.2 or later) + </para></listitem> + </varlistentry> + + </variablelist> + + +</refsect1> + +<refsect1> + <title>ENVIRONMENT VARIABLES</title> + + <para>The variable <envar>USER</envar> may contain the username of the + person using the client. This information is used only if the + protocol level is high enough to support session-level + passwords. The variable can be used to set both username and + password by using the format username%password.</para> + + <para>The variable <envar>PASSWD</envar> may contain the password of the + person using the client. This information is used only if the + protocol level is high enough to support session-level + passwords.</para> + + <para>The variable <envar>PASSWD_FILE</envar> may contain the pathname + of a file to read the password from. A single line of input is + read and used as the password.</para> +</refsect1> + + +<refsect1> + <title>BUGS</title> + + <para>Passwords and other options containing , can not be handled. + For passwords an alternative way of passing them is in a credentials + file or in the PASSWD environment.</para> + + <para>The credentials file does not handle usernames or passwords with + leading space.</para> + + <para>One smbfs bug is important enough to mention here, even if it + is a bit misplaced:</para> + + <itemizedlist> + + <listitem><para>Mounts sometimes stop working. This is usually + caused by smbmount terminating. Since smbfs needs smbmount to + reconnect when the server disconnects, the mount will eventually go + dead. An umount/mount normally fixes this. At least 2 ways to + trigger this bug are known.</para></listitem> + + </itemizedlist> + + <para>Note that the typical response to a bug report is suggestion + to try the latest version first. So please try doing that first, + and always include which versions you use of relevant software + when reporting bugs (minimum: samba, kernel, distribution)</para> + +</refsect1> + + +<refsect1> + <title>SEE ALSO</title> + + <para>Documentation/filesystems/smbfs.txt in the linux kernel + source tree may contain additional options and information.</para> + + <para>FreeBSD also has a smbfs, but it is not related to smbmount</para> + + <para>For Solaris, HP-UX and others you may want to look at <citerefentry><refentrytitle>smbsh</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> or at other solutions, such as + Sharity or perhaps replacing the SMB server with a NFS server.</para> + +</refsect1> + + +<refsect1> + <title>AUTHOR</title> + + <para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.</para> + + <para>The current maintainer of smbfs and the userspace + tools <command>smbmount</command>, <command>smbumount</command>, + and <command>smbmnt</command> is <ulink + url="mailto:urban@teststation.com">Urban Widmark</ulink>. + The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink> + is the preferred place to ask questions regarding these programs. + </para> + + <para>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbpasswd.5.xml b/docs/docbook/manpages/smbpasswd.5.xml new file mode 100644 index 0000000000..c3bd654564 --- /dev/null +++ b/docs/docbook/manpages/smbpasswd.5.xml @@ -0,0 +1,209 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbpasswd.5"> + +<refmeta> + <refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbpasswd</refname> + <refpurpose>The Samba encrypted password file</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <para><filename>smbpasswd</filename></para> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>smbpasswd is the Samba encrypted password file. It contains + the username, Unix user id and the SMB hashed passwords of the + user, as well as account flag information and the time the + password was last changed. This file format has been evolving with + Samba and has had several different formats in the past. </para> +</refsect1> + +<refsect1> + <title>FILE FORMAT</title> + + <para>The format of the smbpasswd file used by Samba 2.2 + is very similar to the familiar Unix <filename>passwd(5)</filename> + file. It is an ASCII file containing one line for each user. Each field + ithin each line is separated from the next by a colon. Any entry + beginning with '#' is ignored. The smbpasswd file contains the + following information for each user: </para> + + <variablelist> + <varlistentry> + <term>name</term> + <listitem><para> This is the user name. It must be a name that + already exists in the standard UNIX passwd file. </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>uid</term> + <listitem><para>This is the UNIX uid. It must match the uid + field for the same user entry in the standard UNIX passwd file. + If this does not match then Samba will refuse to recognize + this smbpasswd file entry as being valid for a user. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>Lanman Password Hash</term> + <listitem><para>This is the LANMAN hash of the user's password, + encoded as 32 hex digits. The LANMAN hash is created by DES + encrypting a well known string with the user's password as the + DES key. This is the same password used by Windows 95/98 machines. + Note that this password hash is regarded as weak as it is + vulnerable to dictionary attacks and if two users choose the + same password this entry will be identical (i.e. the password + is not "salted" as the UNIX password is). If the user has a + null password this field will contain the characters "NO PASSWORD" + as the start of the hex string. If the hex string is equal to + 32 'X' characters then the user's account is marked as + <constant>disabled</constant> and the user will not be able to + log onto the Samba server. </para> + + <para><emphasis>WARNING !!</emphasis> Note that, due to + the challenge-response nature of the SMB/CIFS authentication + protocol, anyone with a knowledge of this password hash will + be able to impersonate the user on the network. For this + reason these hashes are known as <emphasis>plain text + equivalents</emphasis> and must <emphasis>NOT</emphasis> be made + available to anyone but the root user. To protect these passwords + the smbpasswd file is placed in a directory with read and + traverse access only to the root user and the smbpasswd file + itself must be set to be read/write only by root, with no + other access. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>NT Password Hash</term> + <listitem><para>This is the Windows NT hash of the user's + password, encoded as 32 hex digits. The Windows NT hash is + created by taking the user's password as represented in + 16-bit, little-endian UNICODE and then applying the MD4 + (internet rfc1321) hashing algorithm to it. </para> + + <para>This password hash is considered more secure than + the LANMAN Password Hash as it preserves the case of the + password and uses a much higher quality hashing algorithm. + However, it is still the case that if two users choose the same + password this entry will be identical (i.e. the password is + not "salted" as the UNIX password is). </para> + + <para><emphasis>WARNING !!</emphasis>. Note that, due to + the challenge-response nature of the SMB/CIFS authentication + protocol, anyone with a knowledge of this password hash will + be able to impersonate the user on the network. For this + reason these hashes are known as <emphasis>plain text + equivalents</emphasis> and must <emphasis>NOT</emphasis> be made + available to anyone but the root user. To protect these passwords + the smbpasswd file is placed in a directory with read and + traverse access only to the root user and the smbpasswd file + itself must be set to be read/write only by root, with no + other access. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>Account Flags</term> + <listitem><para>This section contains flags that describe + the attributes of the users account. In the Samba 2.2 release + this field is bracketed by '[' and ']' characters and is always + 13 characters in length (including the '[' and ']' characters). + The contents of this field may be any of the following characters: + </para> + + <itemizedlist> + <listitem><para><emphasis>U</emphasis> - This means + this is a "User" account, i.e. an ordinary user. Only User + and Workstation Trust accounts are currently supported + in the smbpasswd file. </para></listitem> + + <listitem><para><emphasis>N</emphasis> - This means the + account has no password (the passwords in the fields LANMAN + Password Hash and NT Password Hash are ignored). Note that this + will only allow users to log on with no password if the <parameter> + null passwords</parameter> parameter is set in the <ulink + url="smb.conf.5.html#NULLPASSWORDS"><citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry></ulink> config file. </para></listitem> + + <listitem><para><emphasis>D</emphasis> - This means the account + is disabled and no SMB/CIFS logins will be allowed for this user. </para></listitem> + + <listitem><para><emphasis>W</emphasis> - This means this account + is a "Workstation Trust" account. This kind of account is used + in the Samba PDC code stream to allow Windows NT Workstations + and Servers to join a Domain hosted by a Samba PDC. </para> + </listitem> + </itemizedlist> + + <para>Other flags may be added as the code is extended in future. + The rest of this field space is filled in with spaces. </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>Last Change Time</term> + <listitem><para>This field consists of the time the account was + last modified. It consists of the characters 'LCT-' (standing for + "Last Change Time") followed by a numeric encoding of the UNIX time + in seconds since the epoch (1970) that the last change was made. + </para></listitem> + </varlistentry> + </variablelist> + + <para>All other colon separated fields are ignored at this time.</para> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry>, and + the Internet RFC1321 for details on the MD4 algorithm. + </para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbpasswd.8.xml b/docs/docbook/manpages/smbpasswd.8.xml new file mode 100644 index 0000000000..37f617e46a --- /dev/null +++ b/docs/docbook/manpages/smbpasswd.8.xml @@ -0,0 +1,409 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbpasswd.8"> + +<refmeta> + <refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbpasswd</refname> + <refpurpose>change a user's SMB password</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbpasswd</command> + <arg choice="opt">-a</arg> + <arg choice="opt">-x</arg> + <arg choice="opt">-d</arg> + <arg choice="opt">-e</arg> + <arg choice="opt">-D debuglevel</arg> + <arg choice="opt">-n</arg> + <arg choice="opt">-r <remote machine></arg> + <arg choice="opt">-R <name resolve order></arg> + <arg choice="opt">-m</arg> + <arg choice="opt">-U username[%password]</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-s</arg> + <arg choice="opt">-w pass</arg> + <arg choice="opt">-i</arg> + <arg choice="opt">-L</arg> + <arg choice="opt">username</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>The smbpasswd program has several different + functions, depending on whether it is run by the <emphasis>root</emphasis> user + or not. When run as a normal user it allows the user to change + the password used for their SMB sessions on any machines that store + SMB passwords. </para> + + <para>By default (when run with no arguments) it will attempt to + change the current user's SMB password on the local machine. This is + similar to the way the <command>passwd(1)</command> program works. <command> + smbpasswd</command> differs from how the passwd program works + however in that it is not <emphasis>setuid root</emphasis> but works in + a client-server mode and communicates with a + locally running <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>. As a consequence in order for this to + succeed the smbd daemon must be running on the local machine. On a + UNIX machine the encrypted SMB passwords are usually stored in + the <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file. </para> + + <para>When run by an ordinary user with no options, smbpasswd + will prompt them for their old SMB password and then ask them + for their new password twice, to ensure that the new password + was typed correctly. No passwords will be echoed on the screen + whilst being typed. If you have a blank SMB password (specified by + the string "NO PASSWORD" in the smbpasswd file) then just press + the <Enter> key when asked for your old password. </para> + + <para>smbpasswd can also be used by a normal user to change their + SMB password on remote machines, such as Windows NT Primary Domain + Controllers. See the (<parameter>-r</parameter>) and <parameter>-U</parameter> options + below. </para> + + <para>When run by root, smbpasswd allows new users to be added + and deleted in the smbpasswd file, as well as allows changes to + the attributes of the user in this file to be made. When run by root, <command> + smbpasswd</command> accesses the local smbpasswd file + directly, thus enabling changes to be made even if smbd is not + running. </para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + <variablelist> + <varlistentry> + <term>-a</term> + <listitem><para>This option specifies that the username + following should be added to the local smbpasswd file, with the + new password typed (type <Enter> for the old password). This + option is ignored if the username following already exists in + the smbpasswd file and it is treated like a regular change + password command. Note that the default passdb backends require + the user to already exist in the system password file (usually + <filename>/etc/passwd</filename>), else the request to add the + user will fail. </para> + + <para>This option is only available when running smbpasswd + as root. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-x</term> + <listitem><para>This option specifies that the username + following should be deleted from the local smbpasswd file. + </para> + + <para>This option is only available when running smbpasswd as + root.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-d</term> + <listitem><para>This option specifies that the username following + should be <constant>disabled</constant> in the local smbpasswd + file. This is done by writing a <constant>'D'</constant> flag + into the account control space in the smbpasswd file. Once this + is done all attempts to authenticate via SMB using this username + will fail. </para> + + <para>If the smbpasswd file is in the 'old' format (pre-Samba 2.0 + format) there is no space in the user's password entry to write + this information and the command will FAIL. See <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for details on the 'old' and new password file formats. + </para> + + <para>This option is only available when running smbpasswd as + root.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-e</term> + <listitem><para>This option specifies that the username following + should be <constant>enabled</constant> in the local smbpasswd file, + if the account was previously disabled. If the account was not + disabled this option has no effect. Once the account is enabled then + the user will be able to authenticate via SMB once again. </para> + + <para>If the smbpasswd file is in the 'old' format, then <command> + smbpasswd</command> will FAIL to enable the account. + See <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for + details on the 'old' and new password file formats. </para> + + <para>This option is only available when running smbpasswd as root. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-D debuglevel</term> + <listitem><para><replaceable>debuglevel</replaceable> is an integer + from 0 to 10. The default value if this parameter is not specified + is zero. </para> + + <para>The higher this value, the more detail will be logged to the + log files about the activities of smbpasswd. At level 0, only + critical errors and serious warnings will be logged. </para> + + <para>Levels above 1 will generate considerable amounts of log + data, and should only be used when investigating a problem. Levels + above 3 are designed for use only by developers and generate + HUGE amounts of log data, most of which is extremely cryptic. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-n</term> + <listitem><para>This option specifies that the username following + should have their password set to null (i.e. a blank password) in + the local smbpasswd file. This is done by writing the string "NO + PASSWORD" as the first part of the first password stored in the + smbpasswd file. </para> + + <para>Note that to allow users to logon to a Samba server once + the password has been set to "NO PASSWORD" in the smbpasswd + file the administrator must set the following parameter in the [global] + section of the <filename>smb.conf</filename> file : </para> + + <para><command>null passwords = yes</command></para> + + <para>This option is only available when running smbpasswd as + root.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-r remote machine name</term> + <listitem><para>This option allows a user to specify what machine + they wish to change their password on. Without this parameter + smbpasswd defaults to the local host. The <replaceable>remote + machine name</replaceable> is the NetBIOS name of the SMB/CIFS + server to contact to attempt the password change. This name is + resolved into an IP address using the standard name resolution + mechanism in all programs of the Samba suite. See the <parameter>-R + name resolve order</parameter> parameter for details on changing + this resolving mechanism. </para> + + <para>The username whose password is changed is that of the + current UNIX logged on user. See the <parameter>-U username</parameter> + parameter for details on changing the password for a different + username. </para> + + <para>Note that if changing a Windows NT Domain password the + remote machine specified must be the Primary Domain Controller for + the domain (Backup Domain Controllers only have a read-only + copy of the user account database and will not allow the password + change).</para> + + <para><emphasis>Note</emphasis> that Windows 95/98 do not have + a real password database so it is not possible to change passwords + specifying a Win95/98 machine as remote machine target. </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-R name resolve order</term> + <listitem><para>This option allows the user of smbpasswd to determine + what name resolution services to use when looking up the NetBIOS + name of the host being connected to. </para> + + <para>The options are :"lmhosts", "host", "wins" and "bcast". They + cause names to be resolved as follows: </para> + <itemizedlist> + <listitem><para><constant>lmhosts</constant>: Lookup an IP + address in the Samba lmhosts file. If the line in lmhosts has + no name type attached to the NetBIOS name (see the <citerefentry><refentrytitle>lmhosts</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> for details) then + any name type matches for lookup.</para></listitem> + + <listitem><para><constant>host</constant>: Do a standard host + name to IP address resolution, using the system <filename>/etc/hosts + </filename>, NIS, or DNS lookups. This method of name resolution + is operating system depended for instance on IRIX or Solaris this + may be controlled by the <filename>/etc/nsswitch.conf</filename> + file). Note that this method is only used if the NetBIOS name + type being queried is the 0x20 (server) name type, otherwise + it is ignored.</para></listitem> + + <listitem><para><constant>wins</constant>: Query a name with + the IP address listed in the <parameter>wins server</parameter> + parameter. If no WINS server has been specified this method + will be ignored.</para></listitem> + + <listitem><para><constant>bcast</constant>: Do a broadcast on + each of the known local interfaces listed in the + <parameter>interfaces</parameter> parameter. This is the least + reliable of the name resolution methods as it depends on the + target host being on a locally connected subnet.</para></listitem> + </itemizedlist> + + <para>The default order is <command>lmhosts, host, wins, bcast</command> + and without this parameter or any entry in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file the name resolution methods will + be attempted in this order. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-m</term> + <listitem><para>This option tells smbpasswd that the account + being changed is a MACHINE account. Currently this is used + when Samba is being used as an NT Primary Domain Controller.</para> + + <para>This option is only available when running smbpasswd as root. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-U username</term> + <listitem><para>This option may only be used in conjunction + with the <parameter>-r</parameter> option. When changing + a password on a remote machine it allows the user to specify + the user name on that machine whose password will be changed. It + is present to allow users who have different user names on + different systems to change these passwords. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-h</term> + <listitem><para>This option prints the help string for <command> + smbpasswd</command>, selecting the correct one for running as root + or as an ordinary user. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-s</term> + <listitem><para>This option causes smbpasswd to be silent (i.e. + not issue prompts) and to read its old and new passwords from + standard input, rather than from <filename>/dev/tty</filename> + (like the <command>passwd(1)</command> program does). This option + is to aid people writing scripts to drive smbpasswd</para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-w password</term> + <listitem><para>This parameter is only available if Samba + has been configured to use the experimental + <command>--with-ldapsam</command> option. The <parameter>-w</parameter> + switch is used to specify the password to be used with the + <ulink url="smb.conf.5.html#LDAPADMINDN"><parameter>ldap admin + dn</parameter></ulink>. Note that the password is stored in + the <filename>secrets.tdb</filename> and is keyed off + of the admin's DN. This means that if the value of <parameter>ldap + admin dn</parameter> ever changes, the password will need to be + manually updated as well. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-i</term> + <listitem><para>This option tells smbpasswd that the account + being changed is an interdomain trust account. Currently this is used + when Samba is being used as an NT Primary Domain Controller. + The account contains the info about another trusted domain.</para> + + <para>This option is only available when running smbpasswd as root. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-L</term> + <listitem><para>Run in local mode.</para></listitem> + </varlistentry> + + <varlistentry> + <term>username</term> + <listitem><para>This specifies the username for all of the + <emphasis>root only</emphasis> options to operate on. Only root + can specify this parameter as only root has the permission needed + to modify attributes directly in the local smbpasswd file. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>NOTES</title> + + <para>Since <command>smbpasswd</command> works in client-server + mode communicating with a local smbd for a non-root user then + the smbd daemon must be running for this to work. A common problem + is to add a restriction to the hosts that may access the <command> + smbd</command> running on the local machine by specifying either <parameter>allow + hosts</parameter> or <parameter>deny hosts</parameter> entry in + the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file and neglecting to + allow "localhost" access to the smbd. </para> + + <para>In addition, the smbpasswd command is only useful if Samba + has been set up to use encrypted passwords. See the document <ulink url="pwencrypt.html"> + "LanMan and NT Password Encryption in Samba"</ulink> in the docs directory for details + on how to do this. </para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry>.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbsh.1.xml b/docs/docbook/manpages/smbsh.1.xml new file mode 100644 index 0000000000..1bd29917b9 --- /dev/null +++ b/docs/docbook/manpages/smbsh.1.xml @@ -0,0 +1,165 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbsh.1"> + +<refmeta> + <refentrytitle>smbsh</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbsh</refname> + <refpurpose>Allows access to Windows NT filesystem + using UNIX commands</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbsh</command> + <arg choice="opt">-W workgroup</arg> + <arg choice="opt">-U username</arg> + <arg choice="opt">-P prefix</arg> + <arg choice="opt">-R <name resolve order></arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-l logfile</arg> + <arg choice="opt">-L libdir</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>smbsh</command> allows you to access an NT filesystem + using UNIX commands such as <command>ls</command>, <command> + egrep</command>, and <command>rcp</command>. You must use a + shell that is dynamically linked in order for <command>smbsh</command> + to work correctly.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-W WORKGROUP</term> + <listitem><para>Override the default workgroup specified in the + workgroup parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file + for this session. This may be needed to connect to some + servers. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-U username[%pass]</term> + <listitem><para>Sets the SMB username or username and password. + If this option is not specified, the user will be prompted for + both the username and the password. If %pass is not specified, + the user will be prompted for the password. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-P prefix</term> + <listitem><para>This option allows + the user to set the directory prefix for SMB access. The + default value if this option is not specified is + <emphasis>smb</emphasis>. + </para></listitem> + </varlistentry> + + &stdarg.configfile; + &stdarg.debug; + &stdarg.resolve.order; + + <varlistentry> + <term>-L libdir</term> + <listitem><para>This parameter specifies the location of the + shared libraries used by <command>smbsh</command>. The default + value is specified at compile time. + </para></listitem> + </varlistentry> + + </variablelist> +</refsect1> + +<refsect1> + <title>EXAMPLES</title> + + <para>To use the <command>smbsh</command> command, execute <command> + smbsh</command> from the prompt and enter the username and password + that authenticates you to the machine running the Windows NT + operating system. +<programlisting> +<prompt>system% </prompt><userinput>smbsh</userinput> +<prompt>Username: </prompt><userinput>user</userinput> +<prompt>Password: </prompt><userinput>XXXXXXX</userinput> +</programlisting></para> + + + <para>Any dynamically linked command you execute from + this shell will access the <filename>/smb</filename> directory + using the smb protocol. For example, the command <command>ls /smb + </command> will show a list of workgroups. The command + <command>ls /smb/MYGROUP </command> will show all the machines in + the workgroup MYGROUP. The command + <command>ls /smb/MYGROUP/<machine-name></command> will show the share + names for that machine. You could then, for example, use the <command> + cd</command> command to change directories, <command>vi</command> to + edit files, and <command>rcp</command> to copy files.</para> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</para> +</refsect1> + +<refsect1> + <title>BUGS</title> + + <para><command>smbsh</command> works by intercepting the standard + libc calls with the dynamically loaded versions in <filename> + smbwrapper.o</filename>. Not all calls have been "wrapped", so + some programs may not function correctly under <command>smbsh + </command>.</para> + + <para>Programs which are not dynamically linked cannot make + use of <command>smbsh</command>'s functionality. Most versions + of UNIX have a <command>file</command> command that will + describe how a program was linked.</para> +</refsect1> + + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry></para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbspool.8.xml b/docs/docbook/manpages/smbspool.8.xml new file mode 100644 index 0000000000..340c7ffff2 --- /dev/null +++ b/docs/docbook/manpages/smbspool.8.xml @@ -0,0 +1,133 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbspool.8"> + +<refmeta> + <refentrytitle>smbspool</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbspool</refname> + <refpurpose>send a print file to an SMB printer</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbspool</command> + <arg choice="req">job</arg> + <arg choice="req">user</arg> + <arg choice="req">title</arg> + <arg choice="req">copies</arg> + <arg choice="req">options</arg> + <arg choice="opt">filename</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>smbspool is a very small print spooling program that + sends a print file to an SMB printer. The command-line arguments + are position-dependent for compatibility with the Common UNIX + Printing System, but you can use smbspool with any printing system + or from a program or script.</para> + + <para><emphasis>DEVICE URI</emphasis></para> + + <para>smbspool specifies the destination using a Uniform Resource + Identifier ("URI") with a method of "smb". This string can take + a number of forms:</para> + + <itemizedlist> + <listitem><para>smb://server/printer</para></listitem> + <listitem><para>smb://workgroup/server/printer</para></listitem> + <listitem><para>smb://username:password@server/printer</para></listitem> + <listitem><para>smb://username:password@workgroup/server/printer</para></listitem> + </itemizedlist> + + <para>smbspool tries to get the URI from argv[0]. If argv[0] + contains the name of the program then it looks in the <envar> + DEVICE_URI</envar> environment variable.</para> + + <para>Programs using the <command>exec(2)</command> functions can + pass the URI in argv[0], while shell scripts must set the + <envar>DEVICE_URI</envar> environment variable prior to + running smbspool.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <itemizedlist> + <listitem><para>The job argument (argv[1]) contains the + job ID number and is presently not used by smbspool. + </para></listitem> + + <listitem><para>The user argument (argv[2]) contains the + print user's name and is presently not used by smbspool. + </para></listitem> + + <listitem><para>The title argument (argv[3]) contains the + job title string and is passed as the remote file name + when sending the print job.</para></listitem> + + <listitem><para>The copies argument (argv[4]) contains + the number of copies to be printed of the named file. If + no filename is provided then this argument is not used by + smbspool.</para></listitem> + + <listitem><para>The options argument (argv[5]) contains + the print options in a single string and is currently + not used by smbspool.</para></listitem> + + <listitem><para>The filename argument (argv[6]) contains the + name of the file to print. If this argument is not specified + then the print file is read from the standard input.</para> + </listitem> + </itemizedlist> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry>.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para><command>smbspool</command> was written by Michael Sweet + at Easy Software Products.</para> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbstatus.1.xml b/docs/docbook/manpages/smbstatus.1.xml new file mode 100644 index 0000000000..657175bf48 --- /dev/null +++ b/docs/docbook/manpages/smbstatus.1.xml @@ -0,0 +1,142 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> + +<refentry id="smbstatus.1"> + +<refmeta> + <refentrytitle>smbstatus</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbstatus</refname> + <refpurpose>report on current Samba connections</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbstatus</command> + <arg choice="opt">-P</arg> + <arg choice="opt">-b</arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-v</arg> + <arg choice="opt">-L</arg> + <arg choice="opt">-B</arg> + <arg choice="opt">-p</arg> + <arg choice="opt">-S</arg> + <arg choice="opt">-s <configuration file></arg> + <arg choice="opt">-u <username></arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>smbstatus</command> is a very simple program to + list the current Samba connections.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-P|--profile</term> + <listitem><para>If samba has been compiled with the + profiling option, print only the contents of the profiling + shared memory area.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-b|--brief</term> + <listitem><para>gives brief output.</para></listitem> + </varlistentry> + + &popt.common.samba; + + <varlistentry> + <term>-v|--verbose</term> + <listitem><para>gives verbose output.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-L|--locks</term> + <listitem><para>causes smbstatus to only list locks.</para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>-B|--byterange</term> + <listitem><para>causes smbstatus to include byte range locks. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-p|--processes</term> + <listitem><para>print a list of <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> processes and exit. + Useful for scripting.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-S|--shares</term> + <listitem><para>causes smbstatus to only list shares.</para> + </listitem> + </varlistentry> + + &stdarg.help; + + <varlistentry> + <term>-u|--user=<username></term> + <listitem><para>selects information relevant to + <parameter>username</parameter> only.</para> + </listitem> + </varlistentry> + + </variablelist> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbtar.1.xml b/docs/docbook/manpages/smbtar.1.xml new file mode 100644 index 0000000000..40c915f1f6 --- /dev/null +++ b/docs/docbook/manpages/smbtar.1.xml @@ -0,0 +1,238 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbtar.1"> + +<refmeta> + <refentrytitle>smbtar</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbtar</refname> + <refpurpose>shell script for backing up SMB/CIFS shares + directly to UNIX tape drives</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbtar</command> + <arg choice="opt">-r</arg> + <arg choice="opt">-i</arg> + <arg choice="opt">-a</arg> + <arg choice="opt">-v</arg> + <arg choice="req">-s server</arg> + <arg choice="opt">-p password</arg> + <arg choice="opt">-x services</arg> + <arg choice="opt">-X</arg> + <arg choice="opt">-N filename</arg> + <arg choice="opt">-b blocksize</arg> + <arg choice="opt">-d directory</arg> + <arg choice="opt">-l loglevel</arg> + <arg choice="opt">-u user</arg> + <arg choice="opt">-t tape</arg> + <arg choice="req">filenames</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>smbtar</command> is a very small shell script on top + of <citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry> which dumps SMB shares directly to tape.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-s server</term> + <listitem><para>The SMB/CIFS server that the share resides + upon.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-x service</term> + <listitem><para>The share name on the server to connect to. + The default is "backup".</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-X</term> + <listitem><para>Exclude mode. Exclude filenames... from tar + create or restore. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-d directory</term> + <listitem><para>Change to initial <parameter>directory + </parameter> before restoring / backing up files. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-v</term> + <listitem><para>Verbose mode.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-p password</term> + <listitem><para>The password to use to access a share. + Default: none </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-u user</term> + <listitem><para>The user id to connect as. Default: + UNIX login name. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-a</term> + <listitem><para>Reset DOS archive bit mode to + indicate file has been archived. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-t tape</term> + <listitem><para>Tape device. May be regular file or tape + device. Default: <parameter>$TAPE</parameter> environmental + variable; if not set, a file called <filename>tar.out + </filename>. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-b blocksize</term> + <listitem><para>Blocking factor. Defaults to 20. See + <command>tar(1)</command> for a fuller explanation. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-N filename</term> + <listitem><para>Backup only files newer than filename. Could + be used (for example) on a log file to implement incremental + backups. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-i</term> + <listitem><para>Incremental mode; tar files are only backed + up if they have the archive bit set. The archive bit is reset + after each file is read. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-r</term> + <listitem><para>Restore. Files are restored to the share + from the tar file. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-l log level</term> + <listitem><para>Log (debug) level. Corresponds to the + <parameter>-d</parameter> flag of <citerefentry> + <refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry>.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>ENVIRONMENT VARIABLES</title> + + <para>The <parameter>$TAPE</parameter> variable specifies the + default tape device to write to. May be overridden + with the -t option. </para> +</refsect1> + + +<refsect1> + <title>BUGS</title> + + <para>The <command>smbtar</command> script has different + options from ordinary tar and from smbclient's tar command. </para> + +</refsect1> + +<refsect1> + <title>CAVEATS</title> + + <para>Sites that are more careful about security may not like + the way the script handles PC passwords. Backup and restore work + on entire shares; should work on file lists. smbtar works best + with GNU tar and may not work well with other versions. </para> +</refsect1> + + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>See the <emphasis>DIAGNOSTICS</emphasis> section for the <citerefentry> + <refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry> command.</para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry> + <refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum> + </citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para><ulink url="mailto:poultenr@logica.co.uk">Ricky Poulten</ulink> + wrote the tar extension and this man page. The <command>smbtar</command> + script was heavily rewritten and improved by <ulink + url="mailto:Martin.Kraemer@mch.sni.de">Martin Kraemer</ulink>. Many + thanks to everyone who suggested extensions, improvements, bug + fixes, etc. The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbtree.1.xml b/docs/docbook/manpages/smbtree.1.xml new file mode 100644 index 0000000000..05f0256b87 --- /dev/null +++ b/docs/docbook/manpages/smbtree.1.xml @@ -0,0 +1,96 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbtree.1"> + +<refmeta> + <refentrytitle>smbtree</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbtree</refname> + <refpurpose>A text based smb network browser + </refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbtree</command> + <arg choice="opt">-b</arg> + <arg choice="opt">-D</arg> + <arg choice="opt">-S</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>smbtree</command> is a smb browser program + in text mode. It is similar to the "Network Neighborhood" found + on Windows computers. It prints a tree with all + the known domains, the servers in those domains and + the shares on the servers. + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-b</term> + <listitem><para>Query network nodes by sending requests + as broadcasts instead of querying the (domain) master browser. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-D</term> + <listitem><para>Only print a list of all + the domains known on broadcast or by the + master browser</para></listitem> + </varlistentry> + + <varlistentry> + <term>-S</term> + <listitem><para>Only print a list of + all the domains and servers responding on broadcast or + known by the master browser. + </para></listitem> + </varlistentry> + + &popt.common.samba; + &popt.common.credentials; + &stdarg.help; + + </variablelist> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The smbtree man page was written by Jelmer Vernooij. </para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/smbumount.8.xml b/docs/docbook/manpages/smbumount.8.xml new file mode 100644 index 0000000000..665ffdceb3 --- /dev/null +++ b/docs/docbook/manpages/smbumount.8.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="smbumount.8"> + +<refmeta> + <refentrytitle>smbumount</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>smbumount</refname> + <refpurpose>smbfs umount for normal users</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>smbumount</command> + <arg choice="req">mount-point</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>With this program, normal users can unmount smb-filesystems, + provided that it is suid root. <command>smbumount</command> has + been written to give normal Linux users more control over their + resources. It is safe to install this program suid root, because only + the user who has mounted a filesystem is allowed to unmount it again. + For root it is not necessary to use smbumount. The normal umount + program works perfectly well, but it would certainly be problematic + to make umount setuid root.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>mount-point</term> + <listitem><para>The directory to unmount.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>SEE ALSO</title> + + <para><citerefentry><refentrytitle>smbmount</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></para> +</refsect1> + + +<refsect1> + <title>AUTHOR</title> + + <para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.</para> + + <para>The current maintainer of smbfs and the userspace + tools <command>smbmount</command>, <command>smbumount</command>, + and <command>smbmnt</command> is <ulink + url="mailto:urban@teststation.com">Urban Widmark</ulink>. + The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink> + is the preferred place to ask questions regarding these programs. + </para> + + <para>The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/swat.8.xml b/docs/docbook/manpages/swat.8.xml new file mode 100644 index 0000000000..ad6829c3a6 --- /dev/null +++ b/docs/docbook/manpages/swat.8.xml @@ -0,0 +1,228 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="swat.8"> + +<refmeta> + <refentrytitle>swat</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>swat</refname> + <refpurpose>Samba Web Administration Tool</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>swat</command> + <arg choice="opt">-s <smb config file></arg> + <arg choice="opt">-a</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + + <para><command>swat</command> allows a Samba administrator to + configure the complex <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file via a Web browser. In addition, + a <command>swat</command> configuration page has help links + to all the configurable options in the <filename>smb.conf</filename> file allowing an + administrator to easily look up the effects of any change. </para> + + <para><command>swat</command> is run from <command>inetd</command> </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-s smb configuration file</term> + <listitem><para>The default configuration file path is + determined at compile time. The file specified contains + the configuration details required by the <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> server. This is the file + that <command>swat</command> will modify. + The information in this file includes server-specific + information such as what printcap file to use, as well as + descriptions of all the services that the server is to provide. + See <filename>smb.conf</filename> for more information. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-a</term> + <listitem><para>This option disables authentication and puts + <command>swat</command> in demo mode. In that mode anyone will be able to modify + the <filename>smb.conf</filename> file. </para> + + <para><emphasis>WARNING: Do NOT enable this option on a production + server. </emphasis></para></listitem> + </varlistentry> + + &popt.common.samba; + &stdarg.help; + + </variablelist> + +</refsect1> + +<refsect1> + + <title>INSTALLATION</title> + + <para>Swat is included as binary package with most distributions. The + package manager in this case takes care of the installation and + configuration. This section is only for those who have compiled + swat from scratch. + </para> + + <para>After you compile SWAT you need to run <command>make install + </command> to install the <command>swat</command> binary + and the various help files and images. A default install would put + these in: </para> + + <itemizedlist> + <listitem><para>/usr/local/samba/bin/swat</para></listitem> + <listitem><para>/usr/local/samba/swat/images/*</para></listitem> + <listitem><para>/usr/local/samba/swat/help/*</para></listitem> + </itemizedlist> + + <refsect2> + <title>Inetd Installation</title> + + <para>You need to edit your <filename>/etc/inetd.conf + </filename> and <filename>/etc/services</filename> + to enable SWAT to be launched via <command>inetd</command>.</para> + + <para>In <filename>/etc/services</filename> you need to + add a line like this: </para> + + <para><command>swat 901/tcp</command></para> + + <para>Note for NIS/YP and LDAP users - you may need to rebuild the + NIS service maps rather than alter your local <filename> + /etc/services</filename> file. </para> + + <para>the choice of port number isn't really important + except that it should be less than 1024 and not currently + used (using a number above 1024 presents an obscure security + hole depending on the implementation details of your + <command>inetd</command> daemon). </para> + + <para>In <filename>/etc/inetd.conf</filename> you should + add a line like this: </para> + + <para><command>swat stream tcp nowait.400 root + /usr/local/samba/bin/swat swat</command></para> + + <para>One you have edited <filename>/etc/services</filename> + and <filename>/etc/inetd.conf</filename> you need to send a + HUP signal to inetd. To do this use <command>kill -1 PID + </command> where PID is the process ID of the inetd daemon. </para> + + </refsect2> + + + +</refsect1> + +<refsect1> + <title>LAUNCHING</title> + + <para>To launch SWAT just run your favorite web browser and + point it at "http://localhost:901/".</para> + + <para>Note that you can attach to SWAT from any IP connected + machine but connecting from a remote machine leaves your + connection open to password sniffing as passwords will be sent + in the clear over the wire. </para> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>/etc/inetd.conf</filename></term> + <listitem><para>This file must contain suitable startup + information for the meta-daemon.</para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/etc/services</filename></term> + <listitem><para>This file must contain a mapping of service name + (e.g., swat) to service port (e.g., 901) and protocol type + (e.g., tcp). </para></listitem> + </varlistentry> + + <varlistentry> + <term><filename>/usr/local/samba/lib/smb.conf</filename></term> + <listitem><para>This is the default location of the <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> server configuration file that swat edits. Other + common places that systems install this file are <filename> + /usr/samba/lib/smb.conf</filename> and <filename>/etc/smb.conf + </filename>. This file describes all the services the server + is to make available to clients. </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>WARNINGS</title> + + <para><command>swat</command> will rewrite your <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> file. It will rearrange the entries and delete all + comments, <parameter>include=</parameter> and <parameter>copy= + </parameter> options. If you have a carefully crafted <filename> + smb.conf</filename> then back it up or don't use swat! </para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><command>inetd(5)</command>, <citerefentry> + <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry></para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/tdbbackup.8.xml b/docs/docbook/manpages/tdbbackup.8.xml new file mode 100644 index 0000000000..c8c5b7e33d --- /dev/null +++ b/docs/docbook/manpages/tdbbackup.8.xml @@ -0,0 +1,136 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="tdbbackup.8"> + +<refmeta> + <refentrytitle>tdbbackup</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>tdbbackup</refname> + <refpurpose>tool for backing up and for validating the integrity of samba .tdb files</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>tdbbackup</command> + <arg choice="opt">-s suffix</arg> + <arg choice="opt">-v</arg> + <arg choice="opt">-h</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> suite.</para> + + <para><command>tdbbackup</command> is a tool that may be used to backup samba .tdb + files. This tool may also be used to verify the integrity of the .tdb files prior + to samba startup, in which case, if it find file damage and it finds a prior backup + it will restore the backup file. + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + + <varlistentry> + <term>-h</term> + <listitem><para> + Get help information. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-s suffix</term> + <listitem><para> + The <command>-s</command> option allows the adminisistrator to specify a file + backup extension. This way it is possible to keep a history of tdb backup + files by using a new suffix for each backup. + </para> </listitem> + </varlistentry> + + <varlistentry> + <term>-v</term> + <listitem><para> + The <command>-v</command> will check the database for damages (currupt data) + which if detected causes the backup to be restored. + </para></listitem> + </varlistentry> + + </variablelist> +</refsect1> + + +<refsect1> + <title>COMMANDS</title> + + <para><emphasis>GENERAL INFORMATION</emphasis></para> + + <para> + The <command>tdbbackup</command> utility should be run as soon as samba has shut down. + Do NOT run this command on a live database. Typical usage for the command will be: + </para> + + <para>tdbbackup [-s suffix] *.tdb</para> + + <para> + Before restarting samba the following command may be run to validate .tdb files: + </para> + + <para>tdbbackup -v [-s suffix] *.tdb</para> + + <para> + Samba .tdb files are stored in various locations, be sure to run backup all + .tdb file on the system. Imporatant files includes: + </para> + + <itemizedlist> + <listitem><para> + <command>secrets.tdb</command> - usual location is in the /usr/local/samba/private + directory, or on some systems in /etc/samba. + </para></listitem> + + <listitem><para> + <command>passdb.tdb</command> - usual location is in the /usr/local/samba/private + directory, or on some systems in /etc/samba. + </para></listitem> + + <listitem><para> + <command>*.tdb</command> located in the /usr/local/samba/var directory or on some + systems in the /var/cache or /var/lib/samba directories. + </para></listitem> + </itemizedlist> + +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para> + The original Samba software and related utilities were created by Andrew Tridgell. + Samba is now developed by the Samba Team as an Open Source project similar to the way + the Linux kernel is developed. + </para> + + <para>The tdbbackup man page was written by John H Terpstra.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/testparm.1.xml b/docs/docbook/manpages/testparm.1.xml new file mode 100644 index 0000000000..085a645a88 --- /dev/null +++ b/docs/docbook/manpages/testparm.1.xml @@ -0,0 +1,192 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="testparm.1"> + +<refmeta> + <refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>testparm</refname> + <refpurpose>check an smb.conf configuration file for + internal correctness</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>testparm</command> + <arg choice="opt">-s</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-v</arg> + <arg choice="opt">-L <servername></arg> + <arg choice="opt">-t <encoding></arg> + <arg choice="req">config filename</arg> + <arg choice="opt">hostname hostIP</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>testparm</command> is a very simple test program + to check an <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> configuration file for + internal correctness. If this program reports no problems, you + can use the configuration file with confidence that <command>smbd + </command> will successfully load the configuration file.</para> + + + <para>Note that this is <emphasis>NOT</emphasis> a guarantee that + the services specified in the configuration file will be + available or will operate as expected. </para> + + <para>If the optional host name and host IP address are + specified on the command line, this test program will run through + the service entries reporting whether the specified host + has access to each service. </para> + + <para>If <command>testparm</command> finds an error in the <filename> + smb.conf</filename> file it returns an exit code of 1 to the calling + program, else it returns an exit code of 0. This allows shell scripts + to test the output from <command>testparm</command>.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-s</term> + <listitem><para>Without this option, <command>testparm</command> + will prompt for a carriage return after printing the service + names and before dumping the service definitions.</para></listitem> + </varlistentry> + + &stdarg.help; + &stdarg.version; + + <varlistentry> + <term>-L servername</term> + <listitem><para>Sets the value of the %L macro to <replaceable>servername</replaceable>. + This is useful for testing include files specified with the + %L macro. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-v</term> + <listitem><para>If this option is specified, testparm + will also output all options that were not used in <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> and are thus set to their defaults.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-t encoding</term> + <listitem><para> + Output data in specified encoding. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>configfilename</term> + <listitem><para>This is the name of the configuration file + to check. If this parameter is not present then the + default <citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> file will be checked. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>hostname</term> + <listitem><para>If this parameter and the following are + specified, then <command>testparm</command> will examine the <parameter>hosts + allow</parameter> and <parameter>hosts deny</parameter> + parameters in the <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> file to + determine if the hostname with this IP address would be + allowed access to the <command>smbd</command> server. If + this parameter is supplied, the hostIP parameter must also + be supplied.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>hostIP</term> + <listitem><para>This is the IP address of the host specified + in the previous parameter. This address must be supplied + if the hostname parameter is supplied. </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry></term> + <listitem><para>This is usually the name of the configuration + file used by <citerefentry><refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>The program will issue a message saying whether the + configuration file loaded OK or not. This message may be preceded by + errors and warnings if the file did not load. If the file was + loaded OK, the program then dumps all known service details + to stdout. </para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry></para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/testprns.1.xml b/docs/docbook/manpages/testprns.1.xml new file mode 100644 index 0000000000..2afeba22d3 --- /dev/null +++ b/docs/docbook/manpages/testprns.1.xml @@ -0,0 +1,149 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="testprns.1"> + +<refmeta> + <refentrytitle>testprns</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>testprns</refname> + <refpurpose>check printer name for validity with smbd</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>testprns</command> + <arg choice="req">printername</arg> + <arg choice="opt">printcapname</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>testprns</command> is a very simple test program + to determine whether a given printer name is valid for use in + a service to be provided by <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>.</para> + + <para>"Valid" in this context means "can be found in the + printcap specified". This program is very stupid - so stupid in + fact that it would be wisest to always specify the printcap file + to use. </para> + +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>printername</term> + <listitem><para>The printer name to validate.</para> + + <para>Printer names are taken from the first field in each + record in the printcap file, single printer names and sets + of aliases separated by vertical bars ("|") are recognized. + Note that no validation or checking of the printcap syntax is + done beyond that required to extract the printer name. It may + be that the print spooling system is more forgiving or less + forgiving than <command>testprns</command>. However, if + <command>testprns</command> finds the printer then <citerefentry> + <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> should do so as well. </para></listitem> + </varlistentry> + + <varlistentry> + <term>printcapname</term> + <listitem><para>This is the name of the printcap file within + which to search for the given printer name. </para> + + <para>If no printcap name is specified <command>testprns + </command> will attempt to scan the printcap file name + specified at compile time. </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>/etc/printcap</filename></term> + <listitem><para>This is usually the default printcap + file to scan. See <filename>printcap (5)</filename>. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>DIAGNOSTICS</title> + + <para>If a printer is found to be valid, the message + "Printer name <printername> is valid" will be + displayed. </para> + + <para>If a printer is found to be invalid, the message + "Printer name <printername> is not valid" will be + displayed. </para> + + <para>All messages that would normally be logged during + operation of the Samba daemons are logged by this program to the + file <filename>test.log</filename> in the current directory. The + program runs at debuglevel 3, so quite extensive logging + information is written. The log should be checked carefully + for errors and warnings. </para> + + <para>Other messages are self-explanatory. </para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><filename>printcap(5)</filename>, + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle> + <manvolnum>1</manvolnum></citerefentry></para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> + diff --git a/docs/docbook/manpages/vfstest.1.xml b/docs/docbook/manpages/vfstest.1.xml new file mode 100644 index 0000000000..baf45fb0e4 --- /dev/null +++ b/docs/docbook/manpages/vfstest.1.xml @@ -0,0 +1,153 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="vfstest.1"> + +<refmeta> + <refentrytitle>vfstest</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>vfstest</refname> + <refpurpose>tool for testing samba VFS modules </refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>vfstest</command> + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-c command</arg> + <arg choice="opt">-l logfile</arg> + <arg choice="opt">-h</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>vfstest</command> is a small command line + utility that has the ability to test dso samba VFS modules. It gives the + user the ability to call the various VFS functions manually and + supports cascaded VFS modules. + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + + <varlistentry> + <term>-c|--command=command</term> + <listitem><para>Execute the specified (colon-separated) commands. + See below for the commands that are available. + </para> </listitem> + </varlistentry> + + &stdarg.help; + + <varlistentry> + <term>-l|--logfile=logbasename</term> + <listitem><para>File name for log/debug files. The extension + <constant>'.client'</constant> will be appended. The log file is never removed + by the client. + </para></listitem> + </varlistentry> + + &popt.common.samba; + + </variablelist> +</refsect1> + + +<refsect1> + <title>COMMANDS</title> + + <para><emphasis>VFS COMMANDS</emphasis></para> + <itemizedlist> + <listitem><para><command>load <module.so></command> - Load specified VFS module </para></listitem> + + <listitem><para><command>populate <char> <size></command> - Populate a data buffer with the specified data + </para></listitem> + + <listitem><para><command>showdata [<offset> <len>]</command> - Show data currently in data buffer + </para></listitem> + + <listitem><para><command>connect</command> - VFS connect()</para></listitem> + <listitem><para><command>disconnect</command> - VFS disconnect()</para></listitem> + <listitem><para><command>disk_free</command> - VFS disk_free()</para></listitem> + <listitem><para><command>opendir</command> - VFS opendir()</para></listitem> + <listitem><para><command>readdir</command> - VFS readdir()</para></listitem> + <listitem><para><command>mkdir</command> - VFS mkdir()</para></listitem> + <listitem><para><command>rmdir</command> - VFS rmdir()</para></listitem> + <listitem><para><command>closedir</command> - VFS closedir()</para></listitem> + <listitem><para><command>open</command> - VFS open()</para></listitem> + <listitem><para><command>close</command> - VFS close()</para></listitem> + <listitem><para><command>read</command> - VFS read()</para></listitem> + <listitem><para><command>write</command> - VFS write()</para></listitem> + <listitem><para><command>lseek</command> - VFS lseek()</para></listitem> + <listitem><para><command>rename</command> - VFS rename()</para></listitem> + <listitem><para><command>fsync</command> - VFS fsync()</para></listitem> + <listitem><para><command>stat</command> - VFS stat()</para></listitem> + <listitem><para><command>fstat</command> - VFS fstat()</para></listitem> + <listitem><para><command>lstat</command> - VFS lstat()</para></listitem> + <listitem><para><command>unlink</command> - VFS unlink()</para></listitem> + <listitem><para><command>chmod</command> - VFS chmod()</para></listitem> + <listitem><para><command>fchmod</command> - VFS fchmod()</para></listitem> + <listitem><para><command>chown</command> - VFS chown()</para></listitem> + <listitem><para><command>fchown</command> - VFS fchown()</para></listitem> + <listitem><para><command>chdir</command> - VFS chdir()</para></listitem> + <listitem><para><command>getwd</command> - VFS getwd()</para></listitem> + <listitem><para><command>utime</command> - VFS utime()</para></listitem> + <listitem><para><command>ftruncate</command> - VFS ftruncate()</para></listitem> + <listitem><para><command>lock</command> - VFS lock()</para></listitem> + <listitem><para><command>symlink</command> - VFS symlink()</para></listitem> + <listitem><para><command>readlink</command> - VFS readlink()</para></listitem> + <listitem><para><command>link</command> - VFS link()</para></listitem> + <listitem><para><command>mknod</command> - VFS mknod()</para></listitem> + <listitem><para><command>realpath</command> - VFS realpath()</para></listitem> + </itemizedlist> + + <para><emphasis>GENERAL COMMANDS</emphasis></para> + <itemizedlist> + <listitem><para><command>conf <smb.conf></command> - Load a different configuration file</para></listitem> + + <listitem><para><command>help [<command>]</command> - Get list of commands or info about specified command</para></listitem> + + <listitem><para><command>debuglevel <level></command> - Set debug level</para></listitem> + + <listitem><para><command>freemem</command> - Free memory currently in use</para></listitem> + + <listitem><para><command>exit</command> - Exit vfstest</para></listitem> + </itemizedlist> + +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The vfstest man page was written by Jelmer Vernooij.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/wbinfo.1.xml b/docs/docbook/manpages/wbinfo.1.xml new file mode 100644 index 0000000000..f9bd247997 --- /dev/null +++ b/docs/docbook/manpages/wbinfo.1.xml @@ -0,0 +1,281 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="wbinfo.1"> + +<refmeta> + <refentrytitle>wbinfo</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>wbinfo</refname> + <refpurpose>Query information from winbind daemon</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>wbinfo</command> + <arg choice="opt">-u</arg> + <arg choice="opt">-g</arg> + <arg choice="opt">-N netbios-name</arg> + <arg choice="opt">-I ip</arg> + <arg choice="opt">-n name</arg> + <arg choice="opt">-s sid</arg> + <arg choice="opt">-U uid</arg> + <arg choice="opt">-G gid</arg> + <arg choice="opt">-S sid</arg> + <arg choice="opt">-Y sid</arg> + <arg choice="opt">-t</arg> + <arg choice="opt">-m</arg> + <arg choice="opt">--sequence</arg> + <arg choice="opt">-r user</arg> + <arg choice="opt">-a user%password</arg> + <arg choice="opt">-A user%password</arg> + <arg choice="opt">--get-auth-user</arg> + <arg choice="opt">-p</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para>The <command>wbinfo</command> program queries and returns information + created and used by the <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon. </para> + + <para>The <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon must be configured + and running for the <command>wbinfo</command> program to be able + to return information.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-u</term> + <listitem><para>This option will list all users available + in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains + will also be listed. Note that this operation does not assign + user ids to any users that have not already been seen by <citerefentry> + <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> + .</para></listitem> + </varlistentry> + + <varlistentry> + <term>-g</term> + <listitem><para>This option will list all groups available + in the Windows NT domain for which the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> daemon is operating in. Groups in all trusted domains + will also be listed. Note that this operation does not assign + group ids to any groups that have not already been + seen by <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-N name</term> + <listitem><para>The <parameter>-N</parameter> option + queries <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to query the WINS + server for the IP address associated with the NetBIOS name + specified by the <parameter>name</parameter> parameter. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-I ip</term> + <listitem><para>The <parameter>-I</parameter> option + queries <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to send a node status + request to get the NetBIOS name associated with the IP address + specified by the <parameter>ip</parameter> parameter. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-n name</term> + <listitem><para>The <parameter>-n</parameter> option + queries <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> for the SID + associated with the name specified. Domain names can be specified + before the user name by using the winbind separator character. + For example CWDOM1/Administrator refers to the Administrator + user in the domain CWDOM1. If no domain is specified then the + domain used is the one specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> <parameter>workgroup + </parameter> parameter. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-s sid</term> + <listitem><para>Use <parameter>-s</parameter> to resolve + a SID to a name. This is the inverse of the <parameter>-n + </parameter> option above. SIDs must be specified as ASCII strings + in the traditional Microsoft format. For example, + S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-U uid</term> + <listitem><para>Try to convert a UNIX user id to a Windows NT + SID. If the uid specified does not refer to one within + the winbind uid range then the operation will fail. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-G gid</term> + <listitem><para>Try to convert a UNIX group id to a Windows + NT SID. If the gid specified does not refer to one within + the winbind gid range then the operation will fail. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-S sid</term> + <listitem><para>Convert a SID to a UNIX user id. If the SID + does not correspond to a UNIX user mapped by <citerefentry> + <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> then the operation will fail. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-Y sid</term> + <listitem><para>Convert a SID to a UNIX group id. If the SID + does not correspond to a UNIX group mapped by <citerefentry> + <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then + the operation will fail. </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-t</term> + <listitem><para>Verify that the workstation trust account + created when the Samba server is added to the Windows NT + domain is working. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-m</term> + <listitem><para>Produce a list of domains trusted by the + Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> contacts + when resolving names. This list does not include the Windows + NT domain the server is a Primary Domain Controller for. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>--sequence</term> + <listitem><para>Show sequence numbers of + all known domains</para></listitem> + </varlistentry> + + <varlistentry> + <term>-r username</term> + <listitem><para>Try to obtain the list of UNIX group ids + to which the user belongs. This only works for users + defined on a Domain Controller. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-a username%password</term> + <listitem><para>Attempt to authenticate a user via winbindd. + This checks both authenticaion methods and reports its results. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-A username%password</term> + <listitem><para>Store username and password used by winbindd + during session setup to a domain controller. This enables + winbindd to operate in a Windows 2000 domain with Restrict + Anonymous turned on (a.k.a. Permissions compatiable with + Windows 2000 servers only). + </para></listitem> + </varlistentry> + + <varlistentry> + <term>--get-auth-user</term> + <listitem><para>Print username and password used by winbindd + during session setup to a domain controller. Username + and password can be set using '-A'. Only available for + root.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-p</term> + <listitem><para>Check whether winbindd is still alive. + Prints out either 'succeeded' or 'failed'. + </para></listitem> + </varlistentry> + + &stdarg.version; + &stdarg.help; + + </variablelist> +</refsect1> + + +<refsect1> + <title>EXIT STATUS</title> + + <para>The wbinfo program returns 0 if the operation + succeeded, or 1 if the operation failed. If the <citerefentry> + <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> daemon is not working <command>wbinfo</command> will always return + failure. </para> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><citerefentry><refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry></para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para><command>wbinfo</command> and <command>winbindd</command> + were written by Tim Potter.</para> + + <para>The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba + 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/manpages/winbindd.8.xml b/docs/docbook/manpages/winbindd.8.xml new file mode 100644 index 0000000000..f19b7b8242 --- /dev/null +++ b/docs/docbook/manpages/winbindd.8.xml @@ -0,0 +1,460 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +<refentry id="winbindd.8"> + +<refmeta> + <refentrytitle>winbindd</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>winbindd</refname> + <refpurpose>Name Service Switch daemon for resolving names + from NT servers</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>winbindd</command> + <arg choice="opt">-F</arg> + <arg choice="opt">-S</arg> + <arg choice="opt">-i</arg> + <arg choice="opt">-B</arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-s <smb config file></arg> + <arg choice="opt">-n</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This program is part of the <citerefentry><refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry> suite.</para> + + <para><command>winbindd</command> is a daemon that provides + a service for the Name Service Switch capability that is present + in most modern C libraries. The Name Service Switch allows user + and system information to be obtained from different databases + services such as NIS or DNS. The exact behaviour can be configured + throught the <filename>/etc/nsswitch.conf</filename> file. + Users and groups are allocated as they are resolved to a range + of user and group ids specified by the administrator of the + Samba system.</para> + + <para>The service provided by <command>winbindd</command> is called `winbind' and + can be used to resolve user and group information from a + Windows NT server. The service can also provide authentication + services via an associated PAM module. </para> + + <para> + The <filename>pam_winbind</filename> module in the 2.2.2 release only + supports the <parameter>auth</parameter> and <parameter>account</parameter> + module-types. The latter simply + performs a getpwnam() to verify that the system can obtain a uid for the + user. If the <filename>libnss_winbind</filename> library has been correctly + installed, this should always succeed. + </para> + + <para>The following nsswitch databases are implemented by + the winbindd service: </para> + + <variablelist> + <varlistentry> + <term>hosts</term> + <listitem><para>User information traditionally stored in + the <filename>hosts(5)</filename> file and used by + <command>gethostbyname(3)</command> functions. Names are + resolved through the WINS server or by broadcast. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>passwd</term> + <listitem><para>User information traditionally stored in + the <filename>passwd(5)</filename> file and used by + <command>getpwent(3)</command> functions. </para></listitem> + </varlistentry> + + <varlistentry> + <term>group</term> + <listitem><para>Group information traditionally stored in + the <filename>group(5)</filename> file and used by + <command>getgrent(3)</command> functions. </para></listitem> + </varlistentry> + </variablelist> + + <para>For example, the following simple configuration in the + <filename>/etc/nsswitch.conf</filename> file can be used to initially + resolve user and group information from <filename>/etc/passwd + </filename> and <filename>/etc/group</filename> and then from the + Windows NT server. +<programlisting> +passwd: files winbind +group: files winbind +</programlisting></para> + + <para>The following simple configuration in the + <filename>/etc/nsswitch.conf</filename> file can be used to initially + resolve hostnames from <filename>/etc/hosts</filename> and then from the + WINS server.</para> + +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-F</term> + <listitem><para>If specified, this parameter causes + the main <command>winbindd</command> process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + <command>winbindd</command> under process supervisors such + as <command>supervise</command> and <command>svscan</command> + from Daniel J. Bernstein's <command>daemontools</command> + package, or the AIX process monitor. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-S</term> + <listitem><para>If specified, this parameter causes + <command>winbindd</command> to log to standard output rather + than a file.</para></listitem> + </varlistentry> + + &popt.common.samba; + &stdarg.help; + + <varlistentry> + <term>-i</term> + <listitem><para>Tells <command>winbindd</command> to not + become a daemon and detach from the current terminal. This + option is used by developers when interactive debugging + of <command>winbindd</command> is required. + <command>winbindd</command> also logs to standard output, + as if the <command>-S</command> parameter had been given. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-n</term> + <listitem><para>Disable caching. This means winbindd will + always have to wait for a response from the domain controller + before it can respond to a client and this thus makes things + slower. The results will however be more accurate, since + results from the cache might not be up-to-date. This + might also temporarily hang winbindd if the DC doesn't respond. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-B</term> + <listitem><para>Dual daemon mode. This means winbindd will run + as 2 threads. The first will answer all requests from the cache, + thus making responses to clients faster. The other will + update the cache for the query that the first has just responded. + Advantage of this is that responses stay accurate and are faster. + </para></listitem> + </varlistentry> + + </variablelist> +</refsect1> + + +<refsect1> + <title>NAME AND ID RESOLUTION</title> + + <para>Users and groups on a Windows NT server are assigned + a relative id (rid) which is unique for the domain when the + user or group is created. To convert the Windows NT user or group + into a unix user or group, a mapping between rids and unix user + and group ids is required. This is one of the jobs that <command> + winbindd</command> performs. </para> + + <para>As winbindd users and groups are resolved from a server, user + and group ids are allocated from a specified range. This + is done on a first come, first served basis, although all existing + users and groups will be mapped as soon as a client performs a user + or group enumeration command. The allocated unix ids are stored + in a database file under the Samba lock directory and will be + remembered. </para> + + <para>WARNING: The rid to unix id database is the only location + where the user and group mappings are stored by winbindd. If this + file is deleted or corrupted, there is no way for winbindd to + determine which user and group ids correspond to Windows NT user + and group rids. </para> +</refsect1> + + +<refsect1> + <title>CONFIGURATION</title> + + <para>Configuration of the <command>winbindd</command> daemon + is done through configuration parameters in the <citerefentry> + <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> file. All parameters should be specified in the + [global] section of smb.conf. </para> + + <itemizedlist> + <listitem><para><ulink url="smb.conf.5.html#WINBINDSEPARATOR"> + <parameter>winbind separator</parameter></ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#WINBINDUID"> + <parameter>winbind uid</parameter></ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#WINBINDGID"> + <parameter>winbind gid</parameter></ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#WINBINDCACHETIME"> + <parameter>winbind cache time</parameter></ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#WINBINDENUMUSERS"> + <parameter>winbind enum users</parameter></ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#WINBINDENUMGROUPS"> + <parameter>winbind enum groups</parameter></ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#TEMPLATEHOMEDIR"> + <parameter>template homedir</parameter></ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#TEMPLATESHELL"> + <parameter>template shell</parameter></ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#WINBINDUSEDEFAULTDOMAIN"> + <parameter>winbind use default domain</parameter></ulink></para></listitem> + </itemizedlist> +</refsect1> + + +<refsect1> + <title>EXAMPLE SETUP</title> + + <para>To setup winbindd for user and group lookups plus + authentication from a domain controller use something like the + following setup. This was tested on a RedHat 6.2 Linux box. </para> + + <para>In <filename>/etc/nsswitch.conf</filename> put the + following: +<programlisting> +passwd: files winbind +group: files winbind +</programlisting></para> + + <para>In <filename>/etc/pam.d/*</filename> replace the <parameter> + auth</parameter> lines with something like this: +<programlisting> +auth required /lib/security/pam_securetty.so +auth required /lib/security/pam_nologin.so +auth sufficient /lib/security/pam_winbind.so +auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok +</programlisting></para> + + + <para>Note in particular the use of the <parameter>sufficient + </parameter> keyword and the <parameter>use_first_pass</parameter> keyword. </para> + + <para>Now replace the account lines with this: </para> + + <para><command>account required /lib/security/pam_winbind.so + </command></para> + + <para>The next step is to join the domain. To do that use the + <command>net</command> program like this: </para> + + <para><command>net join -S PDC -U Administrator</command></para> + + <para>The username after the <parameter>-U</parameter> can be any + Domain user that has administrator privileges on the machine. + Substitute the name or IP of your PDC for "PDC".</para> + + <para>Next copy <filename>libnss_winbind.so</filename> to + <filename>/lib</filename> and <filename>pam_winbind.so + </filename> to <filename>/lib/security</filename>. A symbolic link needs to be + made from <filename>/lib/libnss_winbind.so</filename> to + <filename>/lib/libnss_winbind.so.2</filename>. If you are using an + older version of glibc then the target of the link should be + <filename>/lib/libnss_winbind.so.1</filename>.</para> + + <para>Finally, setup a <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> containing directives like the + following: +<programlisting> +[global] + winbind separator = + + winbind cache time = 10 + template shell = /bin/bash + template homedir = /home/%D/%U + winbind uid = 10000-20000 + winbind gid = 10000-20000 + workgroup = DOMAIN + security = domain + password server = * +</programlisting></para> + + + <para>Now start winbindd and you should find that your user and + group database is expanded to include your NT users and groups, + and that you can login to your unix box as a domain user, using + the DOMAIN+user syntax for the username. You may wish to use the + commands <command>getent passwd</command> and <command>getent group + </command> to confirm the correct operation of winbindd.</para> +</refsect1> + + +<refsect1> + <title>NOTES</title> + + <para>The following notes are useful when configuring and + running <command>winbindd</command>: </para> + + <para><citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> must be running on the local machine + for <command>winbindd</command> to work. <command>winbindd</command> queries + the list of trusted domains for the Windows NT server + on startup and when a SIGHUP is received. Thus, for a running <command> + winbindd</command> to become aware of new trust relationships between + servers, it must be sent a SIGHUP signal. </para> + + <para>PAM is really easy to misconfigure. Make sure you know what + you are doing when modifying PAM configuration files. It is possible + to set up PAM such that you can no longer log into your system. </para> + + <para>If more than one UNIX machine is running <command>winbindd</command>, + then in general the user and groups ids allocated by winbindd will not + be the same. The user and group ids will only be valid for the local + machine.</para> + + <para>If the the Windows NT RID to UNIX user and group id mapping + file is damaged or destroyed then the mappings will be lost. </para> +</refsect1> + + +<refsect1> + <title>SIGNALS</title> + + <para>The following signals can be used to manipulate the + <command>winbindd</command> daemon. </para> + + <variablelist> + <varlistentry> + <term>SIGHUP</term> + <listitem><para>Reload the <citerefentry><refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry> file and + apply any parameter changes to the running + version of winbindd. This signal also clears any cached + user and group information. The list of other domains trusted + by winbindd is also reloaded. </para></listitem> + </varlistentry> + + <varlistentry> + <term>SIGUSR1</term> + <listitem><para>The SIGUSR1 signal will cause <command> + winbindd</command> to write status information to the winbind + log file including information about the number of user and + group ids allocated by <command>winbindd</command>.</para> + + <para>Log files are stored in the filename specified by the + log file parameter.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + +<refsect1> + <title>FILES</title> + + <variablelist> + <varlistentry> + <term><filename>/etc/nsswitch.conf(5)</filename></term> + <listitem><para>Name service switch configuration file.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>/tmp/.winbindd/pipe</term> + <listitem><para>The UNIX pipe over which clients communicate with + the <command>winbindd</command> program. For security reasons, the + winbind client will only attempt to connect to the winbindd daemon + if both the <filename>/tmp/.winbindd</filename> directory + and <filename>/tmp/.winbindd/pipe</filename> file are owned by + root. </para></listitem> + </varlistentry> + + <varlistentry> + <term>$LOCKDIR/winbindd_privilaged/pipe</term> + <listitem><para>The UNIX pipe over which 'privilaged' clients + communicate with the <command>winbindd</command> program. For security + reasons, access to some winbindd functions - like those needed by + the <command>ntlm_auth</command> utility - is restricted. By default, + only users in the 'root' group will get this access, however the administrator + may change the group permissions on $LOCKDIR/winbindd_privilaged to allow + programs like 'squid' to use ntlm_auth. + Note that the winbind client will only attempt to connect to the winbindd daemon + if both the <filename>$LOCKDIR/winbindd_privilaged</filename> directory + and <filename>$LOCKDIR/winbindd_privilaged/pipe</filename> file are owned by + root. </para></listitem> + </varlistentry> + + <varlistentry> + <term>/lib/libnss_winbind.so.X</term> + <listitem><para>Implementation of name service switch library. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>$LOCKDIR/winbindd_idmap.tdb</term> + <listitem><para>Storage for the Windows NT rid to UNIX user/group + id mapping. The lock directory is specified when Samba is initially + compiled using the <parameter>--with-lockdir</parameter> option. + This directory is by default <filename>/usr/local/samba/var/locks + </filename>. </para></listitem> + </varlistentry> + + <varlistentry> + <term>$LOCKDIR/winbindd_cache.tdb</term> + <listitem><para>Storage for cached user and group information. + </para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + + <para><filename>nsswitch.conf(5)</filename>, <citerefentry> + <refentrytitle>Samba</refentrytitle> + <manvolnum>7</manvolnum></citerefentry>, <citerefentry> + <refentrytitle>wbinfo</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <citerefentry> + <refentrytitle>smb.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry></para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para><command>wbinfo</command> and <command>winbindd</command> were + written by Tim Potter.</para> + + <para>The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.</para> +</refsect1> + +</refentry> diff --git a/docs/docbook/projdoc/ADS-HOWTO.xml b/docs/docbook/projdoc/ADS-HOWTO.xml new file mode 100644 index 0000000000..c89a0e4f87 --- /dev/null +++ b/docs/docbook/projdoc/ADS-HOWTO.xml @@ -0,0 +1,167 @@ +<chapter id="ADS"> + +<chapterinfo> + &author.tridge; + &author.jelmer; + <pubdate>2002/2003</pubdate> +</chapterinfo> + +<title>Samba as a ADS domain member</title> + +<para> +This is a rough guide to setting up Samba 3.0 with kerberos authentication against a +Windows2000 KDC. +</para> + +<sect1> +<title>Setup your <filename>smb.conf</filename></title> + +<para>You must use at least the following 3 options in smb.conf:</para> + +<para><programlisting> + realm = YOUR.KERBEROS.REALM + security = ADS + encrypt passwords = yes +</programlisting></para> + +<para> +In case samba can't figure out your ads server using your realm name, use the +<command>ads server</command> option in <filename>smb.conf</filename>: +<programlisting> + ads server = your.kerberos.server +</programlisting> +</para> + +<note><para>You do *not* need a smbpasswd file, and older clients will + be authenticated as if <command>security = domain</command>, + although it won't do any harm + and allows you to have local users not in the domain. + I expect that the above required options will change soon when we get better + active directory integration.</para></note> + +</sect1> + +<sect1> +<title>Setup your <filename>/etc/krb5.conf</filename></title> + +<para>Note: you will need the krb5 workstation, devel, and libs installed</para> + +<para>The minimal configuration for <filename>krb5.conf</filename> is:</para> + +<para><programlisting> + [realms] + YOUR.KERBEROS.REALM = { + kdc = your.kerberos.server + } +</programlisting></para> + +<para>Test your config by doing a <userinput>kinit +<replaceable>USERNAME</replaceable>@<replaceable>REALM</replaceable></userinput> and +making sure that your password is accepted by the Win2000 KDC. +</para> + +<note><para>The realm must be uppercase or you will get "Cannot find KDC for requested +realm while getting initial credentials" error </para></note> + +<note><para>Time between the two servers must be synchronized. You will get a +"kinit(v5): Clock skew too great while getting initial credentials" if the time +difference is more than five minutes. </para></note> + +<para> +You also must ensure that you can do a reverse DNS lookup on the IP +address of your KDC. Also, the name that this reverse lookup maps to +must either be the netbios name of the KDC (ie. the hostname with no +domain attached) or it can alternatively be the netbios name +followed by the realm. +</para> + +<para> +The easiest way to ensure you get this right is to add a +<filename>/etc/hosts</filename> entry mapping the IP address of your KDC to +its netbios name. If you don't get this right then you will get a +"local error" when you try to join the realm. +</para> + +<para> +If all you want is kerberos support in &smbclient; then you can skip +straight to <link linkend="ads-test-smbclient">Test with &smbclient;</link> now. +<link linkend="ads-create-machine-account">Creating a computer account</link> +and <link linkend="ads-test-server">testing your servers</link> +is only needed if you want kerberos support for &smbd; and &winbindd;. +</para> + +</sect1> + +<sect1 id="ads-create-machine-account"> +<title>Create the computer account</title> + +<para> +As a user that has write permission on the Samba private directory +(usually root) run: +<programlisting> + <userinput>net join -U Administrator%password</userinput> +</programlisting> +</para> + +<sect2> +<title>Possible errors</title> + +<para> +<variablelist> + <varlistentry><term>"ADS support not compiled in"</term> + <listitem><para>Samba must be reconfigured (remove config.cache) and recompiled + (make clean all install) after the kerberos libs and headers are installed. + </para></listitem></varlistentry> + + <varlistentry><term>net join prompts for user name</term> + <listitem><para>You need to login to the domain using <userinput>kinit + <replaceable>USERNAME</replaceable>@<replaceable>REALM</replaceable></userinput>. + <replaceable>USERNAME</replaceable> must be a user who has rights to add a machine + to the domain. </para></listitem></varlistentry> +</variablelist> +</para> + +</sect2> + +</sect1> + +<sect1 id="ads-test-server"> +<title>Test your server setup</title> + +<para> +If the join was successful, you will see a new computer account with the +NetBIOS name of your Samba server in Active Directory (in the "Computers" +folder under Users and Computers. +</para> + +<para> +On a Windows 2000 client try <userinput>net use * \\server\share</userinput>. You should +be logged in with kerberos without needing to know a password. If +this fails then run <userinput>klist tickets</userinput>. Did you get a ticket for the +server? Does it have an encoding type of DES-CBC-MD5 ? +</para> + +</sect1> + +<sect1 id="ads-test-smbclient"> +<title>Testing with &smbclient;</title> + +<para> +On your Samba server try to login to a Win2000 server or your Samba +server using &smbclient; and kerberos. Use &smbclient; as usual, but +specify the <parameter>-k</parameter> option to choose kerberos authentication. +</para> + +</sect1> + +<sect1> +<title>Notes</title> + +<para>You must change administrator password at least once after DC +install, to create the right encoding types</para> + +<para>w2k doesn't seem to create the _kerberos._udp and _ldap._tcp in + their defaults DNS setup. Maybe fixed in service packs?</para> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/AdvancedNetworkAdmin.xml b/docs/docbook/projdoc/AdvancedNetworkAdmin.xml new file mode 100644 index 0000000000..dc2a78f5a6 --- /dev/null +++ b/docs/docbook/projdoc/AdvancedNetworkAdmin.xml @@ -0,0 +1,291 @@ +<chapter id="AdvancedNetworkManagement"> +<chapterinfo> + &author.jht; + <pubdate>April 3 2003</pubdate> +</chapterinfo> + +<title>Advanced Network Manangement</title> + +<para> +This section attempts to document peripheral issues that are of great importance to network +administrators who want to improve network resource access control, to automate the user +environment, and to make their lives a little easier. +</para> + +<sect1> +<title>Configuring Samba Share Access Controls</title> + +<para> +This section deals with how to configure Samba per share access control restrictions. +By default samba sets no restrictions on the share itself. Restrictions on the share itself +can be set on MS Windows NT4/200x/XP shares. This can be a very effective way to limit who can +connect to a share. In the absence of specific restrictions the default setting is to allow +the global user <emphasis>Everyone</emphasis> Full Control (ie: Full control, Change and Read). +</para> + +<para> +At this time Samba does NOT provide a tool for configuring access control setting on the Share +itself. Samba does have the capacity to store and act on access control settings, but the only +way to create those settings is to use either the NT4 Server Manager or the Windows 200x MMC for +Computer Management. +</para> + +<para> +Samba stores the per share access control settings in a file called <filename>share_info.tdb</filename>. +The location of this file on your system will depend on how samba was compiled. The default location +for samba's tdb files is under <filename>/usr/local/samba/var</filename>. If the <filename>tdbdump</filename> +utility has been compiled and installed on your system then you can examine the contents of this file +by: <userinput>tdbdump share_info.tdb</userinput>. +</para> + +<sect2> +<title>Share Permissions Management</title> + +<para> +The best tool for the task is platform dependant. Choose the best tool for your environmemt. +</para> + +<sect3> +<title>Windows NT4 Workstation/Server</title> +<para> +The tool you need to use to manage share permissions on a Samba server is the NT Server Manager. +Server Manager is shipped with Windows NT4 Server products but not with Windows NT4 Workstation. +You can obtain the NT Server Manager for MS Windows NT4 Workstation from Microsoft - see details below. +</para> + +<procedure> +<title>Instructions</title> +<step><para> +Launch the NT4 Server Manager, click on the Samba server you want to administer, then from the menu +select Computer, then click on the Shared Directories entry. +</para></step> + +<step><para> + Now click on the share that you wish to manage, then click on the Properties tab, next click on + the Permissions tab. Now you can Add or change access control settings as you wish. +</para></step> +</procedure> + +</sect3> + +<sect3> +<title>Windows 200x/XP</title> + +<para> +On MS Windows NT4/200x/XP system access control lists on the share itself are set using native +tools, usually from filemanager. For example, in Windows 200x: right click on the shared folder, +then select 'Sharing', then click on 'Permissions'. The default Windows NT4/200x permission allows +<emphasis>Everyone</emphasis> Full Control on the Share. +</para> + +<para> +MS Windows 200x and later all comes with a tool called the 'Computer Management' snap-in for the +Microsoft Management Console (MMC). This tool is located by clicking on <filename>Control Panel -> +Administrative Tools -> Computer Management</filename>. +</para> + +<procedure> +<title>Instructions</title> +<step><para> + After launching the MMC with the Computer Management snap-in, click on the menu item 'Action', + select 'Connect to another computer'. If you are not logged onto a domain you will be prompted + to enter a domain login user identifier and a password. This will authenticate you to the domain. + If you where already logged in with administrative privilidge this step is not offered. +</para></step> + +<step><para> +If the Samba server is not shown in the Select Computer box, then type in the name of the target +Samba server in the field 'Name:'. Now click on the [+] next to 'System Tools', then on the [+] +next to 'Shared Folders' in the left panel. +</para></step> + +<step><para> +Now in the right panel, double-click on the share you wish to set access control permissions on. +Then click on the tab 'Share Permissions'. It is now possible to add access control entities +to the shared folder. Do NOT forget to set what type of access (full control, change, read) you +wish to assign for each entry. +</para></step> +</procedure> + +<warning> +<para> +Be careful. If you take away all permissions from the Everyone user without removing this user +then effectively no user will be able to access the share. This is a result of what is known as +ACL precidence. ie: Everyone with NO ACCESS means that MaryK who is part of the group Everyone +will have no access even if this user is given explicit full control access. +</para> +</warning> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>Remote Server Administration</title> + +<para> +<emphasis>How do I get 'User Manager' and 'Server Manager'?</emphasis> +</para> + +<para> +Since I don't need to buy an NT4 Server, how do I get the 'User Manager for Domains', +the 'Server Manager'? +</para> + +<para> +Microsoft distributes a version of these tools called nexus for installation on Windows 9x / Me +systems. The tools set includes: +</para> + +<itemizedlist> + <listitem><para>Server Manager</para></listitem> + <listitem><para>User Manager for Domains</para></listitem> + <listitem><para>Event Viewer</para></listitem> +</itemizedlist> + +<para> +Click here to download the archived file <ulink +url="ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE">ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE</ulink> +</para> + +<para> +The Windows NT 4.0 version of the 'User Manager for +Domains' and 'Server Manager' are available from Microsoft via ftp +from <ulink url="ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE">ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE</ulink> +</para> + +</sect1> +<sect1> +<title>Network Logon Script Magic</title> + +<para> +This section needs work. Volunteer contributions most welcome. Please send your patches or updates +to <ulink url="mailto:jht@samba.org">John Terpstra</ulink>. +</para> + +<para> +There are several opportunities for creating a custom network startup configuration environment. +</para> + +<simplelist> + <member>No Logon Script</member> + <member>Simple universal Logon Script that applies to all users</member> + <member>Use of a conditional Logon Script that applies per user or per group attirbutes</member> + <member>Use of Samba's Preexec and Postexec functions on access to the NETLOGON share to create + a custom Logon Script and then execute it.</member> + <member>User of a tool such as KixStart</member> +</simplelist> + +<para> +The Samba source code tree includes two logon script generation/execution tools. See <filename>examples</filename> directory <filename>genlogon</filename> and <filename>ntlogon</filename> subdirectories. +</para> + +<para> +The following listings are from the genlogon directory. +</para> + +<para> +This is the genlogon.pl file: + +<programlisting> + #!/usr/bin/perl + # + # genlogon.pl + # + # Perl script to generate user logon scripts on the fly, when users + # connect from a Windows client. This script should be called from smb.conf + # with the %U, %G and %L parameters. I.e: + # + # root preexec = genlogon.pl %U %G %L + # + # The script generated will perform + # the following: + # + # 1. Log the user connection to /var/log/samba/netlogon.log + # 2. Set the PC's time to the Linux server time (which is maintained + # daily to the National Institute of Standard's Atomic clock on the + # internet. + # 3. Connect the user's home drive to H: (H for Home). + # 4. Connect common drives that everyone uses. + # 5. Connect group-specific drives for certain user groups. + # 6. Connect user-specific drives for certain users. + # 7. Connect network printers. + + # Log client connection + #($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time); + ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time); + open LOG, ">>/var/log/samba/netlogon.log"; + print LOG "$mon/$mday/$year $hour:$min:$sec - User $ARGV[0] logged into $ARGV[1]\n"; + close LOG; + + # Start generating logon script + open LOGON, ">/shared/netlogon/$ARGV[0].bat"; + print LOGON "\@ECHO OFF\r\n"; + + # Connect shares just use by Software Development group + if ($ARGV[1] eq "SOFTDEV" || $ARGV[0] eq "softdev") + { + print LOGON "NET USE M: \\\\$ARGV[2]\\SOURCE\r\n"; + } + + # Connect shares just use by Technical Support staff + if ($ARGV[1] eq "SUPPORT" || $ARGV[0] eq "support") + { + print LOGON "NET USE S: \\\\$ARGV[2]\\SUPPORT\r\n"; + } + + # Connect shares just used by Administration staff + If ($ARGV[1] eq "ADMIN" || $ARGV[0] eq "admin") + { + print LOGON "NET USE L: \\\\$ARGV[2]\\ADMIN\r\n"; + print LOGON "NET USE K: \\\\$ARGV[2]\\MKTING\r\n"; + } + + # Now connect Printers. We handle just two or three users a little + # differently, because they are the exceptions that have desktop + # printers on LPT1: - all other user's go to the LaserJet on the + # server. + if ($ARGV[0] eq 'jim' + || $ARGV[0] eq 'yvonne') + { + print LOGON "NET USE LPT2: \\\\$ARGV[2]\\LJET3\r\n"; + print LOGON "NET USE LPT3: \\\\$ARGV[2]\\FAXQ\r\n"; + } + else + { + print LOGON "NET USE LPT1: \\\\$ARGV[2]\\LJET3\r\n"; + print LOGON "NET USE LPT3: \\\\$ARGV[2]\\FAXQ\r\n"; + } + + # All done! Close the output file. + close LOGON; +</programlisting> +</para> + +<para> +Those wishing to use more elaborate or capable logon processing system should check out the following sites: +</para> + +<simplelist> + <member>http://www.craigelachie.org/rhacer/ntlogon</member> + <member>http://www.kixtart.org</member> + <member>http://support.microsoft.com/default.asp?scid=kb;en-us;189105</member> +</simplelist> + +<sect2> +<title>Adding printers without user intervention</title> + +<para> +Printers may be added automatically during logon script processing through the use of: + +<programlisting> + rundll32 printui.dll,PrintUIEntry /? +</programlisting> + +See the documentation in the Microsoft knowledgebase article no: 189105 referred to above. +</para> +</sect2> + +</sect1> +</chapter> + diff --git a/docs/docbook/projdoc/Bugs.xml b/docs/docbook/projdoc/Bugs.xml new file mode 100644 index 0000000000..d782920457 --- /dev/null +++ b/docs/docbook/projdoc/Bugs.xml @@ -0,0 +1,201 @@ +<chapter id="bugreport"> + +<chapterinfo> + &author.jelmer; + <author> + <affiliation> + <orgname>Samba Team</orgname> + </affiliation> + </author> + <pubdate> 27 June 1997 </pubdate> +</chapterinfo> + +<title>Reporting Bugs</title> + +<sect1> +<title>Introduction</title> + +<para>Please report bugs using <ulink url="https://bugzilla.samba.org/">bugzilla</ulink>.</para> + +<para> +Please take the time to read this file before you submit a bug +report. Also, please see if it has changed between releases, as we +may be changing the bug reporting mechanism at some time. +</para> + +<para> +Please also do as much as you can yourself to help track down the +bug. Samba is maintained by a dedicated group of people who volunteer +their time, skills and efforts. We receive far more mail about it than +we can possibly answer, so you have a much higher chance of an answer +and a fix if you send us a "developer friendly" bug report that lets +us fix it fast. +</para> + +<para> +Do not assume that if you post the bug to the comp.protocols.smb +newsgroup or the mailing list that we will read it. If you suspect that your +problem is not a bug but a configuration problem then it is better to send +it to the Samba mailing list, as there are (at last count) 5000 other users on +that list that may be able to help you. +</para> + +<para> +You may also like to look though the recent mailing list archives, +which are conveniently accessible on the Samba web pages +at <ulink url="http://samba.org/samba/">http://samba.org/samba/</ulink>. +</para> + +</sect1> + +<sect1> +<title>General info</title> + +<para> +Before submitting a bug report check your config for silly +errors. Look in your log files for obvious messages that tell you that +you've misconfigured something and run testparm to test your config +file for correct syntax. +</para> + +<para> +Have you run through the <link linkend="diagnosis">diagnosis</link>? +This is very important. +</para> + +<para> +If you include part of a log file with your bug report then be sure to +annotate it with exactly what you were doing on the client at the +time, and exactly what the results were. +</para> + +</sect1> + +<sect1> +<title>Debug levels</title> + +<para> +If the bug has anything to do with Samba behaving incorrectly as a +server (like refusing to open a file) then the log files will probably +be very useful. Depending on the problem a log level of between 3 and +10 showing the problem may be appropriate. A higher level givesmore +detail, but may use too much disk space. +</para> + +<para> +To set the debug level use <command>log level =</command> in your +&smb.conf;. You may also find it useful to set the log +level higher for just one machine and keep separate logs for each machine. +To do this use: +</para> + +<para><programlisting> +log level = 10 +log file = /usr/local/samba/lib/log.%m +include = /usr/local/samba/lib/smb.conf.%m +</programlisting></para> + +<para> +then create a file +<filename>/usr/local/samba/lib/smb.conf.<replaceable>machine</replaceable></filename> where +<replaceable>machine</replaceable> is the name of the client you wish to debug. In that file +put any &smb.conf; commands you want, for example +<command>log level=</command> may be useful. This also allows you to +experiment with different security systems, protocol levels etc on just +one machine. +</para> + +<para> +The &smb.conf; entry <command>log level =</command> +is synonymous with the entry <command>debuglevel =</command> that has been +used in older versions of Samba and is being retained for backwards +compatibility of &smb.conf; files. +</para> + +<para> +As the <command>log level =</command> value is increased you will record +a significantly increasing level of debugging information. For most +debugging operations you may not need a setting higher than 3. Nearly +all bugs can be tracked at a setting of 10, but be prepared for a VERY +large volume of log data. +</para> + +</sect1> + +<sect1> +<title>Internal errors</title> + +<para> +If you get a "INTERNAL ERROR" message in your log files it means that +Samba got an unexpected signal while running. It is probably a +segmentation fault and almost certainly means a bug in Samba (unless +you have faulty hardware or system software). +</para> + +<para> +If the message came from smbd then it will probably be accompanied by +a message which details the last SMB message received by smbd. This +info is often very useful in tracking down the problem so please +include it in your bug report. +</para> + +<para> +You should also detail how to reproduce the problem, if +possible. Please make this reasonably detailed. +</para> + +<para> +You may also find that a core file appeared in a <filename>corefiles</filename> +subdirectory of the directory where you keep your samba log +files. This file is the most useful tool for tracking down the bug. To +use it you do this: +</para> + +<para><command>gdb smbd core</command></para> + +<para> +adding appropriate paths to smbd and core so gdb can find them. If you +don't have gdb then try <userinput>dbx</userinput>. Then within the debugger use the +command <userinput>where</userinput> to give a stack trace of where the problem +occurred. Include this in your mail. +</para> + +<para> +If you know any assembly language then do a <userinput>disass</userinput> of the routine +where the problem occurred (if its in a library routine then +disassemble the routine that called it) and try to work out exactly +where the problem is by looking at the surrounding code. Even if you +don't know assembly then incuding this info in the bug report can be +useful. +</para> +</sect1> + +<sect1> +<title>Attaching to a running process</title> + +<para> +Unfortunately some unixes (in particular some recent linux kernels) +refuse to dump a core file if the task has changed uid (which smbd +does often). To debug with this sort of system you could try to attach +to the running process using <userinput>gdb smbd <replaceable>PID</replaceable></userinput> where you get <replaceable>PID</replaceable> from +<application>smbstatus</application>. Then use <userinput>c</userinput> to continue and try to cause the core dump +using the client. The debugger should catch the fault and tell you +where it occurred. +</para> + +</sect1> + +<sect1> +<title>Patches</title> + +<para> +The best sort of bug report is one that includes a fix! If you send us +patches please use <userinput>diff -u</userinput> format if your version of +diff supports it, otherwise use <userinput>diff -c4</userinput>. Make sure +you do the diff against a clean version of the source and let me know +exactly what version you used. +</para> + +</sect1> +</chapter> + diff --git a/docs/docbook/projdoc/CUPS-printing.xml b/docs/docbook/projdoc/CUPS-printing.xml new file mode 100644 index 0000000000..7e302000e6 --- /dev/null +++ b/docs/docbook/projdoc/CUPS-printing.xml @@ -0,0 +1,1793 @@ +<chapter id="CUPS-printing"> + + +<chapterinfo> + &author.jht; + <author> + <firstname>Kurt</firstname><surname>Pfeifle</surname> + <affiliation> + <address><email>kpfeifle@danka.de</email></address> + </affiliation> + </author> + <pubdate> (25 March 2003) </pubdate> +</chapterinfo> + +<title>CUPS Printing Support</title> + +<sect1> +<title>Introduction</title> + +<para> +The Common Unix Print System (CUPS) has become very popular, but to many it is +a very mystical tool. There is a great deal of uncertainty regarding CUPS and how +it works. The result is seen in a large number of posting on the samba mailing lists +expressing frustration when MS Windows printers appear not to work with a CUPS +backr-end. +</para> + +<para> +This is a good time to point out how CUPS can be used and what it does. CUPS is more +than just a print spooling system - it is a complete printer management system that +complies with HTTP and IPP protocols. It can be managed remotely via a web browser +and it can print using http and ipp protocols. +</para> + +<para> +CUPS allows to creation of RAW printers (ie: NO file format translation) as well as +SMART printers (ie: CUPS does file format conversion as required for the printer). In +many ways this gives CUPS similar capabilities to the MS Windows print monitoring +system. Of course, if you are a CUPS advocate, you would agrue that CUPS is better! +In any case, let us now move on to explore how one may configure CUPS for interfacing +with MS Windows print clients via Samba. +</para> + +<para> +<ulink url="http://www.cups.org/">CUPS</ulink> is a newcomer in the UNIX printing scene, +which has convinced many people upon first trial already. However, it has quite a few +new features, which make it different from other, more traditional printing systems. +</para> + +</sect1> + +<sect1> +<title>Configuring &smb.conf; for CUPS</title> + +<para> +Printing with CUPS in the most basic &smb.conf; +setup in Samba-3 only needs two settings: <command>printing = cups</command> and +<command>printcap = cups</command>. While CUPS itself doesn't need a printcap +anymore, the <filename>cupsd.conf</filename> configuration file knows two directives +(example: <command>Printcap /etc/printcap</command> and <command>PrintcapFormat +BSD</command>), which control if such a file should be created for the +convenience of third party applications. Make sure it is set! For details see +<command>man cupsd.conf</command> and other CUPS-related documentation. +</para> + +<para> +If SAMBA is compiled against libcups, then <command>printcap = cups</command> uses the +CUPS API to list printers, submit jobs, etc. Otherwise it maps to the System V commands +with an additional <parameter>-oraw</parameter> option for printing. On a Linux system, +you can use the <command>ldd</command> command to find out details (ldd may not be +present on other OS platforms, or its function may be embodied by a different command): +</para> + +<para> +<programlisting>transmeta:/home/kurt # ldd `which smbd` + libssl.so.0.9.6 => /usr/lib/libssl.so.0.9.6 (0x4002d000) + libcrypto.so.0.9.6 => /usr/lib/libcrypto.so.0.9.6 (0x4005a000) + libcups.so.2 => /usr/lib/libcups.so.2 (0x40123000) + libdl.so.2 => /lib/libdl.so.2 (0x401e8000) + libnsl.so.1 => /lib/libnsl.so.1 (0x401ec000) + libpam.so.0 => /lib/libpam.so.0 (0x40202000) + libc.so.6 => /lib/libc.so.6 (0x4020b000) + /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0x40000000) +</programlisting></para> + +<para> +The line "libcups.so.2 => /usr/lib/libcups.so.2 +(0x40123000)" shows there is CUPS support compiled into this version of +Samba. If this is the case, and <command>printing = cups</command> is set, then any +otherwise manually set print command in &smb.conf; is ignored. +</para> +</sect1> + +<sect1> +<title>CUPS - RAW Print Through Mode</title> + +<note> +<para> +When used in raw print through mode is will be necessary to use the printer +vendor's drivers in each Windows client PC. +</para> +</note> + +<para> +When CUPS printers are configured for RAW print-through mode operation it is the +responsibility of the Samba client to fully render the print job (file) in a format +that is suitable for direct delivery to the printer. In this case CUPS will NOT +do any print file format conversion work. +</para> + +<para> +The CUPS files that need to be correctly set for RAW mode printers to work are: + +<itemizedlist> + <listitem><para><filename>/etc/cups/mime.types</filename></para></listitem> + <listitem><para><filename>/etc/cups/mime.convs</filename></para></listitem> +</itemizedlist> + +Both contain entries that must be uncommented to allow <emphasis>RAW</emphasis> mode +operation. +</para> + +<para> +Firstly, to enable CUPS based printing from Samba the following options must be +enabled in your &smb.conf; file [globals] section: + +<itemizedlist> + <listitem><para>printing = CUPS</para></listitem> + + <listitem><para>printcap = CUPS</para></listitem> +</itemizedlist> + +When these parameters are specified the print directives in &smb.conf; (as well as in +samba itself) will be ignored because samba will directly interface with CUPS through +it's application program interface (API) - so long as Samba has been compiled with +CUPS library (libcups) support. If samba has NOT been compiled with CUPS support then +printing will use the System V AT&T command set with the <emphasis>-oraw</emphasis> +option automatically passing through. +</para> + +<para> +Cupsomatic (an enhanced printing utility that is part of some CUPS implementations) +on the Samba/CUPS server does *not* add any features if a file is really +printed "raw". However, if you have loaded the driver for the Windows client from +the CUPS server, using the "cupsaddsmb" utility, and if this driver is one using +a "Foomatic" PPD, the PJL header in question is already added on the Windows client, +at the time when the driver initially generated the PostScript data and CUPS in true +"-oraw" manner doesn't remove this PJL header and passes the file "as is" to its +printer communication backend. +</para> + +<note><para>NOTE: editing in the "mime.convs" and the "mime.types" file does not *enforce* +"raw" printing, it only *allows* it.</para></note> + +<para> +Print files that arrive from MS Windows printing are "auto-typed" by CUPS. This aids +the process of determining proper treatment while in the print queue system. + +<itemizedlist> + <listitem><para> + Files generated by PCL drivers and directed at PCK printers get auto-typed as + <filename>application/octet-stream</filename>. Unknown file format types also + get auto-typed with this tag. + </para></listitem> + + <listitem><para> + Files generated by a Postscript driver and directed at a Postscript printer + are auto-typed depending on the auto-detected most suitable MIME type as: + + <itemizedlist> + <listitem><para>* application/postscript</para></listitem> + <listitem><para>* application/vnd.cups-postscript</para></listitem> + </itemizedlist> + </para> + </listitem> +</itemizedlist> +</para> + + +<para> +"application/postscript" first goes thru the "pstops" filter (where the page counting +and accounting takes place). The outcome will be of MIME type +"application/vnd.cups-postscript". The pstopsfilter reads and uses information from +the PPD and inserts user-provided options into the PostScript file. As a consequence, +the filtered file could possibly have an unwanted PJL header. +</para> + +<para> +"application/postscript" will be all files with a ".ps", ".ai", ".eps" suffix or which +have as their first character string one of "%!" or ">04<%". +</para> + +<para> +"application/vnd.cups-postscript" will files which contain the string +"LANGUAGE=POSTSCRIPT" (or similar variations with different capitalization) in the +first 512 bytes, and also contain the "PJL super escape code" in the first 128 bytes +(">1B<%-12345X"). Very likely, most PostScript files generated on Windows using a CUPS +or other PPD, will have to be auto-typed as "vnd.cups-postscript". A file produced +with a "Generic PostScript driver" will just be tagged "application/postscript". +</para> + +<para> +Once the file is in "application/vnd.cups-postscript" format, either "pstoraster" +or "cupsomatic" will take over (depending on the printer configuration, as +determined by the PPD in use). +</para> + +<note><para> +A printer queue with *no* PPD associated to it is a "raw" printer and all files +will go directly there as received by the spooler. The exeptions are file types +"application/octet-stream" which need "passthrough feature" enabled. +"Raw" queues don't do any filtering at all, they hand the file directly to the +CUPS backend. This backend is responsible for the sending of the data to the device +(as in the "device URI" notation as lpd://, socket://, smb://, ipp://, http://, +parallel:/, serial:/, usb:/ etc.) +</para></note> + +<note><para> +"cupsomatic"/Foomatic are *not* native CUPS drivers and they don't ship with CUPS. +They are a Third Party add-on, developed at Linuxprinting.org. As such, they are +a brilliant hack to make all models (driven by Ghostscript drivers/filters in +traditional spoolers) also work via CUPS, with the same (good or bad!) quality +as in these other spoolers. "cupsomatic" is only a vehicle to execute a ghostscript +commandline at that stage in the CUPS filtering chain, where "normally" the native +CUPS "pstoraster" filter would kick in. cupsomatic by-passes pstoraster, "kidnaps" +the printfile from CUPS away and re-directs it to go through Ghostscipt. CUPS accepts this, +because the associated CUPS-O-Matic-/Foomatic-PPD specifies: +</para> + +<programlisting> + *cupsFilter: "application/vnd.cups-postscript 0 cupsomatic" +</programlisting> + +<para> +This line persuades CUPS to hand the file to cupsomatic, once it has successfully +converted it to the MIME type "application/vnd.cups-postscript". This conversion will not +happen for Jobs arriving from Windows which are auto-typed "application/octet-stream", +with the according changes in "/etc/cups/mime.types" in place. +</para></note> + +<para> +CUPS is widely configurable and flexible, even regarding its filtering mechanism. +Another workaround in some situations would be to have +in "/etc/cups/mime.types" entries as follows: +</para> + +<programlisting> + application/postscript application/vnd.cups-raw 0 - + application/vnd.cups-postscript application/vnd.cups-raw 0 - +</programlisting> + +<para> +This would prevent all Postscript files from being filtered (rather, they will go +thru the virtual "nullfilter" denoted with "-"). This could only be useful for +PS printers. If you want to print PS code on non-PS printers an entry as follows +could be useful: +</para> + +<programlisting> + */* application/vnd.cups-raw 0 - +</programlisting> + +<para> +and would effectively send *all* files to the backend without further processing. +</para> + +<para> +Lastly, you could have the following entry: +</para> + +<programlisting> + application/vnd.cups-postscript application/vnd.cups-raw 0 my_PJL_stripping_filter +</programlisting> + +<para> +You will need to write a "my_PJL_stripping_filter" (could be a shellscript) that +parses the PostScript and removes the unwanted PJL. This would need to conform to +CUPS filter design (mainly, receive and pass the parameters printername, job-id, +username, jobtitle, copies, print options and possibly the filename). It would +be installed as world executable into "/usr/lib/cups/filters/" and will be called +by CUPS if it encounters a MIME type "application/vnd.cups-postscript". +</para> + +<para> +CUPS can handle "-o job-hold-until=indefinite". This keeps the job in the queue +"on hold". It will only be printed upon manual release by the printer operator. +This is a requirement in many "central reproduction departments", where a few +operators manage the jobs of hundreds of users on some big machine, where no +user is allowed to have direct access. (The operators often need to load the +proper paper type before running the 10.000 page job requested by marketing +for the mailing, etc.). +</para> + +</sect1> + +<sect1> +<title>CUPS as a network PostScript RIP</title> + +<para> +This is the configuration where CUPS drivers are working on server, and where the +Adobe PostScript driver with CUPS-PPDs is downloaded to clients. +</para> + +<para> +CUPS is perfectly able to use PPD files (PostScript +Printer Descriptions). PPDs can control all print device options. They +are usually provided by the manufacturer -- if you own a PostSript printer, +that is. PPD files are always a component of PostScript printer drivers on MS +Windows or Apple Mac OS systems. They are ASCII files containing +user-selectable print options, mapped to appropriate PostScript, PCL or PJL +commands for the target printer. Printer driver GUI dialogs translate these +options "on-the-fly" into buttons and drop-down lists for the user to +select. +</para> + +<para> +CUPS can load, without any conversions, the PPD file from +any Windows (NT is recommended) PostScript driver and handle the options. +There is a web browser interface to the print options (select +http://localhost:631/printers/ and click on one "Configure Printer" button +to see it), a commandline interface (see <command>man lpoptions</command> or +try if you have <command>lphelp</command> on your system) plus some different GUI frontends on Linux +UNIX, which can present PPD options to the users. PPD options are normally +meant to become evaluated by the PostScript RIP on the real PostScript +printer. +</para> + +<para> +CUPS doesn't stop at "real" PostScript printers in its +usage of PPDs. The CUPS developers have extended the PPD concept, to also +describe available device and driver options for non-PostScript printers +through CUPS-PPDs. +</para> + +<para> +This is logical, as CUPS includes a fully featured +PostScript interpreter (RIP). This RIP is based on Ghostscript. It can +process all received PostScript (and additionally many other file formats) +from clients. All CUPS-PPDs geared to non-PostScript printers contain an +additional line, starting with the keyword <parameter>*cupsFilter</parameter>. +This line +tells the CUPS print system which printer-specific filter to use for the +interpretation of the accompanying PostScript. Thus CUPS lets all its +printers appear as PostScript devices to its clients, because it can act as a +PostScript RIP for those printers, processing the received PostScript code +into a proper raster print format. +</para> + +<para> +CUPS-PPDs can also be used on Windows-Clients, on top of a +PostScript driver (recommended is the Adobe one). +</para> + +<para> +This feature enables CUPS to do a few tricks no other +spooler can do: +</para> + +<itemizedlist> + <listitem><para>act as a networked PostScript RIP (Raster Image Processor), handling + printfiles from all client platforms in a uniform way;</para></listitem> + <listitem><para>act as a central accounting and billing server, as all files are passed + through the <command>pstops</command> Filter and are therefor logged in + the CUPS <filename>page_log</filename>. - <emphasis>NOTE: </emphasis>this + can not happen with "raw" print jobs, which always remain unfiltered + per definition;</para></listitem> + <listitem><para>enable clients to consolidate on a single PostScript driver, even for + many different target printers.</para></listitem> +</itemizedlist> +</sect1> + +<sect1> +<title>Windows Terminal Servers (WTS) as CUPS clients</title> + +<para> +This setup may be of special interest to people +experiencing major problems in WTS environments. WTS need often a multitude +of non-PostScript drivers installed to run their clients' variety of +different printer models. This often imposes the price of much increased +instability. In many cases, in an attempt to overcome this problem, site +administrators have resorted to restrict the allowed drivers installed on +their WTS to one generic PCL- and one PostScript driver. This however +restricts the clients in the amount of printer options available for them -- +often they can't get out more then simplex prints from one standard paper +tray, while their devices could do much better, if driven by a different +driver! +</para> + +<para> +Using an Adobe PostScript driver, enabled with a CUPS-PPD, +seems to be a very elegant way to overcome all these shortcomings. The +PostScript driver is not known to cause major stability problems on WTS (even +if used with many different PPDs). The clients will be able to (again) chose +paper trays, duplex printing and other settings. However, there is a certain +price for this too: a CUPS server acting as a PostScript RIP for its clients +requires more CPU and RAM than just to act as a "raw spooling" device. Plus, +this setup is not yet widely tested, although the first feedbacks look very +promising... +</para> +</sect1> + + +<sect1> +<title>Setting up CUPS for driver download</title> + +<para> +The <command>cupsadsmb</command> utility (shipped with all current +CUPS versions) makes the sharing of any (or all) installed CUPS printers very +easy. Prior to using it, you need the following settings in &smb.conf;: +</para> + + <para><programlisting>[global] + load printers = yes + printing = cups + printcap name = cups + + [printers] + comment = All Printers + path = /var/spool/samba + browseable = no + public = yes + guest ok = yes + writable = no + printable = yes + printer admin = root + + [print$] + comment = Printer Drivers + path = /etc/samba/drivers + browseable = yes + guest ok = no + read only = yes + write list = root + </programlisting></para> + +<para> +For licensing reasons the necessary files of the Adobe +Postscript driver can not be distributed with either Samba or CUPS. You need +to download them yourself from the Adobe website. Once extracted, create a +<filename>drivers</filename> directory in the CUPS data directory (usually +<filename>/usr/share/cups/</filename>). Copy the Adobe files using +UPPERCASE filenames, to this directory as follows: +</para> + + <para><programlisting> + ADFONTS.MFM + ADOBEPS4.DRV + ADOBEPS4.HLP + ADOBEPS5.DLL + ADOBEPSU.DLL + ADOBEPSU.HLP + DEFPRTR2.PPD + ICONLIB.DLL + </programlisting></para> + +<para> +Users of the ESP Print Pro software are able to install +their "Samba Drivers" package for this purpose with no problem. +</para> +</sect1> + + + +<sect1> +<title>Sources of CUPS drivers / PPDs</title> + +<para> +On the internet you can find now many thousand CUPS-PPD +files (with their companion filters), in many national languages, +supporting more than 1.000 non-PostScript models. +</para> + +<itemizedlist> + <listitem><para><ulink url="http://wwwl.easysw.com/printpro/">ESP PrintPro + (http://wwwl.easysw.com/printpro/)</ulink> + (commercial, non-Free) is packaged with more than 3.000 PPDs, ready for + successful usage "out of the box" on Linux, IBM-AIX, HP-UX, Sun-Solaris, + SGI-IRIX, Compaq Tru64, Digital Unix and some more commercial Unices (it + is written by the CUPS developers themselves and its sales help finance + the further development of CUPS, as they feed their creators)</para></listitem> + <listitem><para>the <ulink + url="http://gimp-print.sourceforge.net/">Gimp-Print-Project + (http://gimp-print.sourceforge.net/)</ulink> + (GPL, Free Software) provides around 120 PPDs (supporting nearly 300 + printers, many driven to photo quality output), to be used alongside the + Gimp-Print CUPS filters;</para></listitem> + <listitem><para><ulink url="http://www.turboprint.com/">TurboPrint + (http://www.turboprint.com/)</ulink> + (Shareware, non-Freee) supports roughly the same amount of printers in + excellent quality;</para></listitem> + <listitem><para><ulink + url="http://www-124.ibm.com/developerworks/oss/linux/projects/omni/">OMNI + (http://www-124.ibm.com/developerworks/oss/linux/projects/omni/)</ulink> + (LPGL, Free) is a package made by IBM, now containing support for more + than 400 printers, stemming from the inheritance of IBM OS/2 KnowHow + ported over to Linux (CUPS support is in a Beta-stage at present);</para></listitem> + <listitem><para><ulink url="http://hpinkjet.sourceforge.net/">HPIJS + (http://hpinkjet.sourceforge.net/)</ulink> + (BSD-style licnes, Free) supports around 120 of HP's own printers and is + also providing excellent print quality now;</para></listitem> + <listitem><para><ulink + url="http://www.linuxprinting.org/">Foomatic/cupsomatic (http://www.linuxprinting.org/)</ulink> + (LPGL, Free) from Linuxprinting.org are providing PPDs for practically every + Ghostscript filter known to the world, now usable with CUPS.</para></listitem> +</itemizedlist> + +<para> +<emphasis>NOTE: </emphasis>the cupsomatic trick from Linuxprinting.org is +working different from the other drivers. While the other drivers take the +generic CUPS raster (produced by CUPS' own pstoraster PostScript RIP) as +their input, cupsomatic "kidnaps" the PostScript inside CUPS, before +RIP-ping, deviates it to an external Ghostscript installation (which now +becomes the RIP) and gives it back to a CUPS backend once Ghostscript is +finished. -- CUPS versions from 1.1.15 and later will provide their pstoraster +PostScript RIP function again inside a system-wide Ghostscript +installation rather than in "their own" pstoraster filter. (This +CUPS-enabling Ghostscript version may be installed either as a +patch to GNU or AFPL Ghostscript, or as a complete ESP Ghostscript package). +However, this will not change the cupsomatic approach of guiding the printjob +along a different path through the filtering system than the standard CUPS +way... +</para> + +<para> +Once you installed a printer inside CUPS with one of the +recommended methods (the lpadmin command, the web browser interface or one of +the available GUI wizards), you can use <command>cupsaddsmb</command> to share the +printer via Samba. <command>cupsaddsmb</command> prepares the driver files for +comfortable client download and installation upon their first contact with +this printer share. +</para> + + + +<sect2> +<title><command>cupsaddsmb</command></title> + + +<para> +The <command>cupsaddsmb</command> command copies the needed files +for convenient Windows client installations from the previously prepared CUPS +data directory to your [print$] share. Additionally, the PPD +associated with this printer is copied from <filename>/etc/cups/ppd/</filename> to +[print$]. +</para> + +<para><programlisting> +<prompt>root# </prompt> <command>cupsaddsmb -U root infotec_IS2027</command> +Password for root required to access localhost via +SAMBA: <userinput>[type in password 'secret']</userinput> +</programlisting></para> + +<para> +To share all printers and drivers, use the <parameter>-a</parameter> +parameter instead of a printer name. +</para> + + +<para> +Probably you want to see what's going on. Use the +<parameter>-v</parameter> parameter to get a more verbose output: +</para> + +<para> +Probably you want to see what's going on. Use the +<parameter>-v</parameter> parameter to get a more verbose output: +</para> + +<para><programlisting> +Note: The following line shave been wrapped so that information is not lost. + +<prompt>root# </prompt> cupsaddsmb -v -U root infotec_IS2027 + Password for root required to access localhost via SAMBA: + Running command: smbclient //localhost/print\$ -N -U'root%secret' -c 'mkdir W32X86;put + /var/spool/cups/tmp/3cd1cc66376c0 W32X86/infotec_IS2027.PPD;put + /usr/share/cups/drivers/ + ADOBEPS5.DLL W32X86/ADOBEPS5.DLL;put /usr/share/cups/drivers/ADOBEPSU.DLLr + W32X86/ADOBEPSU.DLL;put /usr/share/cups/drivers/ADOBEPSU.HLP W32X86/ADOBEPSU.HLP' + added interface ip=10.160.16.45 bcast=10.160.31.255 nmask=255.255.240.0 + added interface ip=192.168.182.1 bcast=192.168.182.255 nmask=255.255.255.0 + added interface ip=172.16.200.1 bcast=172.16.200.255 nmask=255.255.255.0 + Domain=[TUX-NET] OS=[Unix] Server=[Samba 2.2.3a.200204262025cvs] + NT_STATUS_OBJECT_NAME_COLLISION making remote directory \W32X86 + putting file /var/spool/cups/tmp/3cd1cc66376c0 as + \W32X86/infotec_IS2027.PPD (17394.6 kb/s) (average 17395.2 kb/s) + putting file /usr/share/cups/drivers/ADOBEPS5.DLL as + \W32X86/ADOBEPS5.DLL (10877.4 kb/s) (average 11343.0 kb/s) + putting file /usr/share/cups/drivers/ADOBEPSU.DLL as + \W32X86/ADOBEPSU.DLL (5095.2 kb/s) (average 9260.4 kb/s) + putting file /usr/share/cups/drivers/ADOBEPSU.HLP as + \W32X86/ADOBEPSU.HLP (8828.7 kb/s) (average 9247.1 kb/s) + + Running command: smbclient //localhost/print\$ -N -U'root%secret' -c 'mkdir WIN40;put + /var/spool/cups/tmp/3cd1cc66376c0 WIN40/infotec_IS2027.PPD;put + /usr/share/cups/drivers/ADFONTS.MFM WIN40/ADFONTS.MFM;put + /usr/share/cups/drivers/ADOBEPS4.DRV WIN40/ADOBEPS4.DRV;put + /usr/share/cups/drivers/ADOBEPS4.HLP WIN40/ADOBEPS4.HLP;put + /usr/share/cups/drivers/DEFPRTR2.PPD WIN40/DEFPRTR2.PPD;put + /usr/share/cups/drivers/ICONLIB.DLL WIN40/ICONLIB.DLL;put + /usr/share/cups/drivers/PSMON.DLL WIN40/PSMON.DLL;' + added interface ip=10.160.16.45 bcast=10.160.31.255 nmask=255.255.240.0 + added interface ip=192.168.182.1 bcast=192.168.182.255 nmask=255.255.255.0 + added interface ip=172.16.200.1 bcast=172.16.200.255 nmask=255.255.255.0 + Domain=[TUX-NET] OS=[Unix] Server=[Samba 2.2.3a.200204262025cvs] + NT_STATUS_OBJECT_NAME_COLLISION making remote directory \WIN40 + putting file /var/spool/cups/tmp/3cd1cc66376c0 as + \WIN40/infotec_IS2027.PPD (26091.5 kb/s) (average 26092.8 kb/s) + putting file /usr/share/cups/drivers/ADFONTS.MFM as + \WIN40/ADFONTS.MFM (11241.6 kb/s) (average 11812.9 kb/s) + putting file /usr/share/cups/drivers/ADOBEPS4.DRV as + \WIN40/ADOBEPS4.DRV (16640.6 kb/s) (average 14679.3 kb/s) + putting file /usr/share/cups/drivers/ADOBEPS4.HLP as + \WIN40/ADOBEPS4.HLP (11285.6 kb/s) (average 14281.5 kb/s) + putting file /usr/share/cups/drivers/DEFPRTR2.PPD as + \WIN40/DEFPRTR2.PPD (823.5 kb/s) (average 12944.0 kb/s) + putting file /usr/share/cups/drivers/ICONLIB.DLL as + \WIN40/ICONLIB.DLL (19226.2 kb/s) (average 13169.7 kb/s) + putting file /usr/share/cups/drivers/PSMON.DLL as + \WIN40/PSMON.DLL (18666.1 kb/s) (average 13266.7 kb/s) + + Running command: rpcclient localhost -N -U'root%secret' + -c 'adddriver "Windows NT x86" + "infotec_IS2027:ADOBEPS5.DLL:infotec_IS2027.PPD:ADOBEPSU.DLL: + ADOBEPSU.HLP:NULL:RAW:NULL"' + cmd = adddriver "Windows NT x86" + "infotec_IS2027:ADOBEPS5.DLL:infotec_IS2027.PPD:ADOBEPSU.DLL: + ADOBEPSU.HLP:NULL:RAW:NULL" + Printer Driver infotec_IS2027 successfully installed. + + Running command: rpcclient localhost -N -U'root%secret' + -c 'adddriver "Windows 4.0" + "infotec_IS2027:ADOBEPS4.DRV:infotec_IS2027.PPD:NULL: + ADOBEPS4.HLP:PSMON.DLL:RAW: ADFONTS.MFM,DEFPRTR2.PPD,ICONLIB.DLL"' + cmd = adddriver "Windows 4.0" "infotec_IS2027:ADOBEPS4.DRV: + infotec_IS2027.PPD:NULL:ADOBEPS4.HLP:PSMON.DLL:RAW: + ADFONTS.MFM,DEFPRTR2.PPD,ICONLIB.DLL" + Printer Driver infotec_IS2027 successfully installed. + + Running command: rpcclient localhost -N -U'root%secret' + -c 'setdriver infotec_IS2027 infotec_IS2027' + cmd = setdriver infotec_IS2027 infotec_IS2027 + Succesfully set infotec_IS2027 to driver infotec_IS2027. + + <prompt>root# </prompt> +</programlisting></para> + +<para> +If you look closely, you'll discover your root password was transfered unencrypted over +the wire, so beware! Also, if you look further her, you'll discover error messages like +<constant>NT_STATUS_OBJECT_NAME_COLLISION</constant> in between. They occur, because +the directories <filename>WIN40</filename> and <filename>W32X86</filename> already +existed in the [print$] driver download share (from a previous driver +installation). They are harmless here. +</para> + +<para> +Now your printer is prepared for the clients to use. From +a client, browse to the CUPS/Samba server, open the "Printers" +share, right-click on this printer and select "Install..." or +"Connect..." (depending on the Windows version you use). Now their +should be a new printer in your client's local "Printers" folder, +named (in my case) "infotec_IS2027 on kdebitshop" +</para> + +<para> +<emphasis>NOTE: </emphasis> +<command>cupsaddsmb</command> will only reliably work i +with CUPS version 1.1.15 or higher +and Samba from 2.2.4. If it doesn't work, or if the automatic printer +driver download to the clients doesn't succeed, you can still manually +install the CUPS printer PPD on top of the Adobe PostScript driver on +clients and then point the client's printer queue to the Samba printer +share for connection, should you desire to use the CUPS networked +PostScript RIP functions. +</para> +</sect2> +</sect1> + + +<sect1> +<title>The CUPS Filter Chains</title> + +<para> +The following diagrams reveal how CUPS handles print jobs. +</para> + +<programlisting> +######################################################################### +# +# CUPS in and of itself has this (general) filter chain (CAPITAL +# letters are FILE-FORMATS or MIME types, other are filters (this is +# true for pre-1.1.15 of pre-4.3 versions of CUPS and ESP PrintPro): +# +# <replaceable>SOMETHNG</replaceable>-FILEFORMAT +# | +# | +# V +# <replaceable>something</replaceable>tops +# | +# | +# V +# APPLICATION/POSTSCRIPT +# | +# | +# V +# pstops +# | +# | +# V +# APPLICATION/VND.CUPS-POSTSCRIPT +# | +# | +# V +# pstoraster # as shipped with CUPS, independent from any Ghostscipt +# | # installation on the system +# | (= "postscipt interpreter") +# | +# V +# APPLICATION/VND.CUPS-RASTER +# | +# | +# V +# rasterto<replaceable>something</replaceable> (f.e. Gimp-Print filters may be plugged in here) +# | (= "raster driver") +# | +# V +# SOMETHING-DEVICE-SPECIFIC +# | +# | +# V +# backend +# +# +# ESP PrintPro has some enhanced "rasterto<replaceable>something</replaceable>" filters as compared to +# CUPS, and also a somewhat improved "pstoraster" filter. +# +# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to +# CUPS and ESP PrintPro plug-in where rasterto<replaceable>something</replaceable> is noted. +# +######################################################################### +</programlisting> + +<programlisting> +######################################################################### +# +# This is how "cupsomatic" comes into play: +# ========================================= +# +# <replaceable>SOMETHNG</replaceable>-FILEFORMAT +# | +# | +# V +# <replaceable>something</replaceable>tops +# | +# | +# V +# APPLICATION/POSTSCRIPT +# | +# | +# V +# pstops +# | +# | +# V +# APPLICATION/VND.CUPS-POSTSCRIPT ----------------+ +# | | +# | V +# V cupsomatic +# pstoraster (constructs complicated +# | (= "postscipt interpreter") Ghostscript commandline +# | to let the file be +# V processed by a +# APPLICATION/VND.CUPS-RASTER "-sDEVICE=<replaceable>s.th.</replaceable>" +# | call...) +# | | +# V | +# rasterto<replaceable>something</replaceable> V +# | (= "raster driver") +-------------------------+ +# | | Ghostscript at work.... | +# V | | +# SOMETHING-DEVICE-SPECIFIC *-------------------------+ +# | | +# | | +# V | +# backend >------------------------------------+ +# | +# | +# V +# THE PRINTER +# +# +# Note, that cupsomatic "kidnaps" the printfile after the +# "APPLICATION/VND.CUPS-POSTSCRPT" stage and deviates it through +# the CUPS-external, systemwide Ghostscript installation, bypassing the +# "pstoraster" filter (therefor also bypassing the CUPS-raster-drivers +# "rasterto<replaceable>something</replaceable>", and hands the rasterized file directly to the CUPS +# backend... +# +# cupsomatic is not made by the CUPS developers. It is an independent +# contribution to printing development, made by people from +# Linuxprinting.org. (see also http://www.cups.org/cups-help.html) +# +# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to +# CUPS and ESP PrintPro plug-in where rasterto<replaceable>something</replaceable> is noted. +# +######################################################################### +</programlisting> + +<programlisting> +######################################################################### +# +# And this is how it works for ESP PrintPro from 4.3: +# =================================================== +# +# <replaceable>SOMETHNG</replaceable>-FILEFORMAT +# | +# | +# V +# <replaceable>something</replaceable>tops +# | +# | +# V +# APPLICATION/POSTSCRIPT +# | +# | +# V +# pstops +# | +# | +# V +# APPLICATION/VND.CUPS-POSTSCRIPT +# | +# | +# V +# gsrip +# | (= "postscipt interpreter") +# | +# V +# APPLICATION/VND.CUPS-RASTER +# | +# | +# V +# rasterto<replaceable>something</replaceable> (f.e. Gimp-Print filters may be plugged in here) +# | (= "raster driver") +# | +# V +# SOMETHING-DEVICE-SPECIFIC +# | +# | +# V +# backend +# +# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to +# CUPS and ESP PrintPro plug-in where rasterto<replaceable>something</replaceable> is noted. +# +######################################################################### +</programlisting> + +<programlisting> +######################################################################### +# +# This is how "cupsomatic" would come into play with ESP PrintPro: +# ================================================================ +# +# +# <replaceable>SOMETHNG</replaceable>-FILEFORMAT +# | +# | +# V +# <replaceable>something</replaceable>tops +# | +# | +# V +# APPLICATION/POSTSCRIPT +# | +# | +# V +# pstops +# | +# | +# V +# APPLICATION/VND.CUPS-POSTSCRIPT ----------------+ +# | | +# | V +# V cupsomatic +# gsrip (constructs complicated +# | (= "postscipt interpreter") Ghostscript commandline +# | to let the file be +# V processed by a +# APPLICATION/VND.CUPS-RASTER "-sDEVICE=<replaceable>s.th.</replaceable>" +# | call...) +# | | +# V | +# rasterto<replaceable>something</replaceable> V +# | (= "raster driver") +-------------------------+ +# | | Ghostscript at work.... | +# V | | +# SOMETHING-DEVICE-SPECIFIC *-------------------------+ +# | | +# | | +# V | +# backend >------------------------------------+ +# | +# | +# V +# THE PRINTER +# +# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to +# CUPS and ESP PrintPro plug-in where rasterto<replaceable>something</replaceable> is noted. +# +######################################################################### +</programlisting> + +<programlisting> +######################################################################### +# +# And this is how it works for CUPS from 1.1.15: +# ============================================== +# +# <replaceable>SOMETHNG</replaceable>-FILEFORMAT +# | +# | +# V +# <replaceable>something</replaceable>tops +# | +# | +# V +# APPLICATION/POSTSCRIPT +# | +# | +# V +# pstops +# | +# | +# V +# APPLICATION/VND.CUPS-POSTSCRIPT-----+ +# | +# +------------------v------------------------------+ +# | Ghostscript | +# | at work... | +# | (with | +# | "-sDEVICE=cups") | +# | | +# | (= "postscipt interpreter") | +# | | +# +------------------v------------------------------+ +# | +# | +# APPLICATION/VND.CUPS-RASTER >-------+ +# | +# | +# V +# rasterto<replaceable>something</replaceable> +# | (= "raster driver") +# | +# V +# SOMETHING-DEVICE-SPECIFIC +# | +# | +# V +# backend +# +# +# NOTE: since version 1.1.15 CUPS "outsourced" the pstoraster process to +# Ghostscript. GNU Ghostscript needs to be patched to handle the +# CUPS requirement; ESP Ghostscript has this builtin. In any case, +# "gs -h" needs to show up a "cups" device. pstoraster is now a +# calling an appropriate "gs -sDEVICE=cups..." commandline to do +# the job. It will output "application/vnd.cup-raster", which will +# be finally processed by a CUPS raster driver "rasterto<replaceable>something</replaceable>" +# Note the difference to "cupsomatic", which will *not* output +# CUPS-raster, but a final version of the printfile, ready to be +# sent to the printer. cupsomatic also doesn't use the "cups" +# devicemode in Ghostscript, but one of the classical devicemodes.... +# +# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to +# CUPS and ESP PrintPro plug-in where rasterto<replaceable>something</replaceable> is noted. +# +######################################################################### +</programlisting> + +<programlisting> +######################################################################### +# +# And this is how it works for CUPS from 1.1.15, with cupsomatic included: +# ======================================================================== +# +# <replaceable>SOMETHNG</replaceable>-FILEFORMAT +# | +# | +# V +# <replaceable>something</replaceable>tops +# | +# | +# V +# APPLICATION/POSTSCRIPT +# | +# | +# V +# pstops +# | +# | +# V +# APPLICATION/VND.CUPS-POSTSCRIPT-----+ +# | +# +------------------v------------------------------+ +# | Ghostscript . Ghostscript at work.... | +# | at work... . (with "-sDEVICE= | +# | (with . <replaceable>s.th.</replaceable>" | +# | "-sDEVICE=cups") . | +# | . | +# | (CUPS standard) . (cupsomatic) | +# | . | +# | (= "postscript interpreter") | +# | . | +# +------------------v--------------v---------------+ +# | | +# | | +# APPLICATION/VND.CUPS-RASTER >-------+ | +# | | +# | | +# V | +# rasterto<replaceable>something</replaceable> | +# | (= "raster driver") | +# | | +# V | +# SOMETHING-DEVICE-SPECIFIC >------------------------+ +# | +# | +# V +# backend +# +# +# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to +# CUPS and ESP PrintPro plug-in where rasterto<replaceable>something</replaceable> is noted. +# +########################################################################## +</programlisting> + +</sect1> + + +<sect1> +<title>CUPS Print Drivers and Devices</title> + +<para> +CUPS ships with good support for HP LaserJet type printers. You can install +the driver as follows: + +<itemizedlist> + <listitem><para> + lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E -m laserjet.ppd + </para></listitem> +</itemizedlist> + +(The "-m" switch will retrieve the "laserjet.ppd" from the standard repository +for not-yet-installed-PPDs, which CUPS typically stores in +<filename>/usr/share/cups/model</filename>. Alternatively, you may use +"-P /absolute/filesystem/path/to/where/there/is/PPD/your.ppd"). +</para> + +<sect2> +<title>Further printing steps</title> + +<para> +Always also consult the database on linuxprinting.org for all recommendations +about which driver is best used for each printer: +</para> + +<para><ulink url="http://www.linuxprinting.org/printer_list.cgi">http://www.linuxprinting.org/printer_list.cgi</ulink></para> + +<para> +There select your model and click on "Show". You'll arrive at a page listing +all drivers working with your model. There will always be *one* +<emphasis>recommended</emphasis> one. Try this one first. In your case +("HP LaserJet 4 Plus"), you'll arrive here: +</para> + +<para><ulink url="http://www.linuxprinting.org/show_printer.cgi?recnum=75104">http://www.linuxprinting.org/show_printer.cgi?recnum=75104</ulink></para> + +<para> +The recommended driver is "ljet4". It has a link to the page for the ljet4 +driver too: +</para> + +<para><ulink url="http://www.linuxprinting.org/show_driver.cgi?driver=ljet4">http://www.linuxprinting.org/show_driver.cgi?driver=ljet4</ulink></para> + +<para> +On the driver's page, you'll find important and detailed info about how to use +that driver within the various available spoolers. You can generate a PPD for +CUPS. The PPD contains all the info about how to use your model and the driver; +this is, once installed, working transparently for the user -- you'll only +need to choose resolution, paper size etc. from the web-based menu or from +the print dialog GUI or from the commandline... +</para> + +<para> +On the driver's page, choose to use the "PPD-O-Matic" online PPD generator +program. Select your model and click "Generate PPD file". When you safe the +appearing ASCII text file, don't use "cut'n'past" (as it could possiblly corrupt +line endings and tabs), but use "Save as..." in your browser's menu. Save it +at "/some/path/on/your/filesystem/somewhere/my-name-for-my-printer.ppd" +</para> + +<para> +Then install the printer: +</para> +<para><programlisting> + "lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E \ + -P /some/path/on/your/filesystem/somewhere/my-name-for-my-printer.ppd" +</programlisting></para> + +<para> +Note, that for all the "Foomatic-PPDs" from Linuxprinting.org, you also need +a special "CUPS filter" named "cupsomatic". Get the latest version of +"cupsomatic" from: +</para> + +<para><ulink url="http://www.linuxprinting.org/cupsomatic">http://www.linuxprinting.org/cupsomatic</ulink></para> + +<para> +This needs to be copied to <filename>/usr/lib/cups/filter/cupsomatic</filename> +and be made world executable. This filter is needed to read and act upon the +specially encoded Foomatic comments, embedded in the printfile, which in turn +are used to construct (transparently for you, the user) the complicated +ghostscript command line needed for your printer/driver combo. +</para> + +<para> +You can have a look at all the options for the Ghostscript commandline supported +by your printer and the ljet4 driver by going to the section "Execution details", +selecting your model (Laserjet 4 Plus) and clicking on "Show execution details". +This will bring up this web page: +</para> + +<para><ulink url="http://www.linuxprinting.org/execution.cgi?driver=ljet4&printer=75104&.submit=Show+execution+details">http://www.linuxprinting.org/execution.cgi?driver=ljet4&printer=75104&.submit=Show+execution+details</ulink></para> + +<para> +The ingenious thing is that the database is kept current. If there +is a bug fix and an improvement somewhere in the database, you will +always get the most current and stable and feature-rich driver by following +the steps described above. +</para> + +<note><para> +Till Kamppeter from MandrakeSoft is doing an excellent job here that too few +people are aware of. (So if you use it often, please send him a note showing +your appreciation).</para></note> + +<para> +The latest and greatest improvement now is support for "custom page sizes" +for all those printers which support it. +</para> + +<para> +"cupsomatic" is documented here: +</para> + +<para><ulink url="http://www.linuxprinting.org/cups-doc.html">http://www.linuxprinting.org/cups-doc.html</ulink></para> + +<para> +More printing tutorial info may be found here: +</para> + +<para><ulink url="http://www.linuxprinting.org/kpfeifle/LinuxKongress2002/Tutorial/">http://www.linuxprinting.org/kpfeifle/LinuxKongress2002/Tutorial/</ulink></para> + +<para> +Note, that *all* the Foomatic drivers listed on Linuxprinting.org (now +approaching the "all-time high" number of 1.000 for the supported models) +are using a special filtering chain involving Ghostscript, as described +in this document. +</para> + +<para> +Summary - You need: +</para> + +<para> +<simplelist> + <member>A "foomatic+<replaceable>something</replaceable>" PPD is not enough to print with CUPS (but it is *one* important component)</member> + <member>The "cupsomatic" filter script (Perl) in <filename>/usr/lib/cups/filters/</filename></member> + <member>Perl to make cupsomatic run</member> + <member>Ghostscript (because it is called and controlled by the PPD/cupsomatic combo in a way to fit your printermodel/driver combo.</member> + <member>Ghostscript *must*, depending on the driver/model, contain support for a certain "device" (as shown by "gs -h")</member> +</simplelist> +</para> + +<para> +In the case of the "hpijs" driver, you need a Ghostscript version, which +has "ijs" amongst its supported devices in "gs -h". In the case of +"hpijs+foomatic", a valid ghostscript commandline would be reading like this: +</para> + +<para><programlisting> + gs -q -dBATCH -dPARANOIDSAFER -dQUIET -dNOPAUSE -sDEVICE=ijs \ + -sIjsServer=hpijs<replaceable>PageSize</replaceable> -dDuplex=<replaceable>Duplex</replaceable> <replaceable>Model</replaceable> \ + -r<replaceable>Resolution</replaceable>,PS:MediaPosition=<replaceable>InputSlot</replaceable> -dIjsUseOutputFD \ + -sOutputFile=- - +</programlisting></para> + +<note><para> +Note, that with CUPS and the "hpijs+foomatic" PPD (plus Perl and cupsomatic) +you don't need to remember this. You can choose the available print options +thru a GUI print command (like "glp" from ESP's commercially supported +PrintPro software, or KDE's "kprinter", or GNOME's "gtklp" or the independent +"xpp") or the CUPS web interface via human-readable drop-down selection +menus. +</para></note> + +<para> +If you use "ESP Ghostscript" (also under the GPL, provided by Easy Software +Products, the makers of CUPS, downloadable from +<ulink url="http://www.cups.org/software.html">http://www.cups.org/software.html</ulink>, +co-maintained by the developers of linuxprinting.org), you are guaranteed to +have in use the most uptodate, bug-fixed, enhanced and stable version of a Free +Ghostscript. It contains support for ~300 devices, whereas plain vanilla +GNU Ghostscript 7.05 only has ~200. +</para> + +<para> +If you print only one CUPS test page, from the web interface and when you try to +print a windows test page, it acts like the job was never sent: + +<simplelist> + <member>Can you print "standard" jobs from the CUPS machine?</member> + <member>Are the jobs from Windows visible in the Web interface on CUPS (http://localhost:631/)?</member> + <member><emphasis>Most important:</emphasis> What kind of printer driver are you using on the Windows clients?</member> +</simplelist> + +You can try to get a more detailed debugging info by setting "LogLevel debug" in +<filename>/etc/cups/cupsd.conf</filename>, re-start cupsd and investigate <filename>/var/log/cups/error_log</filename> +for the whereabouts of your Windows-originating printjobs: +</para> + +<simplelist> + <member>what does the "auto-typing" line say? which is the "MIME type" CUPS thinks is arriving from the Windows clients?</member> + <member>are there "filter" available for this MIME type?</member> + <member>are there "filter rules" defined in "/etc/cups/mime.convs" for this MIME type?</member> +</simplelist> + +</sect2> + +</sect1> + + +<sect1> +<title>Limiting the number of pages users can print</title> + +<para> +The feature you want is dependent on the real print subsystem you're using. +Samba's part is always to receive the job files from the clients (filtered +*or* unfiltered) and hand it over to this printing subsystem. +</para> + +<para> +Of course one could "hack" things with one's own scripts. +</para> + +<para> +But there is CUPS (Common Unix Printing System). CUPS supports "quotas". +Quotas can be based on sizes of jobs or on the number of pages or both, +and are spanning any time period you want. +</para> + +<para> +This is an example command how root would set a print quota in CUPS, +assuming an existing printer named "quotaprinter": +</para> + +<programlisting> + lpadmin -p quotaprinter -o job-quota-period=604800 -o job-k-limit=1024 \ + -o job-page-limit=100 +</programlisting> + +<para> +This would limit every single user to print 100 pages or 1024 KB of +data (whichever comes first) within the last 604.800 seconds ( = 1 week). +</para> + +<para> +For CUPS to count correctly, the printfile needs to pass the CUPS "pstops" filter, +otherwise it uses a "dummy" count of "1". Some printfiles don't pass it +(eg: image files) but then those are mostly 1 page jobs anyway. This also means, +proprietary drivers for the target printer running on the client computers and +CUPS/Samba then spooling these files as "raw" (i.e. leaving them untouched, not +filtering them), will be counted as "1-pagers" too! +</para> + +<para> +You need to send PostScript from the clients (i.e. run a PostScript driver there) +for having the chance to get accounting done. If the printer is a non-PostScript model, +you need to let CUPS do the job to convert the file to a print-ready format for the +target printer. This will be working for currently ~1.000 different printer models, see +</para> + +<programlisting> + http://www.linuxprinting.org/printer_list.cgi +</programlisting> + +<para> +Before CUPS-1.1.16 your only option was to use the Adobe PostScript +Driver on the Windows clients. The output of this driver was not always +passed thru the "pstops" filter on the CUPS/Samba side, and therefor was +not counted correctly (the reason is that it often --- depending on the +"PPD" being used --- did write a "PJL"-header in front of the real +PostScript which made CUPS to skip the pstops and go directy to +the "pstoraster" stage). +</para> + +<para> +From CUPS-1.1.16 onward you can use the "CUPS PostScript Driver +for Windows NT/2K/XP clients" (it is tagged in the download area of +http://www.cups.org/ as the "cups-samba-1.1.16.tar.gz" package). +It is *not* working for Win9x/ME clients. But it: +</para> + +<simplelist> + <member>it guarantees to not write an PJL-header</member> + <member>it guarantees to still read and support all PJL-options named in the driver PPD with its own means</member> + <member>it guarantees the file going thru the "pstops" filter on the CUPS/Samba server</member> + <member>it guarantees to page-count correctly the printfile</member> +</simplelist> + +<para> +You can read more about the setup of this combination in the +manpage for "cupsaddsmb" (only present with CUPS installed, only +current with CUPS 1.1.16). +</para> + +<para> +These are the items CUPS logs in the "page_log" for every single *page* of a job: +</para> + +<para><simplelist> +<member>Printer name</member> +<member>User name</member> +<member>Job ID</member> +<member>Time of printing</member> +<member>the page number</member> +<member>the number of copies</member> +<member>a billing info string (optional)</member> +</simplelist> +</para> + +<para> +Here is an extract of my CUPS server's page_log file to illustrate +the format and included items: +</para> + +<para><computeroutput> + infotec_IS2027 kurt 40 [22/Nov/2002:13:18:03 +0100] 1 2 #marketing + infotec_IS2027 kurt 40 [22/Nov/2002:13:18:03 +0100] 2 2 #marketing + infotec_IS2027 kurt 40 [22/Nov/2002:13:18:03 +0100] 3 2 #marketing + infotec_IS2027 kurt 40 [22/Nov/2002:13:18:03 +0100] 4 2 #marketing + infotec_IS2027 kurt 40 [22/Nov/2002:13:18:03 +0100] 5 2 #marketing + infotec_IS2027 kurt 40 [22/Nov/2002:13:18:03 +0100] 6 2 #marketing +</computeroutput></para> + +<para> +This was Job ID "40", printed on "infotec_IS2027" by user "kurt", a 6-page job +printed in 2 copies and billed to "#marketing"... +</para> + +<para> +What flaws or shortcomings are there? +</para> + +<simplelist> + <member>the ones named above</member> + + <member> + CUPS really counts the job pages being *processsed in software* + (going thru the "RIP") rather than the physical sheets successfully + leaving the printing device -- if there is a jam while printing + the 5th sheet out of 1000 and the job is aborted by the printer, + the "page count" will still show the figure of 1000 for that job + </member> + + <member> + all quotas are the same for all users (no flexibility to give the + boss a higher quota than the clerk) no support for groups + </member> + + <member> + no means to read out the current balance or "used-up" number of current quota + </member> + + <member> + a user having used up 99 sheets of 100 quota will still be able to send and print a 1.000 sheet job + </member> + + <member> + a user being denied a job because of a filled-up quota doesn't get a meaningful + error message from CUPS other than "client-error-not-possible". + </member> +</simplelist> + +<para> +But this is the best system out there currently. And there are +huge improvements under development: +</para> + +<simplelist> + <member>page counting will go into the "backends" (these talk + directly to the printer and will increase the count in sync with the + actual printing process -- a jam at the 5th sheet will lead to a stop in the counting)</member> + + <member>quotas will be handled more flexibly</member> + + <member>probably there will be support for users to inquire their "accounts" in advance</member> + + <member>probably there will be support for some other tools around this topic</member> +</simplelist> + +<para> +Other than the current stage of the CUPS development, I don't +know any other ready-to-use tool which you could consider. +</para> + +<para> +You can download the driver files from +<ulink url="http://www.cups.org/software.html">http://www.cups.org/software.html</ulink>. +It is a separate package from the CUPS base software files, tagged as "CUPS 1.1.16 +Windows NT/2k/XP Printer Driver for SAMBA (tar.gz, 192k)". The filename to +download is "cups-samba-1.1.16.tar.gz". Upon untar-/unzip-ping it will reveal +the files: +</para> + +<para> +<computeroutput> + cups-samba.install + cups-samba.license + cups-samba.readme + cups-samba.remove + cups-samba.ss +</computeroutput> +</para> + +<para> +These have been packaged with the ESP meta packager software "EPM". The +*.install and *.remove files are simple shell script, which untars the +*.ss (which is nothing else than a tar-archive) and puts its contents +into <filename>/usr/share/cups/drivers/</filename>. Its contents are 3 files: +</para> + +<para> +<computeroutput> + cupsdrvr.dll + cupsui.dll + cups.hlp +</computeroutput> +</para> + +<caution><para> +Due to a bug one CUPS release puts the <filename>cups.hlp</filename> +into <filename>/usr/share/drivers/</filename> instead of +<filename>/usr/share/cups/drivers/</filename>. To work around this, copy/move +the file after running the "./cups-samba.install" script manually to the right place: +</para> + + <para> +<userinput> cp /usr/share/drivers/cups.hlp /usr/share/cups/drivers/ +</userinput> + </para></caution> + +<note> +<para> +This new CUPS PostScript driver is currently binary-only, but free +no source code is provided (yet). The reason is this: it has +been developed with the help of the Microsoft Driver Developer Kit (DDK) +and compiled with Microsoft Visual Studio 6. It is not clear to the driver +developers if they are allowed to distribute the whole of the source code +as Free Software. However, they will likely release the "diff" in source +code under the GPL, so anybody with a license of Visual Studio and a DDK +will be able to compile for him/herself. +</para> + +<para> +Once you have run the install script (and possibly manually moved the +"cups.hlp" file to "/usr/share/cups/drivers/"), the driver is ready to be +put into Samba's [print$] share (which often maps to "/etc/samba/drivers/" +and contains a subdir tree with WIN40 and W32X86 branches), by running +"cupsaddsmb" (see also "man cupsaddsmb" for CUPS 1.1.16). [Don't forget to +put root into the smbpasswd file by running "smbpasswd" should you run +this whole procedure for the first time.] Once the driver files are in the +[print$] share, they are ready to be downloaded and installed by the +Win NT/2k/XP clients. +</para></note> + + + <note><para> + Win 9x/ME clients won't work with this driver. For these you'd + still need to use the ADOBE*.* drivers as previously. + </para></note> + + <note><para> + It is not harming if you've still the ADOBE*.* driver files from + previous installations in the "/usr/share/cups/drivers/" directory. + The new cupsaddsmb (from 1.1.16) will automatically use the + "newest" installed driver (which here then is the CUPS drivers). + </para></note> + + <note><para> + Should your Win clients have had the old ADOBE*.* files and the + Adobe PostScript drivers installed, the download and installation + of the new CUPS PostScript driver for Windows NT/2k/XP will fail + at first. + </para> + <para> + It is not enough to "delete" the printer (as the driver files + will still be kept by the clients and re-used if you try to + re-install the printer). To really get rid of the Adobe driver + files on the clients, open the "Printers" folder (possibly via + "Start --> Settings --> Control Panel --> Printers"), right-click + onto the folder background and select "Server Properties". A + new dialog opens; select the "Drivers" tab; on the list select + the driver you want to delete and click on the "Delete" button. + (This will only work if there is no single printer left which + uses that particular driver -- you need to "delete" all printers + using this driver in the "Printers" folder first.) + </para> + </note> + + <note><para> + Once you have successfully downloaded the CUPS PostScript driver + to a client, you can easily switch all printers to this one + by proceeding as described elsewhere in the "Samba HOWTO + Collection" to change a driver for an existing printer. + </para></note> + +<para> +What are the benefits with the "CUPS PostScript driver for Windows NT/2k/XP" +as compared to the Adobe drivers? +</para> + +<para> +<simplelist> + <member><para> + no hassle with the Adobe EULA + </para></member> + + <member><para> + no hassle with the question "where do I get the ADOBE*.* driver files from?" + </para></member> + + <member><para> + the Adobe drivers (depending on the printer PPD associated with them) + often put a PJL header in front of the core PostScript part of the print + file (thus the file starts with "<replaceable>1B</replaceable>%-12345X" + or "<replaceable>escape</replaceable>%-12345X" + instead of "%!PS"). This leads to the CUPS daemon autotyping the + arriving file as a print-ready file, not requiring a pass thru the + "pstops" filter (to speak more technical, it is not regarded as the + generic MIME type "application/postscript", but as the more special + MIME type "application/cups.vnd-postscript"), which therefore also + leads to the page accounting in "/var/log/cups/page_log" not receiving + the exact mumber of pages; instead the dummy page number of "1" is + logged in a standard setup) + </para></member> + + <member><para> + the Adobe driver has more options to "mis-configure" the PostScript + generated by it (like setting it inadvertedly to "Optimize for Speed", + instead of "Optimize for Portability", which could lead to CUPS being + unable to process it) + </para></member> + + <member><para> + the CUPS PostScript driver output sent by Windows clients to the CUPS + server will be guaranteed to be auto-typed as generic MIME type + "application/postscript", thusly passing thru the CUPS "pstops" filter + and logging the correct number of pages in the page_log for accounting + and quota purposes + </para></member> + + <member><para> + the CUPS PostScript driver supports the sending of additional print + options by the Win NT/2k/XP clients, such as naming the CUPS standard + banner pages (or the custom ones, should they be installed at the time + of driver download), using the CUPS "page-label" option, setting a + job-priority and setting the scheduled time of printing (with the option + to support additional useful IPP job attributes in the future). + </para></member> + + <member><para> + the CUPS PostScript driver supports the inclusion of the new + "*cupsJobTicket" comments at the beginnig of the PostScript file (which + could be used in the future for all sort of beneficial extensions on + the CUPS side, but which will not disturb any other application as those + will regard it as a comment and simply ignore it). + </para></member> + + <member><para> + the CUPS PostScript driver will be the heart of the fully fledged CUPS + IPP client for Windows NT/2k/XP to be released soon (probably alongside + the first Beta release for CUPS 1.2). + </para></member> + +</simplelist> +</para> +</sect1> + +<sect1> +<title>Advanced Postscript Printing from MS Windows</title> + +<para> +Let the Windows Clients use a PostScript driver to deliver poistscript to +the samba print server (just like any Linux or Unix Client would also use +PostScript to send to the server) +</para> + +<para> +Make the Unix printing subsystem to which Samba sends the job convert the +incoming PostScript files to the native print format of the target printers +(would be PCL if you have an HP printer) +</para> + +<para> +Now if you are afraid that this would just mean using a *Generic* PostScript +driver for the clients that has no Simplex/Duplex selection, and no paper tray +choice, but you need them to be able to set up print jobs, with all the bells +and whistles of your printers:- +</para> + +<simplelist> + <member>Not possible with traditional spooling systems</member> + + <member> + But perfectly supported by CUPS (which uses "PPD" files to + describe how to control the print options for PostScript and + non-PostScript devices alike... + </member> +</simplelist> + +<para> +CUPS PPDs are working perfectly on Windows clients who use Adobe PostScript +drivers (or the new CUPS PostScript driver for Windows NT/2K/XP). Clients can use +them to setup the job to their liking and CUPS will use the received job options +to make the (PCL-, ESC/P- or PostScript-) printer behave as required. +</para> + +<para> +If you want to have the additional benefit of page count logging and accounting +then the CUPS PostScript driver is the best choice (better than the Adobe one). +</para> + +<para> +If you want to make the drivers downloadable for the clients then "cupsaddsmb" is +your friend. It will setup the [print$] share on the Samba host to be ready to serve +the clients for a "point and print" driver installation. +</para> + +<warning> +<para>What strings are attached?</para></warning> + +<para> +There are some. But, given the sheer CPU power you can buy nowadays, +these can be overcome easily. The strings: +</para> + +<para> +Well, if the CUPS/Samba side will have to print to many printers serving many users, +you probably will need to set up a second server (which can do automatic load balancing +with the first one, plus a degree of fail-over mechanism). Converting the incoming +PostScript jobs, "interpreting" them for non-PostScript printers, amounts to the work +of a "RIP" (Raster Image Processor) done in software. This requires more CPU and RAM +than for the mere "raw spooling" task your current setup is solving. It all depends +on the avarage and peak printing load the server should be able to handle. +</para> + +</sect1> + +<sect1> +<title>Auto-Deletion of CUPS spool files</title> + +<para> +Samba print files pass thru two "spool" directories. One the incoming directory +managed by Samba, (set eg: in the <command>path = /var/spool/samba</command> directive in the [printers] +section of &smb.conf;). Second is the spool directory of your UNIX print subsystem. +For CUPS it is normally "/var/spool/cups/", as set by the cupsd.conf directive +"RequestRoot /var/spool/cups". +</para> + +<para> +I am not sure, which one of your directories keeps the files. From what you say, +it is most likely the Samba part. +</para> + +<para> +For the CUPS part, you may want to consult: +</para> + +<simplelist> +<member>http://localhost:631/sam.html#PreserveJobFiles</member> +<member>http://localhost:631/sam.html#PreserveJobHistory</member> +<member>http://localhost:631/sam.html#MaxJobs</member> +</simplelist> + +<para> +There are the settings described for your CUPS daemon, which could lead to completed +job files not being deleted. +</para> + +<para> +"PreserveJobHistory Yes" -- keeps some details of jobs in +cupsd's mind (well it keeps the "c12345", "c12346" etc. files +in the CUPS spool directory, which do a similar job as the +old-fashioned BSD-LPD control files). This is set to "Yes" +as a default. +</para> + +<para> +"PreserveJobFiles Yes" -- keeps the job files themselves in +cupsd's mind (well it keeps the "d12345", "d12346" etc. files +in the CUPS spool directory...). This is set to "No" as the +CUPS default. +</para> + +<para> +"MaxJobs 500" -- this directive controls the maximum number +of jobs that are kept in memory. Once the number of jobs +reaches the limit, the oldest completed job is automatically +purged from the system to make room for the new one. If all +of the known jobs are still pending or active then the new +job will be rejected. Setting the maximum to 0 disables this +functionality. The default setting is 0. +</para> + +<para> +(There are also additional settings for "MaxJobsPerUser" and +"MaxJobsPerPrinter"...) +</para> + +<para> +For everything to work as announced, you need to have three things: +</para> + +<simplelist> + + <member> + a Samba-&smbd; which is compiled against "libcups" (Check on Linux by running <userinput>ldd `which smbd`</userinput>) + </member> + + <member> + a Samba-&smb.conf; setting of <command>printing = cups</command> + </member> + + <member> + another Samba-&smb.conf; setting of <command>printcap = cups</command> + </member> + +</simplelist> + +<note><para> +Note, that in this case all other manually set printing-related +commands (like "print command", "lpq command", "lprm command", +"lppause command" or "lpresume command") are ignored and they +should normally have no influence what-so-ever on your printing. +</para></note> + +<para> +If you want to do things manually, replace the "printing = cups" +by "printing = bsd". Then your manually set commands may work +(haven't tested this), and a "print command = lp -d %P %s; rm %s" +may do what you need. +</para> + +<para> +You forgot to mention the CUPS version you're using. If you did +set things up as described in the man pages, then the Samba +spool files should be deleted. Otherwise it may be a bug. On +the CUPS side, you can control the behaviour as described +above. +</para> + +<para> +If you have more problems, post the output of these commands: +</para> + +<para> +<userinput> + grep -v ^# /etc/cups/cupsd.conf | grep -v ^$ + grep -v ^# /etc/samba/smb.conf | grep -v ^$ | grep -v "^;" +</userinput> +</para> + +<para> +(adapt paths as needed). These commands sanitize the files +and cut out the empty lines and lines with comments, providing +the "naked settings" in a compact way. +</para> +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Compiling.xml b/docs/docbook/projdoc/Compiling.xml new file mode 100644 index 0000000000..9638663dde --- /dev/null +++ b/docs/docbook/projdoc/Compiling.xml @@ -0,0 +1,438 @@ +<chapter id="compiling"> +<chapterinfo> + <author> + <affiliation> + <orgname>Samba Team</orgname> + </affiliation> + </author> + &author.jelmer; + + <pubdate> (22 May 2001) </pubdate> + <pubdate> 18 March 2003 </pubdate> +</chapterinfo> + +<title>How to compile SAMBA</title> + +<para> +You can obtain the samba source from the <ulink url="http://samba.org/">samba website</ulink>. To obtain a development version, +you can download samba from CVS or using rsync. +</para> + +<sect1> +<title>Access Samba source code via CVS</title> + +<sect2> +<title>Introduction</title> + +<para> +Samba is developed in an open environment. Developers use CVS +(Concurrent Versioning System) to "checkin" (also known as +"commit") new source code. Samba's various CVS branches can +be accessed via anonymous CVS using the instructions +detailed in this chapter. +</para> + +<para> +This chapter is a modified version of the instructions found at +<ulink url="http://samba.org/samba/cvs.html">http://samba.org/samba/cvs.html</ulink> +</para> + +</sect2> + +<sect2> +<title>CVS Access to samba.org</title> + +<para> +The machine samba.org runs a publicly accessible CVS +repository for access to the source code of several packages, +including samba, rsync and jitterbug. There are two main ways of +accessing the CVS server on this host. +</para> + +<sect3> +<title>Access via CVSweb</title> + +<para> +You can access the source code via your +favourite WWW browser. This allows you to access the contents of +individual files in the repository and also to look at the revision +history and commit logs of individual files. You can also ask for a diff +listing between any two versions on the repository. +</para> + +<para> +Use the URL : <ulink +url="http://samba.org/cgi-bin/cvsweb">http://samba.org/cgi-bin/cvsweb</ulink> +</para> +</sect3> + +<sect3> +<title>Access via cvs</title> + +<para> +You can also access the source code via a +normal cvs client. This gives you much more control over what you can +do with the repository and allows you to checkout whole source trees +and keep them up to date via normal cvs commands. This is the +preferred method of access if you are a developer and not +just a casual browser. +</para> + +<para> +To download the latest cvs source code, point your +browser at the URL : <ulink url="http://www.cyclic.com/">http://www.cyclic.com/</ulink>. +and click on the 'How to get cvs' link. CVS is free software under +the GNU GPL (as is Samba). Note that there are several graphical CVS clients +which provide a graphical interface to the sometimes mundane CVS commands. +Links to theses clients are also available from http://www.cyclic.com. +</para> + +<para> +To gain access via anonymous cvs use the following steps. +For this example it is assumed that you want a copy of the +samba source code. For the other source code repositories +on this system just substitute the correct package name +</para> + +<orderedlist> +<listitem> + <para> + Install a recent copy of cvs. All you really need is a + copy of the cvs client binary. + </para> +</listitem> + + +<listitem> + <para> + Run the command + </para> + + <para> + <userinput>cvs -d :pserver:cvs@samba.org:/cvsroot login</userinput> + </para> + + <para> + When it asks you for a password type <userinput>cvs</userinput>. + </para> +</listitem> + + +<listitem> + <para> + Run the command + </para> + + <para> + <userinput>cvs -d :pserver:cvs@samba.org:/cvsroot co samba</userinput> + </para> + + <para> + This will create a directory called samba containing the + latest samba source code (i.e. the HEAD tagged cvs branch). This + currently corresponds to the 3.0 development tree. + </para> + + <para> + CVS branches other then HEAD can be obtained by using the <parameter>-r</parameter> + and defining a tag name. A list of branch tag names can be found on the + "Development" page of the samba web site. A common request is to obtain the + latest 2.2 release code. This could be done by using the following userinput. + </para> + + <para> + <userinput>cvs -d :pserver:cvs@samba.org:/cvsroot co -r SAMBA_2_2 samba</userinput> + </para> +</listitem> + +<listitem> + <para> + Whenever you want to merge in the latest code changes use + the following command from within the samba directory: + </para> + + <para> + <userinput>cvs update -d -P</userinput> + </para> +</listitem> +</orderedlist> + +</sect3> +</sect2> + +</sect1> + +<sect1> + <title>Accessing the samba sources via rsync and ftp</title> + + <para> + pserver.samba.org also exports unpacked copies of most parts of the CVS tree at <ulink url="ftp://pserver.samba.org/pub/unpacked">ftp://pserver.samba.org/pub/unpacked</ulink> and also via anonymous rsync at rsync://pserver.samba.org/ftp/unpacked/. I recommend using rsync rather than ftp. + See <ulink url="http://rsync.samba.org/">the rsync homepage</ulink> for more info on rsync. + </para> + + <para> + The disadvantage of the unpacked trees + is that they do not support automatic + merging of local changes like CVS does. + rsync access is most convenient for an + initial install. + </para> +</sect1> + +<sect1> +<title>Verifying Samba's PGP signature</title> + +<para> +In these days of insecurity, it's strongly recommended that you verify the PGP signature for any +source file before installing it. According to Jerry Carter of the Samba Team, only about 22% of +all Samba downloads have had a corresponding PGP signature download (a very low percentage, which +should be considered a bad thing). Even if you're not downloading from a mirror site, verifying PGP +signatures should be a standard reflex. +</para> + + +<para> +With that said, go ahead and download the following files: +</para> + +<para><programlisting> + $ wget http://us1.samba.org/samba/ftp/samba-2.2.8a.tar.asc + $ wget http://us1.samba.org/samba/ftp/samba-pubkey.asc +</programlisting></para> + +<para> +The first file is the PGP signature for the Samba source file; the other is the Samba public +PGP key itself. Import the public PGP key with: +</para> + +<programlisting> + $ gpg --import samba-pubkey.asc +</programlisting> + +<para> +And verify the Samba source code integrity with: +</para> + +<programlisting> + $ gzip -d samba-2.2.8a.tar.gz + $ gpg --verify samba-2.2.8a.tar.asc +</programlisting> + +<para> +If you receive a message like, "Good signature from Samba Distribution Verification Key..." +then all is well. The warnings about trust relationships can be ignored. An example of what +you would not want to see would be: +</para> + +<programlisting> + gpg: BAD signature from "Samba Distribution Verification Key" +</programlisting> + +</sect1> + +<sect1> + <title>Building the Binaries</title> + + <para>To do this, first run the program <userinput>./configure + </userinput> in the source directory. This should automatically + configure Samba for your operating system. If you have unusual + needs then you may wish to run</para> + + <para><prompt>root# </prompt><userinput>./configure --help + </userinput></para> + + <para>first to see what special options you can enable. + Then executing</para> + + <para><prompt>root# </prompt><userinput>make</userinput></para> + + <para>will create the binaries. Once it's successfully + compiled you can use </para> + + <para><prompt>root# </prompt><userinput>make install</userinput></para> + + <para>to install the binaries and manual pages. You can + separately install the binaries and/or man pages using</para> + + <para><prompt>root# </prompt><userinput>make installbin + </userinput></para> + + <para>and</para> + + <para><prompt>root# </prompt><userinput>make installman + </userinput></para> + + <para>Note that if you are upgrading for a previous version + of Samba you might like to know that the old versions of + the binaries will be renamed with a ".old" extension. You + can go back to the previous version with</para> + + <para><prompt>root# </prompt><userinput>make revert + </userinput></para> + + <para>if you find this version a disaster!</para> + + <sect2> + <title>Compiling samba with Active Directory support</title> + + <para>In order to compile samba with ADS support, you need to have installed + on your system:</para> + <itemizedlist> + + <listitem><para>the MIT kerberos development libraries + (either install from the sources or use a package). The + heimdal libraries will not work.</para></listitem> + + <listitem><para>the OpenLDAP development libraries.</para></listitem> + + </itemizedlist> + + <para>If your kerberos libraries are in a non-standard location then + remember to add the configure option --with-krb5=DIR.</para> + + <para>After you run configure make sure that <filename>include/config.h</filename> it generates contains lines like this:</para> + + <para><programlisting> +#define HAVE_KRB5 1 +#define HAVE_LDAP 1 +</programlisting></para> + + <para>If it doesn't then configure did not find your krb5 libraries or + your ldap libraries. Look in config.log to figure out why and fix + it.</para> + + <sect3> + <title>Installing the required packages for Debian</title> + + <para>On Debian you need to install the following packages:</para> + <para> + <itemizedlist> + <listitem>libkrb5-dev</listitem> + <listitem>krb5-user</listitem> + </itemizedlist> + </para> + </sect3> + + <sect3> + <title>Installing the required packages for RedHat</title> + + <para>On RedHat this means you should have at least: </para> + <para> + <itemizedlist> + <listitem>krb5-workstation (for kinit)</listitem> + <listitem>krb5-libs (for linking with)</listitem> + <listitem>krb5-devel (because you are compiling from source)</listitem> + </itemizedlist> + </para> + + <para>in addition to the standard development environment.</para> + + <para>Note that these are not standard on a RedHat install, and you may need + to get them off CD2.</para> + + </sect3> + + </sect2> + +</sect1> + +<sect1> + <title>Starting the smbd and nmbd</title> + + <para>You must choose to start smbd and nmbd either + as daemons or from <application>inetd</application>Don't try + to do both! Either you can put them in <filename> + inetd.conf</filename> and have them started on demand + by <application>inetd</application>, or you can start them as + daemons either from the command line or in <filename> + /etc/rc.local</filename>. See the man pages for details + on the command line options. Take particular care to read + the bit about what user you need to be in order to start + Samba. In many cases you must be root.</para> + + <para>The main advantage of starting <application>smbd</application> + and <application>nmbd</application> using the recommended daemon method + is that they will respond slightly more quickly to an initial connection + request.</para> + + <sect2> + <title>Starting from inetd.conf</title> + + <para>NOTE; The following will be different if + you use NIS, NIS+ or LDAP to distribute services maps.</para> + + <para>Look at your <filename>/etc/services</filename>. + What is defined at port 139/tcp. If nothing is defined + then add a line like this:</para> + + <para><userinput>netbios-ssn 139/tcp</userinput></para> + + <para>similarly for 137/udp you should have an entry like:</para> + + <para><userinput>netbios-ns 137/udp</userinput></para> + + <para>Next edit your <filename>/etc/inetd.conf</filename> + and add two lines something like this:</para> + + <para><programlisting> + netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd smbd + netbios-ns dgram udp wait root /usr/local/samba/bin/nmbd nmbd + </programlisting></para> + + <para>The exact syntax of <filename>/etc/inetd.conf</filename> + varies between unixes. Look at the other entries in inetd.conf + for a guide.</para> + + <note><para>Some unixes already have entries like netbios_ns + (note the underscore) in <filename>/etc/services</filename>. + You must either edit <filename>/etc/services</filename> or + <filename>/etc/inetd.conf</filename> to make them consistent.</para></note> + + <note><para>On many systems you may need to use the + <command>interfaces</command> option in &smb.conf; to specify the IP address + and netmask of your interfaces. Run <application>ifconfig</application> + as root if you don't know what the broadcast is for your + net. &nmbd; tries to determine it at run + time, but fails on some unixes. + </para></note> + + <warning><para>Many unixes only accept around 5 + parameters on the command line in <filename>inetd.conf</filename>. + This means you shouldn't use spaces between the options and + arguments, or you should use a script, and start the script + from <command>inetd</command>.</para></warning> + + <para>Restart <command>inetd</command>, perhaps just send + it a HUP. If you have installed an earlier version of <application> + nmbd</application> then you may need to kill nmbd as well.</para> + </sect2> + + <sect2> + <title>Alternative: starting it as a daemon</title> + + <para>To start the server as a daemon you should create + a script something like this one, perhaps calling + it <filename>startsmb</filename>.</para> + + <para><programlisting> + #!/bin/sh + /usr/local/samba/bin/smbd -D + /usr/local/samba/bin/nmbd -D + </programlisting></para> + + <para>then make it executable with <command>chmod + +x startsmb</command></para> + + <para>You can then run <command>startsmb</command> by + hand or execute it from <filename>/etc/rc.local</filename> + </para> + + <para>To kill it send a kill signal to the processes + <command>nmbd</command> and <command>smbd</command>.</para> + + <note><para>If you use the SVR4 style init system then + you may like to look at the <filename>examples/svr4-startup</filename> + script to make Samba fit into that system.</para></note> + </sect2> +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/DOMAIN_MEMBER.xml b/docs/docbook/projdoc/DOMAIN_MEMBER.xml new file mode 100644 index 0000000000..a5921e8ce3 --- /dev/null +++ b/docs/docbook/projdoc/DOMAIN_MEMBER.xml @@ -0,0 +1,161 @@ +<chapter id="domain-member"> + +<chapterinfo> + &author.jeremy; + &author.jerry; + <pubdate>16 Apr 2001</pubdate> +</chapterinfo> + + +<title>Samba as a NT4 or Win2k domain member</title> + +<sect1> + + <title>Joining an NT Domain with Samba 3.0</title> + <para><emphasis>Assumptions:</emphasis> + <programlisting> + NetBIOS name: SERV1 + Win2K/NT domain name: DOM + Domain's PDC NetBIOS name: DOMPDC + Domain's BDC NetBIOS names: DOMBDC1 and DOMBDC2 + </programlisting> + </para> + + <para>First, you must edit your &smb.conf; file to tell Samba it should + now use domain security.</para> + + <para>Change (or add) your <ulink url="smb.conf.5.html#SECURITY"> + <parameter>security =</parameter></ulink> line in the [global] section + of your &smb.conf; to read:</para> + + <para><command>security = domain</command></para> + + <para>Next change the <ulink url="smb.conf.5.html#WORKGROUP"><parameter> + workgroup =</parameter></ulink> line in the [global] section to read: </para> + + <para><command>workgroup = DOM</command></para> + + <para>as this is the name of the domain we are joining. </para> + + <para>You must also have the parameter <ulink url="smb.conf.5.html#ENCRYPTPASSWORDS"> + <parameter>encrypt passwords</parameter></ulink> set to <constant>yes + </constant> in order for your users to authenticate to the NT PDC.</para> + + <para>Finally, add (or modify) a <ulink url="smb.conf.5.html#PASSWORDSERVER"> + <parameter>password server =</parameter></ulink> line in the [global] + section to read: </para> + + <para><command>password server = DOMPDC DOMBDC1 DOMBDC2</command></para> + + <para>These are the primary and backup domain controllers Samba + will attempt to contact in order to authenticate users. Samba will + try to contact each of these servers in order, so you may want to + rearrange this list in order to spread out the authentication load + among domain controllers.</para> + + <para>Alternatively, if you want smbd to automatically determine + the list of Domain controllers to use for authentication, you may + set this line to be :</para> + + <para><command>password server = *</command></para> + + <para>This method, allows Samba to use exactly the same + mechanism that NT does. This + method either broadcasts or uses a WINS database in order to + find domain controllers to authenticate against.</para> + + <para>In order to actually join the domain, you must run this + command:</para> + + <para><prompt>root# </prompt><userinput>net join -S DOMPDC + -U<replaceable>Administrator%password</replaceable></userinput></para> + + <para> + If the <userinput>-S DOMPDC</userinput> argument is not given then + the domain name will be obtained from smb.conf. + </para> + + <para>as we are joining the domain DOM and the PDC for that domain + (the only machine that has write access to the domain SAM database) + is DOMPDC. The <replaceable>Administrator%password</replaceable> is + the login name and password for an account which has the necessary + privilege to add machines to the domain. If this is successful + you will see the message:</para> + + <para><computeroutput>Joined domain DOM.</computeroutput> + or <computeroutput>Joined 'SERV1' to realm 'MYREALM'</computeroutput> + </para> + + <para>in your terminal window. See the <ulink url="net.8.html"> + net(8)</ulink> man page for more details.</para> + + <para>This process joins the server to the domain + without having to create the machine trust account on the PDC + beforehand.</para> + + <para>This command goes through the machine account password + change protocol, then writes the new (random) machine account + password for this Samba server into a file in the same directory + in which an smbpasswd file would be stored - normally :</para> + + <para><filename>/usr/local/samba/private/secrets.tdb</filename></para> + + <para>This file is created and owned by root and is not + readable by any other user. It is the key to the domain-level + security for your system, and should be treated as carefully + as a shadow password file.</para> + + <para>Finally, restart your Samba daemons and get ready for + clients to begin using domain security!</para> +</sect1> + +<sect1> + <title>Why is this better than security = server?</title> + + <para>Currently, domain security in Samba doesn't free you from + having to create local Unix users to represent the users attaching + to your server. This means that if domain user <constant>DOM\fred + </constant> attaches to your domain security Samba server, there needs + to be a local Unix user fred to represent that user in the Unix + filesystem. This is very similar to the older Samba security mode + <ulink url="smb.conf.5.html#SECURITYEQUALSSERVER">security = server</ulink>, + where Samba would pass through the authentication request to a Windows + NT server in the same way as a Windows 95 or Windows 98 server would. + </para> + + <para>Please refer to the <ulink url="winbind.html">Winbind + paper</ulink> for information on a system to automatically + assign UNIX uids and gids to Windows NT Domain users and groups. + </para> + + <para>The advantage to domain-level security is that the + authentication in domain-level security is passed down the authenticated + RPC channel in exactly the same way that an NT server would do it. This + means Samba servers now participate in domain trust relationships in + exactly the same way NT servers do (i.e., you can add Samba servers into + a resource domain and have the authentication passed on from a resource + domain PDC to an account domain PDC).</para> + + <para>In addition, with <command>security = server</command> every Samba + daemon on a server has to keep a connection open to the + authenticating server for as long as that daemon lasts. This can drain + the connection resources on a Microsoft NT server and cause it to run + out of available connections. With <command>security = domain</command>, + however, the Samba daemons connect to the PDC/BDC only for as long + as is necessary to authenticate the user, and then drop the connection, + thus conserving PDC connection resources.</para> + + <para>And finally, acting in the same manner as an NT server + authenticating to a PDC means that as part of the authentication + reply, the Samba server gets the user identification information such + as the user SID, the list of NT groups the user belongs to, etc. </para> + + <note><para> Much of the text of this document + was first published in the Web magazine <ulink url="http://www.linuxworld.com"> + LinuxWorld</ulink> as the article <ulink + url="http://www.linuxworld.com/linuxworld/lw-1998-10/lw-10-samba.html">Doing + the NIS/NT Samba</ulink>.</para></note> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/Diagnosis.xml b/docs/docbook/projdoc/Diagnosis.xml new file mode 100644 index 0000000000..150f071b78 --- /dev/null +++ b/docs/docbook/projdoc/Diagnosis.xml @@ -0,0 +1,522 @@ +<chapter id="diagnosis"> +<chapterinfo> + &author.tridge; + &author.jelmer; + <pubdate>Wed Jan 15</pubdate> +</chapterinfo> + +<title>The samba checklist</title> + +<sect1> +<title>Introduction</title> + +<para> +This file contains a list of tests you can perform to validate your +Samba server. It also tells you what the likely cause of the problem +is if it fails any one of these steps. If it passes all these tests +then it is probably working fine. +</para> + +<para> +You should do ALL the tests, in the order shown. We have tried to +carefully choose them so later tests only use capabilities verified in +the earlier tests. However, do not stop at the first error as there +have been some instances when continuing with the tests has helped +to solve a problem. +</para> + +<para> +If you send one of the samba mailing lists an email saying "it doesn't work" +and you have not followed this test procedure then you should not be surprised +if your email is ignored. +</para> + +</sect1> + +<sect1> +<title>Assumptions</title> + +<para> +In all of the tests it is assumed you have a Samba server called +BIGSERVER and a PC called ACLIENT both in workgroup TESTGROUP. +</para> + +<para> +The procedure is similar for other types of clients. +</para> + +<para> +It is also assumed you know the name of an available share in your +&smb.conf;. I will assume this share is called <replaceable>tmp</replaceable>. +You can add a <replaceable>tmp</replaceable> share like this by adding the +following to &smb.conf;: +</para> + +<para><programlisting> + +[tmp] + comment = temporary files + path = /tmp + read only = yes + +</programlisting> +</para> + +<note><para> +These tests assume version 3.0 or later of the samba suite. +Some commands shown did not exist in earlier versions. +</para></note> + +<para> +Please pay attention to the error messages you receive. If any error message +reports that your server is being unfriendly you should first check that your +IP name resolution is correctly set up. eg: Make sure your <filename>/etc/resolv.conf</filename> +file points to name servers that really do exist. +</para> + +<para> +Also, if you do not have DNS server access for name resolution please check +that the settings for your &smb.conf; file results in <command>dns proxy = no</command>. The +best way to check this is with <userinput>testparm smb.conf</userinput>. +</para> + +<para> +It is helpful to monitor the log files during testing by using the +<command>tail -F <replaceable>log_file_name</replaceable></command> in a separate +terminal console (use ctrl-alt-F1 through F6 or multiple terminals in X). +Relevant log files can be found (for default installations) in +<filename>/usr/local/samba/var</filename>. Also, connection logs from +machines can be found here or possibly in <filename>/var/log/samba</filename> +depending on how or if you specified logging in your &smb.conf; file. +</para> + +<para> +If you make changes to your &smb.conf; file while going through these test, +don't forget to restart &smbd; and &nmbd;. +</para> + +</sect1> + +<sect1> +<title>The tests</title> +<procedure> +<title>Diagnosing your samba server</title> + +<step performance="required"> +<para> +In the directory in which you store your &smb.conf; file, run the command +<userinput>testparm smb.conf</userinput>. If it reports any errors then your &smb.conf; +configuration file is faulty. +</para> + +<note><para> +Your &smb.conf; file may be located in: <filename>/etc/samba</filename> +Or in: <filename>/usr/local/samba/lib</filename> +</para></note> +</step> + +<step performance="required"> +<para> +Run the command <userinput>ping BIGSERVER</userinput> from the PC and +<userinput>ping ACLIENT</userinput> from +the unix box. If you don't get a valid response then your TCP/IP +software is not correctly installed. +</para> + +<para> +Note that you will need to start a "dos prompt" window on the PC to +run ping. +</para> + +<para> +If you get a message saying "host not found" or similar then your DNS +software or <filename>/etc/hosts</filename> file is not correctly setup. +It is possible to +run samba without DNS entries for the server and client, but I assume +you do have correct entries for the remainder of these tests. +</para> + +<para> +Another reason why ping might fail is if your host is running firewall +software. You will need to relax the rules to let in the workstation +in question, perhaps by allowing access from another subnet (on Linux +this is done via the <application>ipfwadm</application> program.) +</para> + +<para> +Note: Modern Linux distributions install ipchains/iptables by default. +This is a common problem that is often overlooked. +</para> +</step> + +<step performance="required"> +<para> +Run the command <userinput>smbclient -L BIGSERVER</userinput> on the unix box. You +should get a list of available shares back. +</para> + +<para> +If you get a error message containing the string "Bad password" then +you probably have either an incorrect <command>hosts allow</command>, +<command>hosts deny</command> or <command>valid users</command> line in your +&smb.conf;, or your guest account is not +valid. Check what your guest account is using &testparm; and +temporarily remove any <command>hosts allow</command>, <command>hosts deny</command>, <command>valid users</command> or <command>invalid users</command> lines. +</para> + +<para> +If you get a "connection refused" response then the smbd server may +not be running. If you installed it in inetd.conf then you probably edited +that file incorrectly. If you installed it as a daemon then check that +it is running, and check that the netbios-ssn port is in a LISTEN +state using <userinput>netstat -a</userinput>. +</para> + +<note><para> +Some Unix / Linux systems use <command>xinetd</command> in place of +<command>inetd</command>. Check your system documentation for the location +of the control file/s for your particular system implementation of +this network super daemon. +</para></note> + +<para> +If you get a "session request failed" then the server refused the +connection. If it says "Your server software is being unfriendly" then +its probably because you have invalid command line parameters to &smbd;, +or a similar fatal problem with the initial startup of &smbd;. Also +check your config file (&smb.conf;) for syntax errors with &testparm; +and that the various directories where samba keeps its log and lock +files exist. +</para> + +<para> +There are a number of reasons for which smbd may refuse or decline +a session request. The most common of these involve one or more of +the following &smb.conf; file entries: +</para> + +<para><programlisting> + hosts deny = ALL + hosts allow = xxx.xxx.xxx.xxx/yy + bind interfaces only = Yes +</programlisting></para> + +<para> +In the above, no allowance has been made for any session requests that +will automatically translate to the loopback adaptor address 127.0.0.1. +To solve this problem change these lines to: +</para> + +<para><programlisting> + hosts deny = ALL + hosts allow = xxx.xxx.xxx.xxx/yy 127. +</programlisting></para> + +<para> +Do NOT use the <command>bind interfaces only</command> parameter where you +may wish to +use the samba password change facility, or where &smbclient; may need to +access a local service for name resolution or for local resource +connections. (Note: the <command>bind interfaces only</command> parameter deficiency +where it will not allow connections to the loopback address will be +fixed soon). +</para> + +<para> +Another common cause of these two errors is having something already running +on port 139, such as Samba (ie: smbd is running from <application>inetd</application> already) or +something like Digital's Pathworks. Check your <filename>inetd.conf</filename> file before trying +to start &smbd; as a daemon, it can avoid a lot of frustration! +</para> + +<para> +And yet another possible cause for failure of this test is when the subnet mask +and / or broadcast address settings are incorrect. Please check that the +network interface IP Address / Broadcast Address / Subnet Mask settings are +correct and that Samba has correctly noted these in the <filename>log.nmb</filename> file. +</para> + +</step> + +<step performance="required"> + +<para> +Run the command <userinput>nmblookup -B BIGSERVER __SAMBA__</userinput>. You should get the +IP address of your Samba server back. +</para> + +<para> +If you don't then nmbd is incorrectly installed. Check your <filename>inetd.conf</filename> +if you run it from there, or that the daemon is running and listening +to udp port 137. +</para> + +<para> +One common problem is that many inetd implementations can't take many +parameters on the command line. If this is the case then create a +one-line script that contains the right parameters and run that from +inetd. +</para> + +</step> + +<step performance="required"> + +<para>run the command <userinput>nmblookup -B ACLIENT '*'</userinput></para> + +<para> +You should get the PCs IP address back. If you don't then the client +software on the PC isn't installed correctly, or isn't started, or you +got the name of the PC wrong. +</para> + +<para> +If ACLIENT doesn't resolve via DNS then use the IP address of the +client in the above test. +</para> + +</step> + +<step performance="required"> + +<para> +Run the command <userinput>nmblookup -d 2 '*'</userinput> +</para> + +<para> +This time we are trying the same as the previous test but are trying +it via a broadcast to the default broadcast address. A number of +Netbios/TCPIP hosts on the network should respond, although Samba may +not catch all of the responses in the short time it listens. You +should see "got a positive name query response" messages from several +hosts. +</para> + +<para> +If this doesn't give a similar result to the previous test then +nmblookup isn't correctly getting your broadcast address through its +automatic mechanism. In this case you should experiment with the +<command>interfaces</command> option in &smb.conf; to manually configure your IP +address, broadcast and netmask. +</para> + +<para> +If your PC and server aren't on the same subnet then you will need to +use the <parameter>-B</parameter> option to set the broadcast address to that of the PCs +subnet. +</para> + +<para> +This test will probably fail if your subnet mask and broadcast address are +not correct. (Refer to TEST 3 notes above). +</para> + +</step> + +<step performance="required"> + +<para> +Run the command <userinput>smbclient //BIGSERVER/TMP</userinput>. You should +then be prompted for a password. You should use the password of the account +you are logged into the unix box with. If you want to test with +another account then add the <parameter>-U <replaceable>accountname</replaceable></parameter> option to the end of +the command line. eg: +<userinput>smbclient //bigserver/tmp -Ujohndoe</userinput> +</para> + +<note><para> +It is possible to specify the password along with the username +as follows: +<userinput>smbclient //bigserver/tmp -Ujohndoe%secret</userinput> +</para></note> + +<para> +Once you enter the password you should get the <prompt>smb></prompt> prompt. If you +don't then look at the error message. If it says "invalid network +name" then the service "tmp" is not correctly setup in your &smb.conf;. +</para> + +<para> +If it says "bad password" then the likely causes are: +</para> + +<orderedlist> +<listitem> + <para> + you have shadow passords (or some other password system) but didn't + compile in support for them in &smbd; + </para> +</listitem> + +<listitem> + <para> + your <command>valid users</command> configuration is incorrect + </para> +</listitem> + +<listitem> + <para> + you have a mixed case password and you haven't enabled the <command>password + level</command> option at a high enough level + </para> +</listitem> + +<listitem> + <para> + the <command>path =</command> line in &smb.conf; is incorrect. Check it with &testparm; + </para> +</listitem> + +<listitem> + <para> + you enabled password encryption but didn't create the SMB encrypted + password file + </para> +</listitem> +</orderedlist> + +<para> +Once connected you should be able to use the commands +<command>dir</command> <command>get</command> <command>put</command> etc. +Type <command>help <replaceable>command</replaceable></command> for instructions. You should +especially check that the amount of free disk space shown is correct +when you type <command>dir</command>. +</para> + +</step> + +<step performance="required"> + +<para> +On the PC, type the command <userinput>net view \\BIGSERVER</userinput>. You will +need to do this from within a "dos prompt" window. You should get back a +list of available shares on the server. +</para> + +<para> +If you get a "network name not found" or similar error then netbios +name resolution is not working. This is usually caused by a problem in +nmbd. To overcome it you could do one of the following (you only need +to choose one of them): +</para> + +<orderedlist> +<listitem><para> + fixup the &nmbd; installation +</para></listitem> + +<listitem><para> + add the IP address of BIGSERVER to the <command>wins server</command> box in the + advanced tcp/ip setup on the PC. +</para></listitem> + +<listitem><para> + enable windows name resolution via DNS in the advanced section of + the tcp/ip setup +</para></listitem> + +<listitem><para> + add BIGSERVER to your lmhosts file on the PC. +</para></listitem> +</orderedlist> + +<para> +If you get a "invalid network name" or "bad password error" then the +same fixes apply as they did for the <userinput>smbclient -L</userinput> test above. In +particular, make sure your <command>hosts allow</command> line is correct (see the man +pages) +</para> + +<para> +Also, do not overlook that fact that when the workstation requests the +connection to the samba server it will attempt to connect using the +name with which you logged onto your Windows machine. You need to make +sure that an account exists on your Samba server with that exact same +name and password. +</para> + +<para> +If you get "specified computer is not receiving requests" or similar +it probably means that the host is not contactable via tcp services. +Check to see if the host is running tcp wrappers, and if so add an entry in +the <filename>hosts.allow</filename> file for your client (or subnet, etc.) +</para> + +</step> + +<step performance="required"> + +<para> +Run the command <userinput>net use x: \\BIGSERVER\TMP</userinput>. You should +be prompted for a password then you should get a "command completed +successfully" message. If not then your PC software is incorrectly +installed or your smb.conf is incorrect. make sure your <command>hosts allow</command> +and other config lines in &smb.conf; are correct. +</para> + +<para> +It's also possible that the server can't work out what user name to +connect you as. To see if this is the problem add the line <command>user = +<replaceable>username</replaceable></command> to the <command>[tmp]</command> section of +&smb.conf; where <replaceable>username</replaceable> is the +username corresponding to the password you typed. If you find this +fixes things you may need the username mapping option. +</para> + +<para> +It might also be the case that your client only sends encrypted passwords +and you have <command>encrypt passwords = no</command> in &smb.conf; +Turn it back on to fix. +</para> + +</step> + +<step performance="required"> + +<para> +Run the command <userinput>nmblookup -M <replaceable>testgroup</replaceable></userinput> where +<replaceable>testgroup</replaceable> is the name of the workgroup that your Samba server and +Windows PCs belong to. You should get back the IP address of the +master browser for that workgroup. +</para> + +<para> +If you don't then the election process has failed. Wait a minute to +see if it is just being slow then try again. If it still fails after +that then look at the browsing options you have set in &smb.conf;. Make +sure you have <command>preferred master = yes</command> to ensure that +an election is held at startup. +</para> + +</step> + +<step performance="required"> + +<para> +>From file manager try to browse the server. Your samba server should +appear in the browse list of your local workgroup (or the one you +specified in smb.conf). You should be able to double click on the name +of the server and get a list of shares. If you get a "invalid +password" error when you do then you are probably running WinNT and it +is refusing to browse a server that has no encrypted password +capability and is in user level security mode. In this case either set +<command>security = server</command> AND +<command>password server = Windows_NT_Machine</command> in your +&smb.conf; file, or make sure <command>encrypted passwords</command> is +set to "yes". +</para> + +</step> +</procedure> +</sect1> + +<sect1> +<title>Still having troubles?</title> + +<para>Read the chapter on +<link linkend="problems">Analysing and Solving Problems</link>. +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml b/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml new file mode 100644 index 0000000000..af6ddff9bf --- /dev/null +++ b/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml @@ -0,0 +1,104 @@ +<?xml version="1.0" encoding="iso8859-1"?> +<chapter id="groupmapping"> +<chapterinfo> + <author> + <firstname>Jean François</firstname><surname>Micouleau</surname> + </author> + &author.jerry; +</chapterinfo> + +<title>Configuring Group Mapping</title> + +<para> +Starting with Samba 3.0 alpha 2, new group mapping functionality +is available to create associations between Windows SIDs and UNIX +groups. The <parameter>groupmap</parameter> subcommand included with +the <command>net</command> tool can be used to manage these associations. +</para> + +<para> +The first immediate reason to use the group mapping on a Samba PDC, is that +the <parameter>domain admin group</parameter> &smb.conf; has been removed. +This parameter was used to give the listed users membership in the "Domain Admins" +Windows group which gave local admin rights on their workstations (in +default configurations). +</para> + +<para> +When installing NT/W2K on a computer, the installer program creates some users +and groups. Notably the 'Administrators' group, and gives to that group some +privileges like the ability to change the date and time or to kill any process +(or close too) running on the local machine. The 'Administrator' user is a +member of the 'Administrators' group, and thus 'inherit' the 'Administrators' +group privileges. If a 'joe' user is created and become a member of the +'Administrator' group, 'joe' has exactly the same rights as 'Administrator'. +</para> + +<para> +When a NT/W2K machine is joined to a domain, the "Domain Adminis" group of the +PDC is added to the local 'Administrators' group of the workstation. Every +member of the 'Domain Administrators' group 'inherit' the +rights of the local 'Administrators' group when logging on the workstation. +</para> + +<para> +The following steps describe how to make samba PDC users members of the +'Domain Admins' group? +</para> + +<orderedlist> +<listitem><para>create a unix group (usually in <filename>/etc/group</filename>), + let's call it domadm</para></listitem> +<listitem><para>add to this group the users that must be Administrators. For example + if you want joe,john and mary, your entry in <filename>/etc/group</filename> will + look like:</para> + + <para><programlisting> + domadm:x:502:joe,john,mary + </programlisting></para> + + </listitem> + +<listitem><para>Map this domadm group to the "Domain Admins" group + by running the command:</para> + + <para><prompt>root# </prompt><userinput>net groupmap add ntgroup="Domain Admins" unixgroup=domadm</userinput></para> + + <para>The quotes around "Domain Admins" are necessary due to the space in the group name. Also make + sure to leave no whitespace surrounding the equal character (=).</para> + </listitem> + +</orderedlist> + +<para>Now joe, john and mary are domain administrators!</para> + +<para> +It is possible to map any arbitrary UNIX group to any Windows NT +group as well as making any UNIX group a Windows domain group. +For example, if you wanted to include a UNIX group (e.g. acct) in a ACL on a +local file or printer on a domain member machine, you would flag +that group as a domain group by running the following on the Samba PDC: +</para> + +<para><prompt>root# </prompt><userinput>net groupmap add rid=1000 ntgroup="Accounting" unixgroup=acct</userinput></para> + +<para>Be aware that the rid parmeter is a unsigned 32 bit integer that should +normally start at 1000. However, this rid must not overlap with any RID assigned +to a user. Verifying this is done differently depending on on the passdb backend +you are using. Future versions of the tools may perform the verification automatically, +but for now the burden in on you.</para> + +<para>You can list the various groups in the mapping database by executing +<command>net groupmap list</command>. Here is an example:</para> + +<para><programlisting><prompt>root# </prompt>net groupmap list +System Administrators (S-1-5-21-2547222302-1596225915-2414751004-1002) -> sysadmin +Domain Admins (S-1-5-21-2547222302-1596225915-2414751004-512) -> domadmin +Domain Users (S-1-5-21-2547222302-1596225915-2414751004-513) -> domuser +Domain Guests (S-1-5-21-2547222302-1596225915-2414751004-514) -> domguest +</programlisting></para> + +<para>For complete details on <command>net groupmap</command>, refer to the +net(8) man page.</para> + +</chapter> diff --git a/docs/docbook/projdoc/Integrating-with-Windows.xml b/docs/docbook/projdoc/Integrating-with-Windows.xml new file mode 100644 index 0000000000..9f0de0a56a --- /dev/null +++ b/docs/docbook/projdoc/Integrating-with-Windows.xml @@ -0,0 +1,545 @@ +<chapter id="integrate-ms-networks"> + +<chapterinfo> + &author.jht; + <pubdate> (Jan 01 2001) </pubdate> +</chapterinfo> + +<title>Integrating MS Windows networks with Samba</title> + +<para> +This section deals with NetBIOS over TCP/IP name to IP address resolution. If +your MS Windows clients are NOT configured to use NetBIOS over TCP/IP then this +section does not apply to your installation. If your installation involves use of +NetBIOS over TCP/IP then this section may help you to resolve networking problems. +</para> + +<note> +<para> + NetBIOS over TCP/IP has nothing to do with NetBEUI. NetBEUI is NetBIOS + over Logical Link Control (LLC). On modern networks it is highly advised + to NOT run NetBEUI at all. Note also that there is NO such thing as + NetBEUI over TCP/IP - the existence of such a protocol is a complete + and utter mis-apprehension. +</para> +</note> + +<para> +Since the introduction of MS Windows 2000 it is possible to run MS Windows networking +without the use of NetBIOS over TCP/IP. NetBIOS over TCP/IP uses UDP port 137 for NetBIOS +name resolution and uses TCP port 139 for NetBIOS session services. When NetBIOS over +TCP/IP is disabled on MS Windows 2000 and later clients then only TCP port 445 will be +used and UDP port 137 and TCP port 139 will not. +</para> + +<note> +<para> +When using Windows 2000 or later clients, if NetBIOS over TCP/IP is NOT disabled, then +the client will use UDP port 137 (NetBIOS Name Service, also known as the Windows Internet +Name Service or WINS), TCP port 139 AND TCP port 445 (for actual file and print traffic). +</para> +</note> + +<para> +When NetBIOS over TCP/IP is disabled the use of DNS is essential. Most installations that +disable NetBIOS over TCP/IP today use MS Active Directory Service (ADS). ADS requires +Dynamic DNS with Service Resource Records (SRV RR) and with Incremental Zone Transfers (IXFR). +Use of DHCP with ADS is recommended as a further means of maintaining central control +over client workstation network configuration. +</para> + + +<sect1> +<title>Name Resolution in a pure Unix/Linux world</title> + +<para> +The key configuration files covered in this section are: +</para> + +<itemizedlist> + <listitem><para><filename>/etc/hosts</filename></para></listitem> + <listitem><para><filename>/etc/resolv.conf</filename></para></listitem> + <listitem><para><filename>/etc/host.conf</filename></para></listitem> + <listitem><para><filename>/etc/nsswitch.conf</filename></para></listitem> +</itemizedlist> + +<sect2> +<title><filename>/etc/hosts</filename></title> + +<para> +Contains a static list of IP Addresses and names. +eg: +</para> +<para><programlisting> + 127.0.0.1 localhost localhost.localdomain + 192.168.1.1 bigbox.caldera.com bigbox alias4box +</programlisting></para> + +<para> +The purpose of <filename>/etc/hosts</filename> is to provide a +name resolution mechanism so that uses do not need to remember +IP addresses. +</para> + + +<para> +Network packets that are sent over the physical network transport +layer communicate not via IP addresses but rather using the Media +Access Control address, or MAC address. IP Addresses are currently +32 bits in length and are typically presented as four (4) decimal +numbers that are separated by a dot (or period). eg: 168.192.1.1 +</para> + +<para> +MAC Addresses use 48 bits (or 6 bytes) and are typically represented +as two digit hexadecimal numbers separated by colons. eg: +40:8e:0a:12:34:56 +</para> + +<para> +Every network interfrace must have an MAC address. Associated with +a MAC address there may be one or more IP addresses. There is NO +relationship between an IP address and a MAC address, all such assignments +are arbitary or discretionary in nature. At the most basic level all +network communications takes place using MAC addressing. Since MAC +addresses must be globally unique, and generally remains fixed for +any particular interface, the assignment of an IP address makes sense +from a network management perspective. More than one IP address can +be assigned per MAC address. One address must be the primary IP address, +this is the address that will be returned in the ARP reply. +</para> + +<para> +When a user or a process wants to communicate with another machine +the protocol implementation ensures that the "machine name" or "host +name" is resolved to an IP address in a manner that is controlled +by the TCP/IP configuration control files. The file +<filename>/etc/hosts</filename> is one such file. +</para> + +<para> +When the IP address of the destination interface has been +determined a protocol called ARP/RARP is used to identify +the MAC address of the target interface. ARP stands for Address +Resolution Protocol, and is a broadcast oriented method that +uses UDP (User Datagram Protocol) to send a request to all +interfaces on the local network segment using the all 1's MAC +address. Network interfaces are programmed to respond to two +MAC addresses only; their own unique address and the address +ff:ff:ff:ff:ff:ff. The reply packet from an ARP request will +contain the MAC address and the primary IP address for each +interface. +</para> + +<para> +The <filename>/etc/hosts</filename> file is foundational to all +Unix/Linux TCP/IP installations and as a minumum will contain +the localhost and local network interface IP addresses and the +primary names by which they are known within the local machine. +This file helps to prime the pump so that a basic level of name +resolution can exist before any other method of name resolution +becomes available. +</para> + +</sect2> + + +<sect2> +<title><filename>/etc/resolv.conf</filename></title> + +<para> +This file tells the name resolution libraries: +</para> + +<itemizedlist> + <listitem><para>The name of the domain to which the machine + belongs + </para></listitem> + + <listitem><para>The name(s) of any domains that should be + automatically searched when trying to resolve unqualified + host names to their IP address + </para></listitem> + + <listitem><para>The name or IP address of available Domain + Name Servers that may be asked to perform name to address + translation lookups + </para></listitem> +</itemizedlist> + +</sect2> + + +<sect2> +<title><filename>/etc/host.conf</filename></title> + + +<para> +<filename>/etc/host.conf</filename> is the primary means by +which the setting in /etc/resolv.conf may be affected. It is a +critical configuration file. This file controls the order by +which name resolution may procede. The typical structure is: +</para> + +<para><programlisting> + order hosts,bind + multi on +</programlisting></para> + +<para> +then both addresses should be returned. Please refer to the +man page for host.conf for further details. +</para> + + +</sect2> + + + +<sect2> +<title><filename>/etc/nsswitch.conf</filename></title> + +<para> +This file controls the actual name resolution targets. The +file typically has resolver object specifications as follows: +</para> + + +<para><programlisting> + # /etc/nsswitch.conf + # + # Name Service Switch configuration file. + # + + passwd: compat + # Alternative entries for password authentication are: + # passwd: compat files nis ldap winbind + shadow: compat + group: compat + + hosts: files nis dns + # Alternative entries for host name resolution are: + # hosts: files dns nis nis+ hesoid db compat ldap wins + networks: nis files dns + + ethers: nis files + protocols: nis files + rpc: nis files + services: nis files +</programlisting></para> + +<para> +Of course, each of these mechanisms requires that the appropriate +facilities and/or services are correctly configured. +</para> + +<para> +It should be noted that unless a network request/message must be +sent, TCP/IP networks are silent. All TCP/IP communications assumes a +principal of speaking only when necessary. +</para> + +<para> +Starting with version 2.2.0 samba has Linux support for extensions to +the name service switch infrastructure so that linux clients will +be able to obtain resolution of MS Windows NetBIOS names to IP +Addresses. To gain this functionality Samba needs to be compiled +with appropriate arguments to the make command (ie: <command>make +nsswitch/libnss_wins.so</command>). The resulting library should +then be installed in the <filename>/lib</filename> directory and +the "wins" parameter needs to be added to the "hosts:" line in +the <filename>/etc/nsswitch.conf</filename> file. At this point it +will be possible to ping any MS Windows machine by it's NetBIOS +machine name, so long as that machine is within the workgroup to +which both the samba machine and the MS Windows machine belong. +</para> + +</sect2> +</sect1> + + +<sect1> +<title>Name resolution as used within MS Windows networking</title> + +<para> +MS Windows networking is predicated about the name each machine +is given. This name is known variously (and inconsistently) as +the "computer name", "machine name", "networking name", "netbios name", +"SMB name". All terms mean the same thing with the exception of +"netbios name" which can apply also to the name of the workgroup or the +domain name. The terms "workgroup" and "domain" are really just a +simply name with which the machine is associated. All NetBIOS names +are exactly 16 characters in length. The 16th character is reserved. +It is used to store a one byte value that indicates service level +information for the NetBIOS name that is registered. A NetBIOS machine +name is therefore registered for each service type that is provided by +the client/server. +</para> + +<para> +The following are typical NetBIOS name/service type registrations: +</para> + +<para><programlisting> + Unique NetBIOS Names: + MACHINENAME<00> = Server Service is running on MACHINENAME + MACHINENAME<03> = Generic Machine Name (NetBIOS name) + MACHINENAME<20> = LanMan Server service is running on MACHINENAME + WORKGROUP<1b> = Domain Master Browser + + Group Names: + WORKGROUP<03> = Generic Name registered by all members of WORKGROUP + WORKGROUP<1c> = Domain Controllers / Netlogon Servers + WORKGROUP<1d> = Local Master Browsers + WORKGROUP<1e> = Internet Name Resolvers +</programlisting></para> + +<para> +It should be noted that all NetBIOS machines register their own +names as per the above. This is in vast contrast to TCP/IP +installations where traditionally the system administrator will +determine in the /etc/hosts or in the DNS database what names +are associated with each IP address. +</para> + +<para> +One further point of clarification should be noted, the <filename>/etc/hosts</filename> +file and the DNS records do not provide the NetBIOS name type information +that MS Windows clients depend on to locate the type of service that may +be needed. An example of this is what happens when an MS Windows client +wants to locate a domain logon server. It finds this service and the IP +address of a server that provides it by performing a lookup (via a +NetBIOS broadcast) for enumeration of all machines that have +registered the name type *<1c>. A logon request is then sent to each +IP address that is returned in the enumerated list of IP addresses. Which +ever machine first replies then ends up providing the logon services. +</para> + +<para> +The name "workgroup" or "domain" really can be confusing since these +have the added significance of indicating what is the security +architecture of the MS Windows network. The term "workgroup" indicates +that the primary nature of the network environment is that of a +peer-to-peer design. In a WORKGROUP all machines are responsible for +their own security, and generally such security is limited to use of +just a password (known as SHARE MODE security). In most situations +with peer-to-peer networking the users who control their own machines +will simply opt to have no security at all. It is possible to have +USER MODE security in a WORKGROUP environment, thus requiring use +of a user name and a matching password. +</para> + +<para> +MS Windows networking is thus predetermined to use machine names +for all local and remote machine message passing. The protocol used is +called Server Message Block (SMB) and this is implemented using +the NetBIOS protocol (Network Basic Input Output System). NetBIOS can +be encapsulated using LLC (Logical Link Control) protocol - in which case +the resulting protocol is called NetBEUI (Network Basic Extended User +Interface). NetBIOS can also be run over IPX (Internetworking Packet +Exchange) protocol as used by Novell NetWare, and it can be run +over TCP/IP protocols - in which case the resulting protocol is called +NBT or NetBT, the NetBIOS over TCP/IP. +</para> + +<para> +MS Windows machines use a complex array of name resolution mechanisms. +Since we are primarily concerned with TCP/IP this demonstration is +limited to this area. +</para> + +<sect2> +<title>The NetBIOS Name Cache</title> + +<para> +All MS Windows machines employ an in memory buffer in which is +stored the NetBIOS names and IP addresses for all external +machines that that machine has communicated with over the +past 10-15 minutes. It is more efficient to obtain an IP address +for a machine from the local cache than it is to go through all the +configured name resolution mechanisms. +</para> + +<para> +If a machine whose name is in the local name cache has been shut +down before the name had been expired and flushed from the cache, then +an attempt to exchange a message with that machine will be subject +to time-out delays. i.e.: Its name is in the cache, so a name resolution +lookup will succeed, but the machine can not respond. This can be +frustrating for users - but it is a characteristic of the protocol. +</para> + +<para> +The MS Windows utility that allows examination of the NetBIOS +name cache is called "nbtstat". The Samba equivalent of this +is called "nmblookup". +</para> + +</sect2> + +<sect2> +<title>The LMHOSTS file</title> + +<para> +This file is usually located in MS Windows NT 4.0 or +2000 in <filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains +the IP Address and the machine name in matched pairs. The +<filename>LMHOSTS</filename> file performs NetBIOS name +to IP address mapping. +</para> + +<para> +It typically looks like: +</para> + +<para><programlisting> + # Copyright (c) 1998 Microsoft Corp. + # + # This is a sample LMHOSTS file used by the Microsoft Wins Client (NetBIOS + # over TCP/IP) stack for Windows98 + # + # This file contains the mappings of IP addresses to NT computernames + # (NetBIOS) names. Each entry should be kept on an individual line. + # The IP address should be placed in the first column followed by the + # corresponding computername. The address and the comptername + # should be separated by at least one space or tab. The "#" character + # is generally used to denote the start of a comment (see the exceptions + # below). + # + # This file is compatible with Microsoft LAN Manager 2.x TCP/IP lmhosts + # files and offers the following extensions: + # + # #PRE + # #DOM:<domain> + # #INCLUDE <filename> + # #BEGIN_ALTERNATE + # #END_ALTERNATE + # \0xnn (non-printing character support) + # + # Following any entry in the file with the characters "#PRE" will cause + # the entry to be preloaded into the name cache. By default, entries are + # not preloaded, but are parsed only after dynamic name resolution fails. + # + # Following an entry with the "#DOM:<domain>" tag will associate the + # entry with the domain specified by <domain>. This affects how the + # browser and logon services behave in TCP/IP environments. To preload + # the host name associated with #DOM entry, it is necessary to also add a + # #PRE to the line. The <domain> is always preloaded although it will not + # be shown when the name cache is viewed. + # + # Specifying "#INCLUDE <filename>" will force the RFC NetBIOS (NBT) + # software to seek the specified <filename> and parse it as if it were + # local. <filename> is generally a UNC-based name, allowing a + # centralized lmhosts file to be maintained on a server. + # It is ALWAYS necessary to provide a mapping for the IP address of the + # server prior to the #INCLUDE. This mapping must use the #PRE directive. + # In addtion the share "public" in the example below must be in the + # LanManServer list of "NullSessionShares" in order for client machines to + # be able to read the lmhosts file successfully. This key is under + # \machine\system\currentcontrolset\services\lanmanserver\parameters\nullsessionshares + # in the registry. Simply add "public" to the list found there. + # + # The #BEGIN_ and #END_ALTERNATE keywords allow multiple #INCLUDE + # statements to be grouped together. Any single successful include + # will cause the group to succeed. + # + # Finally, non-printing characters can be embedded in mappings by + # first surrounding the NetBIOS name in quotations, then using the + # \0xnn notation to specify a hex value for a non-printing character. + # + # The following example illustrates all of these extensions: + # + # 102.54.94.97 rhino #PRE #DOM:networking #net group's DC + # 102.54.94.102 "appname \0x14" #special app server + # 102.54.94.123 popular #PRE #source server + # 102.54.94.117 localsrv #PRE #needed for the include + # + # #BEGIN_ALTERNATE + # #INCLUDE \\localsrv\public\lmhosts + # #INCLUDE \\rhino\public\lmhosts + # #END_ALTERNATE + # + # In the above example, the "appname" server contains a special + # character in its name, the "popular" and "localsrv" server names are + # preloaded, and the "rhino" server name is specified so it can be used + # to later #INCLUDE a centrally maintained lmhosts file if the "localsrv" + # system is unavailable. + # + # Note that the whole file is parsed including comments on each lookup, + # so keeping the number of comments to a minimum will improve performance. + # Therefore it is not advisable to simply add lmhosts file entries onto the + # end of this file. +</programlisting></para> + +</sect2> + +<sect2> +<title>HOSTS file</title> + +<para> +This file is usually located in MS Windows NT 4.0 or 2000 in +<filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains +the IP Address and the IP hostname in matched pairs. It can be +used by the name resolution infrastructure in MS Windows, depending +on how the TCP/IP environment is configured. This file is in +every way the equivalent of the Unix/Linux <filename>/etc/hosts</filename> file. +</para> +</sect2> + + +<sect2> +<title>DNS Lookup</title> + +<para> +This capability is configured in the TCP/IP setup area in the network +configuration facility. If enabled an elaborate name resolution sequence +is followed the precise nature of which is dependant on what the NetBIOS +Node Type parameter is configured to. A Node Type of 0 means use +NetBIOS broadcast (over UDP broadcast) is first used if the name +that is the subject of a name lookup is not found in the NetBIOS name +cache. If that fails then DNS, HOSTS and LMHOSTS are checked. If set to +Node Type 8, then a NetBIOS Unicast (over UDP Unicast) is sent to the +WINS Server to obtain a lookup before DNS, HOSTS, LMHOSTS, or broadcast +lookup is used. +</para> + +</sect2> + +<sect2> +<title>WINS Lookup</title> + +<para> +A WINS (Windows Internet Name Server) service is the equivaent of the +rfc1001/1002 specified NBNS (NetBIOS Name Server). A WINS server stores +the names and IP addresses that are registered by a Windows client +if the TCP/IP setup has been given at least one WINS Server IP Address. +</para> + +<para> +To configure Samba to be a WINS server the following parameter needs +to be added to the &smb.conf; file: +</para> + +<para><programlisting> + wins support = Yes +</programlisting></para> + +<para> +To configure Samba to use a WINS server the following parameters are +needed in the &smb.conf; file: +</para> + +<para><programlisting> + wins support = No + wins server = xxx.xxx.xxx.xxx +</programlisting></para> + +<para> +where <replaceable>xxx.xxx.xxx.xxx</replaceable> is the IP address +of the WINS server. +</para> + +</sect2> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/InterdomainTrusts.xml b/docs/docbook/projdoc/InterdomainTrusts.xml new file mode 100644 index 0000000000..2c492d4ac0 --- /dev/null +++ b/docs/docbook/projdoc/InterdomainTrusts.xml @@ -0,0 +1,222 @@ +<chapter id="InterdomainTrusts"> +<chapterinfo> + &author.jht; + &author.mimir; + <pubdate>April 3, 2003</pubdate> +</chapterinfo> + +<title>Interdomain Trust Relationships</title> + +<para> +Samba-3 supports NT4 style domain trust relationships. This is feature that many sites +will want to use if they migrate to Samba-3 from and NT4 style domain and do NOT want to +adopt Active Directory or an LDAP based authentication back end. This section explains +some background information regarding trust relationships and how to create them. It is now +possible for Samba-3 to NT4 trust (and vice versa), as well as Samba3 to Samba3 trusts. +</para> + +<sect1> +<title>Trust Relationship Background</title> + +<para> +MS Windows NT3.x/4.0 type security domains employ a non-hierarchical security structure. +The limitations of this architecture as it affects the scalability of MS Windows networking +in large organisations is well known. Additionally, the flat-name space that results from +this design significantly impacts the delegation of administrative responsibilities in +large and diverse organisations. +</para> + +<para> +Microsoft developed Active Directory Service (ADS), based on Kerberos and LDAP, as a means +of circumventing the limitations of the older technologies. Not every organisation is ready +or willing to embrace ADS. For small companies the older NT4 style domain security paradigm +is quite adequate, there thus remains an entrenched user base for whom there is no direct +desire to go through a disruptive change to adopt ADS. +</para> + +<para> +Microsoft introduced with MS Windows NT the ability to allow differing security domains +to affect a mechanism so that users from one domain may be given access rights and privileges +in another domain. The language that describes this capability is couched in terms of +<emphasis>Trusts</emphasis>. Specifically, one domain will <emphasis>trust</emphasis> the users +from another domain. The domain from which users are available to another security domain is +said to be a trusted domain. The domain in which those users have assigned rights and privileges +is the trusting domain. With NT3.x/4.0 all trust relationships are always in one direction only, +thus if users in both domains are to have privileges and rights in each others' domain, then it is +necessary to establish two (2) relationships, one in each direction. +</para> + +<para> +In an NT4 style MS security domain, all trusts are non-transitive. This means that if there +are three (3) domains (let's call them RED, WHITE, and BLUE) where RED and WHITE have a trust +relationship, and WHITE and BLUE have a trust relationship, then it holds that there is no +implied trust between the RED and BLUE domains. ie: Relationships are explicit and not +transitive. +</para> + +<para> +New to MS Windows 2000 ADS security contexts is the fact that trust relationships are two-way +by default. Also, all inter-ADS domain trusts are transitive. In the case of the RED, WHITE and BLUE +domains above, with Windows 2000 and ADS the RED and BLUE domains CAN trust each other. This is +an inherent feature of ADS domains. Samba-3 implements MS Windows NT4 +style Interdomain trusts and interoperates with MS Windows 200x ADS +security domains in similar manner to MS Windows NT4 style domains. +</para> + +</sect1> + +<sect1> +<title>Native MS Windows NT4 Trusts Configuration</title> + +<para> +There are two steps to creating an interdomain trust relationship. +</para> + +<sect2> +<title>NT4 as the Trusting Domain (ie. creating the trusted account)</title> + +<para> +For MS Windows NT4, all domain trust relationships are configured using the Domain User Manager. +To affect a two way trust relationship it is necessary for each domain administrator to make +available (for use by an external domain) it's security resources. This is done from the Domain +User Manager Policies entry on the menu bar. From the Policy menu, select Trust Relationships, then +next to the lower box that is labelled "Permitted to Trust this Domain" are two buttons, "Add" and +"Remove". The "Add" button will open a panel in which needs to be entered the remote domain that +will be able to assign user rights to your domain. In addition it is necessary to enter a password +that is specific to this trust relationship. The password needs to be +typed twice (for standard confirmation). +</para> + +</sect2> + +<sect2> +<title>NT4 as the Trusted Domain (ie. creating trusted account's password)</title> + +<para> +A trust relationship will work only when the other (trusting) domain makes the appropriate connections +with the trusted domain. To consumate the trust relationship the administrator will launch the +Domain User Manager, from the menu select Policies, then select Trust Relationships, then click on the +"Add" button that is next to the box that is labelled "Trusted Domains". A panel will open in +which must be entered the name of the remote domain as well as the password assigned to that trust. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Configuring Samba NT-style Domain Trusts</title> + +<para> +This description is meant to be a fairly short introduction about how to set up a Samba server so +that it could participate in interdomain trust relationships. Trust relationship support in Samba +is in its early stage, so lot of things don't work yet. +</para> + +<para> +Each of the procedures described below is treated as they were performed with Windows NT4 Server on +one end. The remote end could just as well be another Samba-3 domain. It can be clearly seen, after +reading this document, that combining Samba-specific parts of what's written below leads to trust +between domains in purely Samba environment. +</para> + +<sect2> +<title>Samba-3 as the Trusting Domain</title> + +<para> +In order to set the Samba PDC to be the trusted party of the relationship first you need +to create special account for the domain that will be the trusting party. To do that, +you can use the 'smbpasswd' utility. Creating the trusted domain account is very +similiar to creating a trusted machine account. Suppose, your domain is +called SAMBA, and the remote domain is called RUMBA. The first step +will be to issue this command from your favourite shell: +</para> + +<para> +<screen> +<prompt>deity#</prompt> <userinput>smbpasswd -a -i rumba</userinput> + New SMB password: XXXXXXXX + Retype SMB password: XXXXXXXX + Added user rumba$ +</screen> + +where <parameter>-a</parameter> means to add a new account into the +passdb database and <parameter>-i</parameter> means: ''create this +account with the InterDomain trust flag'' +</para> + +<para> +The account name will be 'rumba$' (the name of the remote domain) +</para> + +<para> +After issuing this command you'll be asked to enter the password for +the account. You can use any password you want, but be aware that Windows NT will +not change this password until 7 days following account creation. +After the command returns successfully, you can look at the entry for the new account +(in the stardard way depending on your configuration) and see that account's name is +really RUMBA$ and it has 'I' flag in the flags field. Now you're ready to confirm +the trust by establishing it from Windows NT Server. +</para> + +<para> +Open 'User Manager for Domains' and from menu 'Policies' select 'Trust Relationships...'. +Right beside 'Trusted domains' list box press 'Add...' button. You will be prompted for +the trusted domain name and the relationship password. Type in SAMBA, as this is +your domain name, and the password used at the time of account creation. +Press OK and, if everything went without incident, you will see 'Trusted domain relationship +successfully established' message. +</para> + +</sect2> +<sect2> +<title>Samba-3 as the Trusted Domain</title> + +<para> +This time activities are somewhat reversed. Again, we'll assume that your domain +controlled by the Samba PDC is called SAMBA and NT-controlled domain is called RUMBA. +</para> + +<para> +The very first thing requirement is to add an account for the SAMBA domain on RUMBA's PDC. +</para> + +<para> +Launch the Domain User Manager, then from the menu select 'Policies', 'Trust Relationships'. +Now, next to 'Trusted Domains' box press the 'Add' button, and type in the name of the trusted +domain (SAMBA) and password securing the relationship. +</para> + +<para> +The password can be arbitrarily chosen. It is easy to change the password +from the Samba server whenever you want. After confirming the password your account is +ready for use. Now it's Samba's turn. +</para> + +<para> +Using your favourite shell while being logged in as root, issue this command: +</para> + +<para> +<prompt>deity# </prompt><userinput>net rpc trustdom establish rumba</userinput> +</para> + +<para> +You will be prompted for the password you just typed on your Windows NT4 Server box. +Do not worry if you see an error message that mentions a returned code of +<errorname>NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT</errorname>. It means the +password you gave is correct and the NT4 Server says the account is +ready for interdomain connection and not for ordinary +connection. After that, be patient it can take a while (especially +in large networks), you should see the 'Success' message. Congratulations! Your trust +relationship has just been established. +</para> + +<note><para> +Note that you have to run this command as root because you must have write access to +the <filename>secrets.tdb</filename> file. +</para></note> + +</sect2> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/IntroSMB.xml b/docs/docbook/projdoc/IntroSMB.xml new file mode 100644 index 0000000000..4ead422fb8 --- /dev/null +++ b/docs/docbook/projdoc/IntroSMB.xml @@ -0,0 +1,370 @@ +<chapter id="IntroSMB"> +<chapterinfo> + &author.dlechnyr; + <pubdate>April 14, 2003</pubdate> +</chapterinfo> + +<title>Introduction to Samba</title> + +<para><emphasis> +"If you understand what you're doing, you're not learning anything." +-- Anonymous +</emphasis></para> + +<para> +Samba is a file and print server for Windows-based clients using TCP/IP as the underlying +transport protocol. In fact, it can support any SMB/CIFS-enabled client. One of Samba's big +strengths is that you can use it to blend your mix of Windows and Linux machines together +without requiring a separate Windows NT/2000/2003 Server. Samba is actively being developed +by a global team of about 30 active programmers and was originally developed by Andrew Tridgell. +</para> + +<sect1> +<title>Background</title> + +<para> +Once long ago, there was a buzzword referred to as DCE/RPC. This stood for Distributed +Computing Environment/Remote Procedure Calls and conceptually was a good idea. It was +originally developed by Apollo/HP as NCA 1.0 (Network Computing Architecture) and only +ran over UDP. When there was a need to run it over TCP so that it would be compatible +with DECnet 3.0, it was redesigned, submitted to The Open Group, and officially became +known as DCE/RPC. Microsoft came along and decided, rather than pay $20 per seat to +license this technology, to reimplement DCE/RPC themselves as MSRPC. From this, the +concept continued in the form of SMB (Server Message Block, or the "what") using the +NetBIOS (Network Basic Input/Output System, or the "how") compatibility layer. You can +run SMB (i.e., transport) over several different protocols; many different implementations +arose as a result, including NBIPX (NetBIOS over IPX, NwLnkNb, or NWNBLink) and NBT +(NetBIOS over TCP/IP, or NetBT). As the years passed, NBT became the most common form +of implementation until the advance of "Direct-Hosted TCP" -- the Microsoft marketing +term for eliminating NetBIOS entirely and running SMB by itself across TCP port 445 +only. As of yet, direct-hosted TCP has yet to catch on. +</para> + +<para> +Perhaps the best summary of the origins of SMB are voiced in the 1997 article titled, CIFS: +Common Insecurities Fail Scrutiny: +</para> + +<para><emphasis> +Several megabytes of NT-security archives, random whitepapers, RFCs, the CIFS spec, the Samba +stuff, a few MS knowledge-base articles, strings extracted from binaries, and packet dumps have +been dutifully waded through during the information-gathering stages of this project, and there +are *still* many missing pieces... While often tedious, at least the way has been generously +littered with occurrences of clapping hand to forehead and muttering 'crikey, what are they +thinking? +</emphasis></para> + +</sect1> + +<sect1> +<title>Terminology</title> + +<itemizedlist> + + <listitem><para> + SMB: Acronym for "Server Message Block". This is Microsoft's file and printer sharing protocol. + </para></listitem> + + <listitem><para> + CIFS: Acronym for "Common Internet File System". Around 1996, Microsoft apparently + decided that SMB needed the word "Internet" in it, so they changed it to CIFS. + </para></listitem> + + <listitem><para> + Direct-Hosted: A method of providing file/printer sharing services over port 445/tcp + only using DNS for name resolution instead of WINS. + </para></listitem> + + <listitem><para> + IPC: Acronym for "Inter-Process Communication". A method to communicate specific + information between programs. + </para></listitem> + + <listitem><para> + Marshalling: - A method of serializing (i.e., sequential ordering of) variable data + suitable for transmission via a network connection or storing in a file. The source + data can be re-created using a similar process called unmarshalling. + </para></listitem> + + <listitem><para> + NetBIOS: Acronym for "Network Basic Input/Output System". This is not a protocol; + it is a method of communication across an existing protocol. This is a standard which + was originally developed for IBM by Sytek in 1983. To exaggerate the analogy a bit, + it can help to think of this in comparison your computer's BIOS -- it controls the + essential functions of your input/output hardware -- whereas NetBIOS controls the + essential functions of your input/output traffic via the network. Again, this is a bit + of an exaggeration but it should help that paradigm shift. What is important to realize + is that NetBIOS is a transport standard, not a protocol. Unfortunately, even technically + brilliant people tend to interchange NetBIOS with terms like NetBEUI without a second + thought; this will cause no end (and no doubt) of confusion. + </para></listitem> + + <listitem><para> + NetBEUI: Acronym for the "NetBIOS Extended User Interface". Unlike NetBIOS, NetBEUI + is a protocol, not a standard. It is also not routable, so traffic on one side of a + router will be unable to communicate with the other side. Understanding NetBEUI is + not essential to deciphering SMB; however it helps to point out that it is not the + same as NetBIOS and to improve your score in trivia at parties. NetBEUI was originally + referred to by Microsoft as "NBF", or "The Windows NT NetBEUI Frame protocol driver". + It is not often heard from these days. + </para></listitem> + + <listitem><para> + NBT: Acronym for "NetBIOS over TCP"; also known as "NetBT". Allows the continued use + of NetBIOS traffic proxied over TCP/IP. As a result, NetBIOS names are made + to IP addresses and NetBIOS name types are conceptually equivalent to TCP/IP ports. + This is how file and printer sharing are accomplished in Windows 95/98/ME. They + traditionally rely on three ports: NetBIOS Name Service (nbname) via UDP port 137, + NetBIOS Datagram Service (nbdatagram) via UDP port 138, and NetBIOS Session Service + (nbsession) via TCP port 139. All name resolution is done via WINS, NetBIOS broadcasts, + and DNS. NetBIOS over TCP is documented in RFC 1001 (Concepts and methods) and RFC 1002 + (Detailed specifications). + </para></listitem> + + <listitem><para> + W2K: Acronym for Windows 2000 Professional or Server + </para></listitem> + + <listitem><para> + W3K: Acronym for Windows 2003 Server + </para></listitem> + +</itemizedlist> + +<para>If you plan on getting help, make sure to subscribe to the Samba Mailing List (available at +http://www.samba.org). Optionally, you could just search mailing.unix.samba at http://groups.google.com +</para> + +</sect1> + +<sect1> +<title>Related Projects</title> + +<para> +There are currently two network filesystem client projects for Linux that are directly +related to Samba: SMBFS and CIFS VFS. These are both available in the Linux kernel itself. +</para> + +<itemizedlist> + + <listitem><para> + SMBFS (Server Message Block File System) allows you to mount SMB shares (the protocol + that Microsoft Windows and OS/2 Lan Manager use to share files and printers + over local networks) and access them just like any other Unix directory. This is useful + if you just want to mount such filesystems without being a SMBFS server. + </para></listitem> + + <listitem><para> + CIFS VFS (Common Internet File System Virtual File System) is the successor to SMBFS, and + is being actively developed for the upcoming version of the Linux kernel. The intent of this module + is to provide advanced network file system functionality including support for dfs (heirarchical + name space), secure per-user session establishment, safe distributed caching (oplock), + optional packet signing, Unicode and other internationalization improvements, and optional + Winbind (nsswitch) integration. + </para></listitem> + +</itemizedlist> + +<para> +Again, it's important to note that these are implementations for client filesystems, and have +nothing to do with acting as a file and print server for SMB/CIFS clients. +</para> + +<para> +There are other Open Source CIFS client implementations, such as the jCIFS project +(jcifs.samba.org) which provides an SMB client toolkit written in Java. +</para> + + +</sect1> + + +<sect1> +<title>SMB Methodology</title> + +<para> +Traditionally, SMB uses UDP port 137 (NetBIOS name service, or netbios-ns), +UDP port 138 (NetBIOS datagram service, or netbios-dgm), and TCP port 139 (NetBIOS +session service, or netbios-ssn). Anyone looking at their network with a good +packet sniffer will be amazed at the amount of traffic generated by just opening +up a single file. In general, SMB sessions are established in the following order: +</para> + +<itemizedlist> + <listitem><para> + "TCP Connection" - establish 3-way handshake (connection) to port 139/tcp + or 445/tcp. + </para></listitem> + + <listitem><para> + "NetBIOS Session Request" - using the following "Calling Names": The local + machine's NetBIOS name plus the 16th character 0x00; The server's NetBIOS + name plus the 16th character 0x20 + </para></listitem> + + <listitem><para> + "SMB Negotiate Protocol" - determine the protocol dialect to use, which will + be one of the following: PC Network Program 1.0 (Core) - share level security + mode only; Microsoft Networks 1.03 (Core Plus) - share level security + mode only; Lanman1.0 (LAN Manager 1.0) - uses Challenge/Response + Authentication; Lanman2.1 (LAN Manager 2.1) - uses Challenge/Response + Authentication; NT LM 0.12 (NT LM 0.12) - uses Challenge/Response + Authentication + </para></listitem> + + <listitem><para> + SMB Session Startup. Passwords are encrypted (or not) according to one of + the following methods: Null (no encryption); Cleartext (no encryption); LM + and NTLM; NTLM; NTLMv2 + </para></listitem> + + <listitem><para> + SMB Tree Connect: Connect to a share name (e.g., \\servername\share); Connect + to a service type (e.g., IPC$ named pipe) + </para></listitem> + +</itemizedlist> + +<para> +A good way to examine this process in depth is to try out SecurityFriday's SWB program +at http://www.securityfriday.com/ToolDownload/SWB/swb_doc.html. It allows you to +walk through the establishment of a SMB/CIFS session step by step. +</para> + +</sect1> + +<sect1> +<title>Additional Resources</title> + +<itemizedlist> + + <listitem><para> + <ulink url="http://hr.uoregon.edu/davidrl/cifs.txt"> + <emphasis>CIFS: Common Insecurities Fail Scrutiny</emphasis> by "Hobbit"</ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://afr.com/it/2002/10/01/FFXDF43AP6D.html"> + <emphasis>Doing the Samba on Windows</emphasis> by Financial Review + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://ubiqx.org/cifs/"> + <emphasis>Implementing CIFS</emphasis> by Christopher R. Hertel + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://samba.anu.edu.au/cifs/docs/what-is-smb.html"> + <emphasis>Just What Is SMB?</emphasis> by Richard Sharpe + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.linux-mag.com/1999-05/samba_01.html"> + <emphasis>Opening Windows Everywhere</emphasis> by Mike Warfield + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.tldp.org/HOWTO/SMB-HOWTO.html"> + <emphasis>SMB HOWTO</emphasis> by David Wood + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.phrack.org/phrack/60/p60-0x0b.txt"> + <emphasis>SMB/CIFS by The Root</emphasis> by "ledin" + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.linux-mag.com/1999-09/samba_01.html"> + <emphasis>The Story of Samba</emphasis> by Christopher R. Hertel + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://hr.uoregon.edu/davidrl/samba/"> + <emphasis>The Unofficial Samba HOWTO</emphasis> by David Lechnyr + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.linux-mag.com/2001-05/smb_01.html"> + <emphasis>Understanding the Network Neighborhood</emphasis> by Christopher R. Hertel + </ulink> + </para></listitem> + + <listitem><para> + <ulink url="http://www.linux-mag.com/2002-02/samba_01.html"> + <emphasis>Using Samba as a PDC</emphasis> by Andrew Bartlett + </ulink> + </para></listitem> + +</itemizedlist> + +</sect1> + +<sect1> +<title>Epilogue</title> + +<para><emphasis> +"What's fundamentally wrong is that nobody ever had any taste when they +did it. Microsoft has been very much into making the user interface look good, +but internally it's just a complete mess. And even people who program for Microsoft +and who have had years of experience, just don't know how it works internally. +Worse, nobody dares change it. Nobody dares to fix bugs because it's such a +mess that fixing one bug might just break a hundred programs that depend on +that bug. And Microsoft isn't interested in anyone fixing bugs -- they're interested +in making money. They don't have anybody who takes pride in Windows 95 as an +operating system. +</emphasis></para> + +<para><emphasis> +People inside Microsoft know it's a bad operating system and they still +continue obviously working on it because they want to get the next version out +because they want to have all these new features to sell more copies of the +system. +</emphasis></para> + +<para><emphasis> +The problem with that is that over time, when you have this kind of approach, +and because nobody understands it, because nobody REALLY fixes bugs (other than +when they're really obvious), the end result is really messy. You can't trust +it because under certain circumstances it just spontaneously reboots or just +halts in the middle of something that shouldn't be strange. Normally it works +fine and then once in a blue moon for some completely unknown reason, it's dead, +and nobody knows why. Not Microsoft, not the experienced user and certainly +not the completely clueless user who probably sits there shivering thinking +"What did I do wrong?" when they didn't do anything wrong at all. +</emphasis></para> + +<para><emphasis> +That's what's really irritating to me." +</emphasis></para> + +<para>-- +<ulink url="http://hr.uoregon.edu/davidrl/boot.txt">Linus Torvalds, from an interview with BOOT Magazine, Sept 1998</ulink> +</para> + +</sect1> + +<sect1> +<title>Miscellaneous</title> + +<para> +This chapter was lovingly handcrafted on a Dell Latitude C400 laptop running Slackware Linux 9.0, +in case anyone asks. +</para> + +<para> +This chapter is Copyright © 2003 David Lechnyr (david at lechnyr dot com). +Permission is granted to copy, distribute and/or modify this document under the terms +of the GNU Free Documentation License, Version 1.2 or any later version published by the Free +Software Foundation. A copy of the license is available at http://www.gnu.org/licenses/fdl.txt. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/NT4Migration.xml b/docs/docbook/projdoc/NT4Migration.xml new file mode 100644 index 0000000000..585cfe6a47 --- /dev/null +++ b/docs/docbook/projdoc/NT4Migration.xml @@ -0,0 +1,507 @@ +<chapter id="NT4Migration"> +<chapterinfo> + &author.jht; + <pubdate>April 3, 2003</pubdate> +</chapterinfo> + +<title>Migration from NT4 PDC to Samba-3 PDC</title> + +<para> +This is a rough guide to assist those wishing to migrate from NT4 domain control to +Samba-3 based domain control. +</para> + +<sect1> +<title>Planning and Getting Started</title> + +<para> +In the IT world there is often a saying that all problems are encountered because of +poor planning. The corrollary to this saying is that not all problems can be anticpated +and planned for. Then again, good planning will anticpate most show stopper type situations. +</para> + +<para> +Those wishing to migrate from MS Windows NT4 domain control to a Samba-3 domain control +environment would do well to develop a detailed migration plan. So here are a few pointers to +help migration get under way. +</para> + +<sect2> +<title>Objectives</title> + +<para> +The key objective for most organisations will be to make the migration from MS Windows NT4 +to Samba-3 domain control as painless as possible. One of the challenges you may experience +in your migration process may well be one of convincing management that the new environment +should remain in place. Many who have introduced open source technologies have experienced +pressure to return to a Microsoft based platform solution at the first sign of trouble. +</para> + +<para> +It is strongly advised that before attempting a migration to a Samba-3 controlled network +that every possible effort be made to gain all-round commitment to the change. Firstly, you +should know precisely <emphasis>why</emphasis> the change is important for the organisation. +Possible motivations to make a change include: +</para> + +<itemizedlist> +<listitem> + <para>Improve network manageability</para> +</listitem> +<listitem> + <para>Obtain better user level functionality</para> +</listitem> +<listitem> + <para>Reduce network operating costs</para> +</listitem> +<listitem> + <para>Reduce exposure caused by Microsoft withdrawal of NT4 support</para> +</listitem> +<listitem> + <para>Avoid MS License 6 implications</para> +</listitem> +<listitem> + <para>Reduce organisation's dependency on Microsoft</para> +</listitem> +</itemizedlist> + +<para> +It is vital that it be well recognised that Samba-3 is NOT MS Windows NT4. Samba-3 offers +an alternative solution that is both different from MS Windows NT4 and that offers some +advantages compared with it. It should also be recognised that Samba-3 lacks many of the +features that Microsoft has promoted as core values in migration from MS Windows NT4 to +MS Windows 2000 and beyond (with or without Active Directory services). +</para> + +<para> +What are the features that Samba-3 can NOT provide? +</para> + +<itemizedlist> +<listitem> + <para>Active Directory Server</para> +</listitem> +<listitem> + <para>Group Policy Objects (in Active Direcrtory)</para> +</listitem> +<listitem> + <para>Machine Policy objects</para> +</listitem> +<listitem> + <para>Logon Scripts in Active Directorty</para> +</listitem> +<listitem> + <para>Software Application and Access Controls in Active Directory</para> +</listitem> +</itemizedlist> + +<para> +The features that Samba-3 DOES provide and that may be of compelling interest to your site +includes: +</para> + +<itemizedlist> +<listitem> + <para>Lower Cost of Ownership</para> +</listitem> +<listitem> + <para>Global availability of support with no strings attached</para> +</listitem> +<listitem> + <para>Dynamic SMB Servers (ie:Can run more than one server per Unix/Linux system)</para> +</listitem> +<listitem> + <para>Creation of on-the-fly logon scripts</para> +</listitem> +<listitem> + <para>Creation of on-the-fly Policy Files</para> +</listitem> +<listitem> + <para>Greater Stability, Reliability, Performance and Availability</para> +</listitem> +<listitem> + <para>Manageability via an ssh connection</para> +</listitem> +<listitem> + <para>Flexible choices of back-end authentication technologies (tdbsam, ldapsam, mysqlsam)</para> +</listitem> +<listitem> + <para>Ability to implement a full single-signon architecture</para> +</listitem> +<listitem> + <para>Ability to distribute authentication systems for absolute minimum wide area network bandwidth demand</para> +</listitem> +</itemizedlist> + +<para> +Before migrating a network from MS Windows NT4 to Samba-3 it is vital that all necessary factors are +considered. Users should be educated about changes they may experience so that the change will be a +welcome one and not become an obstacle to the work they need to do. The following are some of the +factors that will go into a successful migration: +</para> + +<sect3> +<title>Domain Layout</title> + +<para> +Samba-3 can be configured as a domain controller, a back-up domain controller (probably best called +a secondary controller), a domain member, or as a stand-alone server. The Windows network security +domain context should be sized and scoped before implementation. Particular attention needs to be +paid to the location of the primary domain controller (PDC) as well as backup controllers (BDCs). +It should be noted that one way in which Samba-3 differs from Microsoft technology is that if one +chooses to use an LDAP authentication backend then the same database can be used by several different +domains. This means that in a complex organisation there can be a single LDAP database, that itself +can be distributed, that can simultaneously serve multiple domains (that can also be widely distributed). +</para> + +<para> +It is recommended that from a design perspective, the number of users per server, as well as the number +of servers, per domain should be scaled according to needs and should also consider server capacity +and network bandwidth. +</para> + +<para> +A physical network segment may house several domains, each of which may span multiple network segments. +Where domains span routed network segments it is most advisable to consider and test the performance +implications of the design and layout of a network. A Centrally located domain controller that is being +designed to serve mulitple routed network segments may result in severe performance problems if the +response time (eg: ping timing) between the remote segment and the PDC is more than 100 ms. In situations +where the delay is too long it is highly recommended to locate a backup controller (BDC) to serve as +the local authentication and access control server. +</para> +</sect3> + +<sect3> +<title>Server Share and Directory Layout</title> + +<para> +There are few cardinal rules to effective network design that can be broken with impunity. +The most important rule of effective network management is that simplicity is king in every +well controlled network. Every part of the infrastructure must be managed, the more complex +it is, the greater will be the demand of keeping systems secure and functional. +</para> + +<para> +The nature of the data that must be stored needs to be born in mind when deciding how many +shares must be created. The physical disk space layout should also be taken into account +when designing where share points will be created. Keep in mind that all data needs to be +backed up, thus the simpler the disk layout the easier it will be to keep track of what must +be backed up to tape or other off-line storage medium. Always plan and implement for minimum +maintenance. Leave nothing to chance in your design, above all, do not leave backups to chance: +Backup and test, validate every backup, create a disaster recovery plan and prove that it works. +</para> + +<para> +Users should be grouped according to data access control needs. File and directory access +is best controlled via group permissions and the use of the "sticky bit" on group controlled +directories may substantially avoid file access complaints from samba share users. +</para> + +<para> +Many network administrators who are new to the game will attempt to use elaborate techniques +to set access controls, on files, directories, shares, as well as in share definitions. +There is the ever present danger that that administrator's successor will not understand the +complex mess that has been inherited. Remember, apparent job security through complex design +and implementation may ultimately cause loss of operations and downtime to users as the new +administrator learns to untangle your web. Keep access controls simple and effective and +make sure that users will never be interrupted by the stupidity of complexity. +</para> +</sect3> + +<sect3> +<title>Logon Scripts</title> + +<para> +Please refer to the section of this document on Advanced Network Adminsitration for information +regarding the network logon script options for Samba-3. Logon scripts can help to ensure that +all users gain share and printer connections they need. +</para> + +<para> +Logon scripts can be created on-the-fly so that all commands executed are specific to the +rights and privilidges granted to the user. The preferred controls should be affected through +group membership so that group information can be used to custom create a logong script using +the <filename>root preexec</filename> parameters to the <filename>NETLOGON</filename> share. +</para> + +<para> +Some sites prefer to use a tool such as <filename>kixstart</filename> to establish a controlled +user environment. In any case you may wish to do a google search for logon script process controls. +In particular, you may wish to explore the use of the Microsoft knowledgebase article KB189105 that +deals with how to add printers without user intervention via the logon script process. +</para> +</sect3> + +<sect3> +<title>Profile Migration/Creation</title> + +<para> +User and Group Profiles may be migrated using the tools described in the section titled Desktop Profile +Management. +</para> + +<para> +Profiles may also be managed using the Samba-3 tool <filename>profiles</filename>. This tool allows +the MS Windows NT style security identifiers (SIDs) that are stored inside the profile NTuser.DAT file +to be changed to the SID of the Samba-3 domain. +</para> +</sect3> + +<sect3> +<title>User and Group Accounts</title> + +<para> +It is possible to migrate all account settings from an MS Windows NT4 domain to Samba-3. Before +attempting to migrate user and group accounts it is STRONGLY advised to create in Samba-3 the +groups that are present on the MS Windows NT4 domain <emphasis>AND</emphasis> to connect these to +suitable Unix/Linux groups. Following this simple advice will mean that all user and group attributes +should migrate painlessly. +</para> +</sect3> + +</sect2> + +<sect2> +<title>Steps In Migration Process</title> + +<para> +The approximate migration process is described below. +</para> + +<itemizedlist> +<listitem><para> +You will have an NT4 PDC that has the users, groups, policies and profiles to be migrated +</para></listitem> + +<listitem><para> +Samba-3 set up as a DC with netlogon share, profile share, etc. +</para></listitem> +</itemizedlist> + +<procedure><title>The Account Migration Process</title> + <step><para>Create a BDC account for the samba server using NT Server Manager</para> + <substeps><step><para>Samba must NOT be running</para></step></substeps></step> + + <step> + <para>rpcclient NT4PDC -U Administrator%passwd</para> + <substeps><step><para>lsaquery</para></step> + <step><para>Note the SID returned</para></step> + </substeps> + </step> + + <step><para>net getsid -S NT4PDC -w DOMNAME -U Administrator%passwd</para> + <substeps><step><para>Note the SID</para></step></substeps> + </step> + + <step><para>net getlocalsid</para> + <substeps> + <step><para>Note the SID, now check that all three SIDS reported are the same!</para></step> + </substeps> + </step> + + <step><para>net rpc join -S NT4PDC -w DOMNAME -U Administrator%passwd</para></step> + + <step><para>net rpc vampire -S NT4PDC -U administrator%passwd</para></step> + + <step><para>pdbedit -l</para> + <substeps><step><para>Note - did the users migrate?</para></step></substeps> + </step> + + <step><para>initGrps.sh DOMNAME</para></step> + + <step><para>net groupmap list</para> + <substeps><step><para>Now check that all groups are recognised</para></step></substeps> + </step> + + <step><para>net rpc campire -S NT4PDC -U administrator%passwd</para></step> + + <step><para>pdbedit -lv</para> + <substeps><step> + <para>Note - check that all group membership has been migrated</para> + </step></substeps> + </step> +</procedure> + +<para> +Now it is time to migrate all the profiles, then migrate all policy files. +More later. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Migration Options</title> + +<para> +Based on feedback from many sites as well as from actual installation and maintenance +experience sites that wish to migrate from MS Windows NT4 Domain Control to a Samba +based solution fit into three basic categories. +</para> + +<table frame="all"><title>The 3 Major Site Types</title> +<tgroup cols="2"> + <thead> + <row><entry>Number of Users</entry><entry>Description</entry></row> + </thead> + <tbody> + <row><entry>< 50</entry><entry><para>Want simple conversion with NO pain</para></entry></row> + <row><entry>50 - 250</entry><entry><para>Want new features, can manage some in-house complexity</para></entry></row> + <row><entry>> 250</entry><entry><para>Solution/Implementation MUST scale well, complex needs. Cross departmental decision process. Local expertise in most areas</para></entry></row> + </tbody> +</tgroup> +</table> + +<sect2> +<title>Planning for Success</title> + +<para> +There are three basic choices for sites that intend to migrate from MS Windwows NT4 +to Samba-3. +</para> + +<itemizedlist> + <listitem><para> + Simple Conversion (total replacement) + </para></listitem> + + <listitem><para> + Upgraded Conversion (could be one of integration) + </para></listitem> + + <listitem><para> + Complete Redesign (completely new solution) + </para></listitem> +</itemizedlist> + +<para> +No matter what choice you make, the following rules will minimise down-stream problems: +</para> + +<itemizedlist> + <listitem><para> + Take sufficient time + </para></listitem> + + <listitem><para> + Avoid Panic + </para></listitem> + + <listitem><para> + Test ALL assumptions + </para></listitem> + + <listitem><para> + Test full roll-out program, including workstation deployment + </para></listitem> +</itemizedlist> + +<table frame="top"><title>Nature of the Conversion Choices</title> +<tgroup cols="3"> + <thead> + <row><entry>Simple</entry><entry>Upgraded</entry><entry>Redesign</entry></row> + </thead> + <tbody> + <row> + <entry><para>Make use of minimal OS specific features</para></entry> + <entry><para>Translate NT4 features to new host OS features</para></entry> + <entry><para>Decide:</para></entry> + </row> + <row> + <entry><para>Suck all accounts from NT4 into Samba-3</para></entry> + <entry><para>Copy and improve:</para></entry> + <entry><para>Authentication Regime (database location and access)</para></entry> + </row> + <row> + <entry><para>Make least number of operational changes</para></entry> + <entry><para>Make progressive improvements</para></entry> + <entry><para>Desktop Management Methods</para></entry> + </row> + <row> + <entry><para>Take least amount of time to migrate</para></entry> + <entry><para>Minimise user impact</para></entry> + <entry><para>Better Control of Desktops / Users</para></entry> + </row> + <row> + <entry><para>Live versus Isolated Conversion</para></entry> + <entry><para>Maximise functionality</para></entry> + <entry><para>Identify Needs for: Manageability, Scalability, Security, Availability</para></entry> + </row> + <row> + <entry><para>Integrate Samba-3 then migrate while users are active, then Change of control (ie: swap out)</para></entry> + <entry><para>Take advantage of lower maintenance opportunity</para></entry> + <entry><para></para></entry> + </row> + </tbody> +</tgroup> +</table> +</sect2> + +<sect2> +<title>Samba Implementation Choices</title> + +<para><programlisting> +Authentication database back end + Winbind (external Samba or NT4/200x server) + Can use pam_mkhomedir.so to auto-create home dirs + External server could use Active Directory or NT4 Domain + +Database type + smbpasswd, tdbsam, ldapsam, MySQLsam + +Access Control Points + On the Share itself (Use NT4 Server Manager) + On the file system + Unix permissions on files and directories + Posix ACLs enablement in file system? + Through Samba share parameters + Not recommended - except as only resort + +Policies (migrate or create new ones) + Group Policy Editor (NT4) + Watch out for Tattoo effect + +User and Group Profiles + Platform specific so use platform tool to change from a Local + to a Roaming profile Can use new profiles tool to change SIDs + (NTUser.DAT) + +Logon Scripts (Know how they work) + +User and Group mapping to Unix/Linux + username map facility may be needed + Use 'net groupmap' to connect NT4 groups to Unix groups + Use pdbedit to set/change user configuration +NOTE: +If migrating to LDAP back end it may be easier to dump initial LDAP database +to LDIF, then edit, then reload into LDAP + + OS specific scripts / programs may be needed + Add / delete Users + Note OS limits on size of name (Linux 8 chars) + NT4 up to 254 chars + Add / delete machines + Applied only to domain members (note up to 16 chars) + Add / delete Groups + Note OS limits on size and nature + Linux limit is 16 char, + no spaces and no upper case chars (groupadd) + +Migration Tools + Domain Control (NT4 Style) + Profiles, Policies, Access Controls, Security + +Migration Tools + Samba: net, rpcclient, smbpasswd, pdbedit, profiles + Windows: NT4 Domain User Manager, Server Manager (NEXUS) + +Authentication + New SAM back end (smbpasswd, tdbsam, ldapsam, mysqlsam) +</programlisting> +</para> + +</sect2> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/NT_Security.xml b/docs/docbook/projdoc/NT_Security.xml new file mode 100644 index 0000000000..9bff25337c --- /dev/null +++ b/docs/docbook/projdoc/NT_Security.xml @@ -0,0 +1,335 @@ +<chapter id="unix-permissions"> +<chapterinfo> + &author.jeremy; + <pubdate>12 Apr 1999</pubdate> +</chapterinfo> + +<title>UNIX Permission Bits and Windows NT Access Control Lists</title> + +<sect1> + <title>Viewing and changing UNIX permissions using the NT + security dialogs</title> + + <para>Windows NT clients can use their native security settings + dialog box to view and modify the underlying UNIX permissions.</para> + + <para>Note that this ability is careful not to compromise + the security of the UNIX host Samba is running on, and + still obeys all the file permission rules that a Samba + administrator can set.</para> + + <note> + <para> + All access to Unix/Linux system file via Samba is controlled at + the operating system file access control level. When trying to + figure out file access problems it is vitally important to identify + the identity of the Windows user as it is presented by Samba at + the point of file access. This can best be determined from the + Samba log files. + </para> + </note> +</sect1> + +<sect1> + <title>How to view file security on a Samba share</title> + + <para>From an NT4/2000/XP client, single-click with the right + mouse button on any file or directory in a Samba mounted + drive letter or UNC path. When the menu pops-up, click + on the <emphasis>Properties</emphasis> entry at the bottom of + the menu. This brings up the file properties dialog + box. Click on the tab <emphasis>Security</emphasis> and you + will see three buttons, <emphasis>Permissions</emphasis>, + <emphasis>Auditing</emphasis>, and <emphasis>Ownership</emphasis>. + The <emphasis>Auditing</emphasis> button will cause either + an error message <errorname>A requested privilege is not held + by the client</errorname> to appear if the user is not the + NT Administrator, or a dialog which is intended to allow an + Administrator to add auditing requirements to a file if the + user is logged on as the NT Administrator. This dialog is + non-functional with a Samba share at this time, as the only + useful button, the <command>Add</command> button will not currently + allow a list of users to be seen.</para> + +</sect1> + +<sect1> + <title>Viewing file ownership</title> + + <para>Clicking on the <command>"Ownership"</command> button + brings up a dialog box telling you who owns the given file. The + owner name will be of the form :</para> + + <para><command>"SERVER\user (Long name)"</command></para> + + <para>Where <replaceable>SERVER</replaceable> is the NetBIOS name of + the Samba server, <replaceable>user</replaceable> is the user name of + the UNIX user who owns the file, and <replaceable>(Long name)</replaceable> + is the descriptive string identifying the user (normally found in the + GECOS field of the UNIX password database). Click on the <command>Close + </command> button to remove this dialog.</para> + + <para>If the parameter <parameter>nt acl support</parameter> + is set to <constant>false</constant> then the file owner will + be shown as the NT user <command>"Everyone"</command>.</para> + + <para>The <command>Take Ownership</command> button will not allow + you to change the ownership of this file to yourself (clicking on + it will display a dialog box complaining that the user you are + currently logged onto the NT client cannot be found). The reason + for this is that changing the ownership of a file is a privileged + operation in UNIX, available only to the <emphasis>root</emphasis> + user. As clicking on this button causes NT to attempt to change + the ownership of a file to the current user logged into the NT + client this will not work with Samba at this time.</para> + + <para>There is an NT chown command that will work with Samba + and allow a user with Administrator privilege connected + to a Samba server as root to change the ownership of + files on both a local NTFS filesystem or remote mounted NTFS + or Samba drive. This is available as part of the <emphasis>Seclib + </emphasis> NT security library written by Jeremy Allison of + the Samba Team, available from the main Samba ftp site.</para> + +</sect1> + +<sect1> + <title>Viewing file or directory permissions</title> + + <para>The third button is the <command>"Permissions"</command> + button. Clicking on this brings up a dialog box that shows both + the permissions and the UNIX owner of the file or directory. + The owner is displayed in the form :</para> + + <para><command>"SERVER\user (Long name)"</command></para> + + <para>Where <replaceable>SERVER</replaceable> is the NetBIOS name of + the Samba server, <replaceable>user</replaceable> is the user name of + the UNIX user who owns the file, and <replaceable>(Long name)</replaceable> + is the descriptive string identifying the user (normally found in the + GECOS field of the UNIX password database).</para> + + <para>If the parameter <parameter>nt acl support</parameter> + is set to <constant>false</constant> then the file owner will + be shown as the NT user <command>"Everyone"</command> and the + permissions will be shown as NT "Full Control".</para> + + + <para>The permissions field is displayed differently for files + and directories, so I'll describe the way file permissions + are displayed first.</para> + + <sect2> + <title>File Permissions</title> + + <para>The standard UNIX user/group/world triple and + the corresponding "read", "write", "execute" permissions + triples are mapped by Samba into a three element NT ACL + with the 'r', 'w', and 'x' bits mapped into the corresponding + NT permissions. The UNIX world permissions are mapped into + the global NT group <command>Everyone</command>, followed + by the list of permissions allowed for UNIX world. The UNIX + owner and group permissions are displayed as an NT + <command>user</command> icon and an NT <command>local + group</command> icon respectively followed by the list + of permissions allowed for the UNIX user and group.</para> + + <para>As many UNIX permission sets don't map into common + NT names such as <command>"read"</command>, <command> + "change"</command> or <command>"full control"</command> then + usually the permissions will be prefixed by the words <command> + "Special Access"</command> in the NT display list.</para> + + <para>But what happens if the file has no permissions allowed + for a particular UNIX user group or world component ? In order + to allow "no permissions" to be seen and modified then Samba + overloads the NT <command>"Take Ownership"</command> ACL attribute + (which has no meaning in UNIX) and reports a component with + no permissions as having the NT <command>"O"</command> bit set. + This was chosen of course to make it look like a zero, meaning + zero permissions. More details on the decision behind this will + be given below.</para> + </sect2> + + <sect2> + <title>Directory Permissions</title> + + <para>Directories on an NT NTFS file system have two + different sets of permissions. The first set of permissions + is the ACL set on the directory itself, this is usually displayed + in the first set of parentheses in the normal <command>"RW"</command> + NT style. This first set of permissions is created by Samba in + exactly the same way as normal file permissions are, described + above, and is displayed in the same way.</para> + + <para>The second set of directory permissions has no real meaning + in the UNIX permissions world and represents the <command> + "inherited"</command> permissions that any file created within + this directory would inherit.</para> + + <para>Samba synthesises these inherited permissions for NT by + returning as an NT ACL the UNIX permission mode that a new file + created by Samba on this share would receive.</para> + </sect2> +</sect1> + +<sect1> + <title>Modifying file or directory permissions</title> + + <para>Modifying file and directory permissions is as simple + as changing the displayed permissions in the dialog box, and + clicking the <command>OK</command> button. However, there are + limitations that a user needs to be aware of, and also interactions + with the standard Samba permission masks and mapping of DOS + attributes that need to also be taken into account.</para> + + <para>If the parameter <parameter>nt acl support</parameter> + is set to <constant>false</constant> then any attempt to set + security permissions will fail with an <command>"Access Denied" + </command> message.</para> + + <para>The first thing to note is that the <command>"Add"</command> + button will not return a list of users in Samba (it will give + an error message of <command>"The remote procedure call failed + and did not execute"</command>). This means that you can only + manipulate the current user/group/world permissions listed in + the dialog box. This actually works quite well as these are the + only permissions that UNIX actually has.</para> + + <para>If a permission triple (either user, group, or world) + is removed from the list of permissions in the NT dialog box, + then when the <command>"OK"</command> button is pressed it will + be applied as "no permissions" on the UNIX side. If you then + view the permissions again the "no permissions" entry will appear + as the NT <command>"O"</command> flag, as described above. This + allows you to add permissions back to a file or directory once + you have removed them from a triple component.</para> + + <para>As UNIX supports only the "r", "w" and "x" bits of + an NT ACL then if other NT security attributes such as "Delete + access" are selected then they will be ignored when applied on + the Samba server.</para> + + <para>When setting permissions on a directory the second + set of permissions (in the second set of parentheses) is + by default applied to all files within that directory. If this + is not what you want you must uncheck the <command>"Replace + permissions on existing files"</command> checkbox in the NT + dialog before clicking <command>"OK"</command>.</para> + + <para>If you wish to remove all permissions from a + user/group/world component then you may either highlight the + component and click the <command>"Remove"</command> button, + or set the component to only have the special <command>"Take + Ownership"</command> permission (displayed as <command>"O" + </command>) highlighted.</para> +</sect1> + +<sect1> + <title>Interaction with the standard Samba create mask + parameters</title> + + <para>There are four parameters + to control interaction with the standard Samba create mask parameters. + These are :</para> + + <para><parameter>security mask</parameter></para> + <para><parameter>force security mode</parameter></para> + <para><parameter>directory security mask</parameter></para> + <para><parameter>force directory security mode</parameter></para> + + <para>Once a user clicks <command>"OK"</command> to apply the + permissions Samba maps the given permissions into a user/group/world + r/w/x triple set, and then will check the changed permissions for a + file against the bits set in the <ulink url="smb.conf.5.html#SECURITYMASK"> + <parameter>security mask</parameter></ulink> parameter. Any bits that + were changed that are not set to '1' in this parameter are left alone + in the file permissions.</para> + + <para>Essentially, zero bits in the <parameter>security mask</parameter> + mask may be treated as a set of bits the user is <emphasis>not</emphasis> + allowed to change, and one bits are those the user is allowed to change. + </para> + + <para>If not set explicitly this parameter is set to the same value as + the <ulink url="smb.conf.5.html#CREATEMASK"><parameter>create mask + </parameter></ulink> parameter. To allow a user to modify all the + user/group/world permissions on a file, set this parameter + to 0777.</para> + + <para>Next Samba checks the changed permissions for a file against + the bits set in the <ulink url="smb.conf.5.html#FORCESECURITYMODE"> + <parameter>force security mode</parameter></ulink> parameter. Any bits + that were changed that correspond to bits set to '1' in this parameter + are forced to be set.</para> + + <para>Essentially, bits set in the <parameter>force security mode + </parameter> parameter may be treated as a set of bits that, when + modifying security on a file, the user has always set to be 'on'.</para> + + <para>If not set explicitly this parameter is set to the same value + as the <ulink url="smb.conf.5.html#FORCECREATEMODE"><parameter>force + create mode</parameter></ulink> parameter. + To allow a user to modify all the user/group/world permissions on a file + with no restrictions set this parameter to 000.</para> + + <para>The <parameter>security mask</parameter> and <parameter>force + security mode</parameter> parameters are applied to the change + request in that order.</para> + + <para>For a directory Samba will perform the same operations as + described above for a file except using the parameter <parameter> + directory security mask</parameter> instead of <parameter>security + mask</parameter>, and <parameter>force directory security mode + </parameter> parameter instead of <parameter>force security mode + </parameter>.</para> + + <para>The <parameter>directory security mask</parameter> parameter + by default is set to the same value as the <parameter>directory mask + </parameter> parameter and the <parameter>force directory security + mode</parameter> parameter by default is set to the same value as + the <parameter>force directory mode</parameter> parameter. </para> + + <para>In this way Samba enforces the permission restrictions that + an administrator can set on a Samba share, whilst still allowing users + to modify the permission bits within that restriction.</para> + + <para>If you want to set up a share that allows users full control + in modifying the permission bits on their files and directories and + doesn't force any particular bits to be set 'on', then set the following + parameters in the &smb.conf; file in that share specific section :</para> + + <para><parameter>security mask = 0777</parameter></para> + <para><parameter>force security mode = 0</parameter></para> + <para><parameter>directory security mask = 0777</parameter></para> + <para><parameter>force directory security mode = 0</parameter></para> +</sect1> + +<sect1> + <title>Interaction with the standard Samba file attribute + mapping</title> + + <para>Samba maps some of the DOS attribute bits (such as "read + only") into the UNIX permissions of a file. This means there can + be a conflict between the permission bits set via the security + dialog and the permission bits set by the file attribute mapping. + </para> + + <para>One way this can show up is if a file has no UNIX read access + for the owner it will show up as "read only" in the standard + file attributes tabbed dialog. Unfortunately this dialog is + the same one that contains the security info in another tab.</para> + + <para>What this can mean is that if the owner changes the permissions + to allow themselves read access using the security dialog, clicks + <command>"OK"</command> to get back to the standard attributes tab + dialog, and then clicks <command>"OK"</command> on that dialog, then + NT will set the file permissions back to read-only (as that is what + the attributes still say in the dialog). This means that after setting + permissions and clicking <command>"OK"</command> to get back to the + attributes dialog you should always hit <command>"Cancel"</command> + rather than <command>"OK"</command> to ensure that your changes + are not overridden.</para> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/NetworkBrowsing.xml b/docs/docbook/projdoc/NetworkBrowsing.xml new file mode 100644 index 0000000000..29768ea42a --- /dev/null +++ b/docs/docbook/projdoc/NetworkBrowsing.xml @@ -0,0 +1,1288 @@ +<chapter id="NetworkBrowsing"> +<chapterinfo> + &author.jht; + <pubdate>July 5, 1998</pubdate> + <pubdate>Updated: April 21, 2003</pubdate> +</chapterinfo> + +<title>Samba / MS Windows Network Browsing Guide</title> + +<para> +This document contains detailed information as well as a fast track guide to +implementing browsing across subnets and / or across workgroups (or domains). +WINS is the best tool for resolution of NetBIOS names to IP addesses. WINS is +NOT involved in browse list handling except by way of name to address resolution. +</para> + +<note><para> +MS Windows 2000 and later can be configured to operate with NO NetBIOS +over TCP/IP. Samba-3 and later also supports this mode of operation. +When the use of NetBIOS over TCP/IP has been disabled then the primary +means for resolution of MS Windows machine names is via DNS and Active Directory. +The following information assumes that your site is running NetBIOS over TCP/IP. +</para></note> + +<sect1> +<title>What is Browsing?</title> + +<para> +To most people browsing means that they can see the MS Windows and Samba servers +in the Network Neighborhood, and when the computer icon for a particular server is +clicked, it opens up and shows the shares and printers available on the target server. +</para> + +<para> +What seems so simple is in fact a very complex interaction of different technologies. +The technologies (or methods) employed in making all of this work includes: +</para> + +<simplelist> + <member>MS Windows machines register their presence to the network</member> + <member>Machines announce themselves to other machines on the network</member> + <member>One or more machine on the network collates the local announcements</member> + <member>The client machine finds the machine that has the collated list of machines</member> + <member>The client machine is able to resolve the machine names to IP addresses</member> + <member>The client machine is able to connect to a target machine</member> +</simplelist> + +<para> +The samba application that controls/manages browse list management and name resolution is +called <filename>nmbd</filename>. The configuration parameters involved in nmbd's operation are: +</para> + +<para><programlisting> + Browsing options: + ----------------- + * os level + lm announce + lm interval + * preferred master + * local master + * domain master + browse list + enhanced browsing + + Name Resolution Method: + ----------------------- + * name resolve order + + WINS options: + ------------- + dns proxy + wins proxy + * wins server + * wins support + wins hook +</programlisting></para> + +<para> +WINS Server and WINS Support are mutually exclusive options. Those marked with an '*' are +the only options that commonly MAY need to be modified. Even if not one of these parameters +is set nmbd will still do it's job. +</para> +</sect1> + +<sect1> +<title>Discussion</title> + +<para> +Firstly, all MS Windows networking is based on SMB (Server Message +Block) based messaging. SMB messaging may be implemented using NetBIOS or +without NetBIOS. Samba implements NetBIOS by encapsulating it over TCP/IP. +MS Windows products can do likewise. NetBIOS based networking uses broadcast +messaging to affect browse list management. When running NetBIOS over +TCP/IP this uses UDP based messaging. UDP messages can be broadcast or unicast. +</para> + +<para> +Normally, only unicast UDP messaging can be forwarded by routers. The +<command>remote announce</command> +parameter to smb.conf helps to project browse announcements +to remote network segments via unicast UDP. Similarly, the +<command>remote browse sync</command> parameter of <filename>smb.conf</filename> +implements browse list collation using unicast UDP. +</para> + +<para> +Secondly, in those networks where Samba is the only SMB server technology +wherever possible <filename>nmbd</filename> should be configured on one (1) machine as the WINS +server. This makes it easy to manage the browsing environment. If each network +segment is configured with it's own Samba WINS server, then the only way to +get cross segment browsing to work is by using the +<command>remote announce</command> and the <command>remote browse sync</command> +parameters to your <filename>smb.conf</filename> file. +</para> + +<para> +If only one WINS server is used for an entire multi-segment network then +the use of the <command>remote announce</command> and the +<command>remote browse sync</command> parameters should NOT be necessary. +</para> + +<para> +As of Samba 3 WINS replication is being worked on. The bulk of the code has +been committed, but it still needs maturation. +</para> + +<para> +Right now samba WINS does not support MS-WINS replication. This means that +when setting up Samba as a WINS server there must only be one <filename>nmbd</filename> configured +as a WINS server on the network. Some sites have used multiple Samba WINS +servers for redundancy (one server per subnet) and then used +<command>remote browse sync</command> and <command>remote announce</command> +to affect browse list collation across all +segments. Note that this means clients will only resolve local names, +and must be configured to use DNS to resolve names on other subnets in +order to resolve the IP addresses of the servers they can see on other +subnets. This setup is not recommended, but is mentioned as a practical +consideration (ie: an 'if all else fails' scenario). +</para> + +<para> +Lastly, take note that browse lists are a collection of unreliable broadcast +messages that are repeated at intervals of not more than 15 minutes. This means +that it will take time to establish a browse list and it can take up to 45 +minutes to stabilise, particularly across network segments. +</para> + +</sect1> + +<sect1> +<title>How Browsing Functions</title> + +<para> +As stated above, MS Windows machines register their NetBIOS names +(ie: the machine name for each service type in operation) on start +up. Also, as stated above, the exact method by which this name registration +takes place is determined by whether or not the MS Windows client/server +has been given a WINS server address, whether or not LMHOSTS lookup +is enabled, or if DNS for NetBIOS name resolution is enabled, etc. +</para> + +<para> +In the case where there is no WINS server all name registrations as +well as name lookups are done by UDP broadcast. This isolates name +resolution to the local subnet, unless LMHOSTS is used to list all +names and IP addresses. In such situations Samba provides a means by +which the samba server name may be forcibly injected into the browse +list of a remote MS Windows network (using the +<command>remote announce</command> parameter). +</para> + +<para> +Where a WINS server is used, the MS Windows client will use UDP +unicast to register with the WINS server. Such packets can be routed +and thus WINS allows name resolution to function across routed networks. +</para> + +<para> +During the startup process an election will take place to create a +local master browser if one does not already exist. On each NetBIOS network +one machine will be elected to function as the domain master browser. This +domain browsing has nothing to do with MS security domain control. +Instead, the domain master browser serves the role of contacting each local +master browser (found by asking WINS or from LMHOSTS) and exchanging browse +list contents. This way every master browser will eventually obtain a complete +list of all machines that are on the network. Every 11-15 minutes an election +is held to determine which machine will be the master browser. By the nature of +the election criteria used, the machine with the highest uptime, or the +most senior protocol version, or other criteria, will win the election +as domain master browser. +</para> + +<para> +Clients wishing to browse the network make use of this list, but also depend +on the availability of correct name resolution to the respective IP +address/addresses. +</para> + +<para> +Any configuration that breaks name resolution and/or browsing intrinsics +will annoy users because they will have to put up with protracted +inability to use the network services. +</para> + +<para> +Samba supports a feature that allows forced synchonisation +of browse lists across routed networks using the <command>remote +browse sync</command> parameter in the <filename>smb.conf</filename> file. +This causes Samba to contact the local master browser on a remote network and +to request browse list synchronisation. This effectively bridges +two networks that are separated by routers. The two remote +networks may use either broadcast based name resolution or WINS +based name resolution, but it should be noted that the <command>remote +browse sync</command> parameter provides browse list synchronisation - and +that is distinct from name to address resolution, in other +words, for cross subnet browsing to function correctly it is +essential that a name to address resolution mechanism be provided. +This mechanism could be via DNS, <filename>/etc/hosts</filename>, +and so on. +</para> + +<sect2> +<title>Setting up WORKGROUP Browsing</title> + +<para> +To set up cross subnet browsing on a network containing machines +in up to be in a WORKGROUP, not an NT Domain you need to set up one +Samba server to be the Domain Master Browser (note that this is *NOT* +the same as a Primary Domain Controller, although in an NT Domain the +same machine plays both roles). The role of a Domain master browser is +to collate the browse lists from local master browsers on all the +subnets that have a machine participating in the workgroup. Without +one machine configured as a domain master browser each subnet would +be an isolated workgroup, unable to see any machines on any other +subnet. It is the presense of a domain master browser that makes +cross subnet browsing possible for a workgroup. +</para> + +<para> +In an WORKGROUP environment the domain master browser must be a +Samba server, and there must only be one domain master browser per +workgroup name. To set up a Samba server as a domain master browser, +set the following option in the [global] section of the &smb.conf; file : +</para> + +<para> +<programlisting> + domain master = yes +</programlisting> +</para> + +<para> +The domain master browser should also preferrably be the local master +browser for its own subnet. In order to achieve this set the following +options in the [global] section of the &smb.conf; file : +</para> + +<para> +<programlisting> + domain master = yes + local master = yes + preferred master = yes + os level = 65 +</programlisting> +</para> + +<para> +The domain master browser may be the same machine as the WINS +server, if you require. +</para> + +<para> +Next, you should ensure that each of the subnets contains a +machine that can act as a local master browser for the +workgroup. Any MS Windows NT/2K/XP/2003 machine should be +able to do this, as will Windows 9x machines (although these +tend to get rebooted more often, so it's not such a good idea +to use these). To make a Samba server a local master browser +set the following options in the [global] section of the +&smb.conf; file : +</para> + +<para> +<programlisting> + domain master = no + local master = yes + preferred master = yes + os level = 65 +</programlisting> +</para> + +<para> +Do not do this for more than one Samba server on each subnet, +or they will war with each other over which is to be the local +master browser. +</para> + +<para> +The <command>local master</command> parameter allows Samba to act as a +local master browser. The <command>preferred master</command> causes nmbd +to force a browser election on startup and the <command>os level</command> +parameter sets Samba high enough so that it should win any browser elections. +</para> + +<para> +If you have an NT machine on the subnet that you wish to +be the local master browser then you can disable Samba from +becoming a local master browser by setting the following +options in the <command>[global]</command> section of the +&smb.conf; file : +</para> + +<para> +<programlisting> + domain master = no + local master = no + preferred master = no + os level = 0 +</programlisting> +</para> + +</sect2> + +<sect2> +<title>Setting up DOMAIN Browsing</title> + +<para> +If you are adding Samba servers to a Windows NT Domain then +you must not set up a Samba server as a domain master browser. +By default, a Windows NT Primary Domain Controller for a Domain +name is also the Domain master browser for that name, and many +things will break if a Samba server registers the Domain master +browser NetBIOS name (<replaceable>DOMAIN</replaceable><1B>) +with WINS instead of the PDC. +</para> + +<para> +For subnets other than the one containing the Windows NT PDC +you may set up Samba servers as local master browsers as +described. To make a Samba server a local master browser set +the following options in the <command>[global]</command> section +of the &smb.conf; file : +</para> + +<para> +<programlisting> + domain master = no + local master = yes + preferred master = yes + os level = 65 +</programlisting> +</para> + +<para> +If you wish to have a Samba server fight the election with machines +on the same subnet you may set the <command>os level</command> parameter +to lower levels. By doing this you can tune the order of machines that +will become local master browsers if they are running. For +more details on this see the section <link linkend="browse-force-master"> +Forcing samba to be the master browser</link> +below. +</para> + +<para> +If you have Windows NT machines that are members of the domain +on all subnets, and you are sure they will always be running then +you can disable Samba from taking part in browser elections and +ever becoming a local master browser by setting following options +in the <command>[global]</command> section of the &smb.conf; +file : +</para> + +<para> +<programlisting> + domain master = no + local master = no + preferred master = no + os level = 0 +</programlisting> +</para> + +</sect2> + +<sect2 id="browse-force-master"> +<title>Forcing samba to be the master</title> + +<para> +Who becomes the <command>master browser</command> is determined by an election +process using broadcasts. Each election packet contains a number of parameters +which determine what precedence (bias) a host should have in the +election. By default Samba uses a very low precedence and thus loses +elections to just about anyone else. +</para> + +<para> +If you want Samba to win elections then just set the <command>os level</command> global +option in &smb.conf; to a higher number. It defaults to 0. Using 34 +would make it win all elections over every other system (except other +samba systems!) +</para> + +<para> +A <command>os level</command> of 2 would make it beat WfWg and Win95, but not MS Windows +NT/2K Server. A MS Windows NT/2K Server domain controller uses level 32. +</para> + +<para>The maximum os level is 255</para> + +<para> +If you want samba to force an election on startup, then set the +<command>preferred master</command> global option in &smb.conf; to "yes". Samba will +then have a slight advantage over other potential master browsers +that are not preferred master browsers. Use this parameter with +care, as if you have two hosts (whether they are windows 95 or NT or +samba) on the same local subnet both set with <command>preferred master</command> to +"yes", then periodically and continually they will force an election +in order to become the local master browser. +</para> + +<para> +If you want samba to be a <command>domain master browser</command>, then it is +recommended that you also set <command>preferred master</command> to "yes", because +samba will not become a domain master browser for the whole of your +LAN or WAN if it is not also a local master browser on its own +broadcast isolated subnet. +</para> + +<para> +It is possible to configure two samba servers to attempt to become +the domain master browser for a domain. The first server that comes +up will be the domain master browser. All other samba servers will +attempt to become the domain master browser every 5 minutes. They +will find that another samba server is already the domain master +browser and will fail. This provides automatic redundancy, should +the current domain master browser fail. +</para> + +</sect2> + +<sect2> +<title>Making samba the domain master</title> + +<para> +The domain master is responsible for collating the browse lists of +multiple subnets so that browsing can occur between subnets. You can +make samba act as the domain master by setting <command>domain master = yes</command> +in &smb.conf;. By default it will not be a domain master. +</para> + +<para> +Note that you should NOT set Samba to be the domain master for a +workgroup that has the same name as an NT Domain. +</para> + +<para> +When samba is the domain master and the master browser it will listen +for master announcements (made roughly every twelve minutes) from local +master browsers on other subnets and then contact them to synchronise +browse lists. +</para> + +<para> +If you want samba to be the domain master then I suggest you also set +the <command>os level</command> high enough to make sure it wins elections, and set +<command>preferred master</command> to "yes", to get samba to force an election on +startup. +</para> + +<para> +Note that all your servers (including samba) and clients should be +using a WINS server to resolve NetBIOS names. If your clients are only +using broadcasting to resolve NetBIOS names, then two things will occur: +</para> + +<orderedlist> +<listitem> + <para> + your local master browsers will be unable to find a domain master + browser, as it will only be looking on the local subnet. + </para> +</listitem> + +<listitem> + <para> + if a client happens to get hold of a domain-wide browse list, and + a user attempts to access a host in that list, it will be unable to + resolve the NetBIOS name of that host. + </para> +</listitem> +</orderedlist> + +<para> +If, however, both samba and your clients are using a WINS server, then: +</para> + +<orderedlist> +<listitem> + <para> + your local master browsers will contact the WINS server and, as long as + samba has registered that it is a domain master browser with the WINS + server, your local master browser will receive samba's ip address + as its domain master browser. + </para> +</listitem> + +<listitem> + <para> + when a client receives a domain-wide browse list, and a user attempts + to access a host in that list, it will contact the WINS server to + resolve the NetBIOS name of that host. as long as that host has + registered its NetBIOS name with the same WINS server, the user will + be able to see that host. + </para> +</listitem> +</orderedlist> + +</sect2> + +<sect2> +<title>Note about broadcast addresses</title> + +<para> +If your network uses a "0" based broadcast address (for example if it +ends in a 0) then you will strike problems. Windows for Workgroups +does not seem to support a 0's broadcast and you will probably find +that browsing and name lookups won't work. +</para> +</sect2> + +<sect2> +<title>Multiple interfaces</title> + +<para> +Samba now supports machines with multiple network interfaces. If you +have multiple interfaces then you will need to use the <command>interfaces</command> +option in &smb.conf; to configure them. +</para> +</sect2> +<sect2> +<title>Use of the <command>Remote Announce</command> parameter</title> +<para> +The <command>remote announce</command> parameter of +<filename>smb.conf</filename> can be used to forcibly ensure +that all the NetBIOS names on a network get announced to a remote network. +The syntax of the <command>remote announce</command> parameter is: +<programlisting> + remote announce = a.b.c.d [e.f.g.h] ... +</programlisting> +_or_ +<programlisting> + remote announce = a.b.c.d/WORKGROUP [e.f.g.h/WORKGROUP] ... +</programlisting> + +where: +<variablelist> +<varlistentry><term><replaceable>a.b.c.d</replaceable> and +<replaceable>e.f.g.h</replaceable></term> +<listitem><para>is either the LMB (Local Master Browser) IP address +or the broadcst address of the remote network. +ie: the LMB is at 192.168.1.10, or the address +could be given as 192.168.1.255 where the netmask +is assumed to be 24 bits (255.255.255.0). +When the remote announcement is made to the broadcast +address of the remote network every host will receive +our announcements. This is noisy and therefore +undesirable but may be necessary if we do NOT know +the IP address of the remote LMB.</para></listitem> +</varlistentry> + +<varlistentry> +<term><replaceable>WORKGROUP</replaceable></term> +<listitem><para>is optional and can be either our own workgroup +or that of the remote network. If you use the +workgroup name of the remote network then our +NetBIOS machine names will end up looking like +they belong to that workgroup, this may cause +name resolution problems and should be avoided. +</para></listitem> +</varlistentry> +</variablelist> +</para> + +</sect2> + +<sect2> +<title>Use of the <command>Remote Browse Sync</command> parameter</title> + +<para> +The <command>remote browse sync</command> parameter of +<filename>smb.conf</filename> is used to announce to +another LMB that it must synchronise it's NetBIOS name list with our +Samba LMB. It works ONLY if the Samba server that has this option is +simultaneously the LMB on it's network segment. +</para> + +<para> +The syntax of the <command>remote browse sync</command> parameter is: + +<programlisting> +remote browse sync = <replaceable>a.b.c.d</replaceable> +</programlisting> + +where <replaceable>a.b.c.d</replaceable> is either the IP address of the +remote LMB or else is the network broadcast address of the remote segment. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>WINS - The Windows Internetworking Name Server</title> + +<para> +Use of WINS (either Samba WINS _or_ MS Windows NT Server WINS) is highly +recommended. Every NetBIOS machine registers it's name together with a +name_type value for each of of several types of service it has available. +eg: It registers it's name directly as a unique (the type 0x03) name. +It also registers it's name if it is running the lanmanager compatible +server service (used to make shares and printers available to other users) +by registering the server (the type 0x20) name. +</para> + +<para> +All NetBIOS names are up to 15 characters in length. The name_type variable +is added to the end of the name - thus creating a 16 character name. Any +name that is shorter than 15 characters is padded with spaces to the 15th +character. ie: All NetBIOS names are 16 characters long (including the +name_type information). +</para> + +<para> +WINS can store these 16 character names as they get registered. A client +that wants to log onto the network can ask the WINS server for a list +of all names that have registered the NetLogon service name_type. This saves +broadcast traffic and greatly expedites logon processing. Since broadcast +name resolution can not be used across network segments this type of +information can only be provided via WINS _or_ via statically configured +<filename>lmhosts</filename> files that must reside on all clients in the +absence of WINS. +</para> + +<para> +WINS also serves the purpose of forcing browse list synchronisation by all +LMB's. LMB's must synchronise their browse list with the DMB (domain master +browser) and WINS helps the LMB to identify it's DMB. By definition this +will work only within a single workgroup. Note that the domain master browser +has NOTHING to do with what is referred to as an MS Windows NT Domain. The +later is a reference to a security environment while the DMB refers to the +master controller for browse list information only. +</para> + +<para> +Use of WINS will work correctly only if EVERY client TCP/IP protocol stack +has been configured to use the WINS server/s. Any client that has not been +configured to use the WINS server will continue to use only broadcast based +name registration so that WINS may NEVER get to know about it. In any case, +machines that have not registered with a WINS server will fail name to address +lookup attempts by other clients and will therefore cause workstation access +errors. +</para> + +<para> +To configure Samba as a WINS server just add +<command>wins support = yes</command> to the <filename>smb.conf</filename> +file [globals] section. +</para> + +<para> +To configure Samba to register with a WINS server just add +"wins server = a.b.c.d" to your smb.conf file [globals] section. +</para> + +<important><para> +Never use both <command>wins support = yes</command> together +with <command>wins server = a.b.c.d</command> +particularly not using it's own IP address. +Specifying both will cause &nmbd; to refuse to start! +</para></important> + +<sect2> +<title>Setting up a WINS server</title> + +<para> +Either a Samba machine or a Windows NT Server machine may be set up +as a WINS server. To set a Samba machine to be a WINS server you must +add the following option to the &smb.conf; file on the selected machine : +in the [globals] section add the line +</para> + +<para> +<programlisting> + wins support = yes +</programlisting> +</para> + +<para> +Versions of Samba prior to 1.9.17 had this parameter default to +yes. If you have any older versions of Samba on your network it is +strongly suggested you upgrade to a recent version, or at the very +least set the parameter to 'no' on all these machines. +</para> + +<para> +Machines with <command>wins support = yes</command> will keep a list of +all NetBIOS names registered with them, acting as a DNS for NetBIOS names. +</para> + +<para> +You should set up only ONE wins server. Do NOT set the +<command>wins support = yes</command> option on more than one Samba +server. +</para> + +<para> +To set up a Windows NT Server as a WINS server you need to set up +the WINS service - see your NT documentation for details. Note that +Windows NT WINS Servers can replicate to each other, allowing more +than one to be set up in a complex subnet environment. As Microsoft +refuse to document these replication protocols Samba cannot currently +participate in these replications. It is possible in the future that +a Samba->Samba WINS replication protocol may be defined, in which +case more than one Samba machine could be set up as a WINS server +but currently only one Samba server should have the +<command>wins support = yes</command> parameter set. +</para> + +<para> +After the WINS server has been configured you must ensure that all +machines participating on the network are configured with the address +of this WINS server. If your WINS server is a Samba machine, fill in +the Samba machine IP address in the "Primary WINS Server" field of +the "Control Panel->Network->Protocols->TCP->WINS Server" dialogs +in Windows 95 or Windows NT. To tell a Samba server the IP address +of the WINS server add the following line to the [global] section of +all &smb.conf; files : +</para> + +<para> +<programlisting> + wins server = <name or IP address> +</programlisting> +</para> + +<para> +where <name or IP address> is either the DNS name of the WINS server +machine or its IP address. +</para> + +<para> +Note that this line MUST NOT BE SET in the &smb.conf; file of the Samba +server acting as the WINS server itself. If you set both the +<command>wins support = yes</command> option and the +<command>wins server = <name></command> option then +nmbd will fail to start. +</para> + +<para> +There are two possible scenarios for setting up cross subnet browsing. +The first details setting up cross subnet browsing on a network containing +Windows 95, Samba and Windows NT machines that are not configured as +part of a Windows NT Domain. The second details setting up cross subnet +browsing on networks that contain NT Domains. +</para> + +</sect2> + +<sect2> +<title>WINS Replication</title> + +<para> +Samba-3 permits WINS replication through the use of the <filename>wrepld</filename> utility. +This tool is not currently capable of being used as it is still in active development. +As soon as this tool becomes moderately functional we will prepare man pages and enhance this +section of the documentation to provide usage and technical details. +</para> + +</sect2> +<sect2> +<title>Static WINS Entries</title> + +<para> +New to Samba-3 is a tool called <filename>winsedit</filename> that may be used to add +static WINS entries to the WINS database. This tool can be used also to modify entries +existing in the WINS database. +</para> + +<para> +The development of the winsedit tool was made necessary due to the migration +of the older style wins.dat file into a new tdb binary backend data store. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Helpful Hints</title> + +<para> +The following hints should be carefully considered as they are stumbling points +for many new network administrators. +</para> + +<sect2> +<title>Windows Networking Protocols</title> + +<warning><para> +Do NOT use more than one (1) protocol on MS Windows machines +</para></warning> + +<para> +A very common cause of browsing problems results from installing more than +one protocol on an MS Windows machine. +</para> + +<para> +Every NetBIOS machine takes part in a process of electing the LMB (and DMB) +every 15 minutes. A set of election criteria is used to determine the order +of precidence for winning this election process. A machine running Samba or +Windows NT will be biased so that the most suitable machine will predictably +win and thus retain it's role. +</para> + +<para> +The election process is "fought out" so to speak over every NetBIOS network +interface. In the case of a Windows 9x machine that has both TCP/IP and IPX +installed and has NetBIOS enabled over both protocols the election will be +decided over both protocols. As often happens, if the Windows 9x machine is +the only one with both protocols then the LMB may be won on the NetBIOS +interface over the IPX protocol. Samba will then lose the LMB role as Windows +9x will insist it knows who the LMB is. Samba will then cease to function +as an LMB and thus browse list operation on all TCP/IP only machines will +fail. +</para> + +<para><emphasis> +Windows 95, 98, 98se, Me are referred to generically as Windows 9x. +The Windows NT4, 2000, XP and 2003 use common protocols. These are roughly +referred to as the WinNT family, but it should be recognised that 2000 and +XP/2003 introduce new protocol extensions that cause them to behave +differently from MS Windows NT4. Generally, where a server does NOT support +the newer or extended protocol, these will fall back to the NT4 protocols. +</emphasis></para> + +<para> +The safest rule of all to follow it this - USE ONLY ONE PROTOCOL! +</para> + +</sect2> + +<sect2> +<title>Name Resolution Order</title> + +<para> +Resolution of NetBIOS names to IP addresses can take place using a number +of methods. The only ones that can provide NetBIOS name_type information +are:</para> + +<simplelist> + <member>WINS: the best tool!</member> + <member>LMHOSTS: is static and hard to maintain.</member> + <member>Broadcast: uses UDP and can not resolve names across remote segments.</member> +</simplelist> + +<para> +Alternative means of name resolution includes:</para> +<simplelist> +<member>/etc/hosts: is static, hard to maintain, and lacks name_type info</member> +<member>DNS: is a good choice but lacks essential name_type info.</member> +</simplelist> + +<para> +Many sites want to restrict DNS lookups and want to avoid broadcast name +resolution traffic. The "name resolve order" parameter is of great help here. +The syntax of the "name resolve order" parameter is: +<programlisting> +name resolve order = wins lmhosts bcast host +</programlisting> +_or_ +<programlisting> +name resolve order = wins lmhosts (eliminates bcast and host) +</programlisting> +The default is: +<programlisting> +name resolve order = host lmhost wins bcast +</programlisting> +where "host" refers the the native methods used by the Unix system +to implement the gethostbyname() function call. This is normally +controlled by <filename>/etc/host.conf</filename>, <filename>/etc/nsswitch.conf</filename> and <filename>/etc/resolv.conf</filename>. +</para> +</sect2> +</sect1> + +<sect1> +<title>Technical Overview of browsing</title> + +<para> +SMB networking provides a mechanism by which clients can access a list +of machines in a network, a so-called <command>browse list</command>. This list +contains machines that are ready to offer file and/or print services +to other machines within the network. Thus it does not include +machines which aren't currently able to do server tasks. The browse +list is heavily used by all SMB clients. Configuration of SMB +browsing has been problematic for some Samba users, hence this +document. +</para> + +<para> +MS Windows 2000 and later, as with Samba 3 and later, can be +configured to not use NetBIOS over TCP/IP. When configured this way +it is imperative that name resolution (using DNS/LDAP/ADS) be correctly +configured and operative. Browsing will NOT work if name resolution +from SMB machine names to IP addresses does not function correctly. +</para> + +<para> +Where NetBIOS over TCP/IP is enabled use of a WINS server is highly +recommended to aid the resolution of NetBIOS (SMB) names to IP addresses. +WINS allows remote segment clients to obtain NetBIOS name_type information +that can NOT be provided by any other means of name resolution. +</para> + +<sect2> +<title>Browsing support in samba</title> + +<para> +Samba facilitates browsing. The browsing is supported by &nmbd; +and is also controlled by options in the &smb.conf; file. +Samba can act as a local browse master for a workgroup and the ability +to support domain logons and scripts is now available. +</para> + +<para> +Samba can also act as a domain master browser for a workgroup. This +means that it will collate lists from local browse masters into a +wide area network server list. In order for browse clients to +resolve the names they may find in this list, it is recommended that +both samba and your clients use a WINS server. +</para> + +<para> +Note that you should NOT set Samba to be the domain master for a +workgroup that has the same name as an NT Domain: on each wide area +network, you must only ever have one domain master browser per workgroup, +regardless of whether it is NT, Samba or any other type of domain master +that is providing this service. +</para> + +<note><para> +Nmbd can be configured as a WINS server, but it is not +necessary to specifically use samba as your WINS server. MS Windows +NT4, Server or Advanced Server 2000 or 2003 can be configured as +your WINS server. In a mixed NT/2000/2003 server and samba environment on +a Wide Area Network, it is recommended that you use the Microsoft +WINS server capabilities. In a samba-only environment, it is +recommended that you use one and only one Samba server as your WINS server. +</para></note> + +<para> +To get browsing to work you need to run nmbd as usual, but will need +to use the <command>workgroup</command> option in &smb.conf; +to control what workgroup Samba becomes a part of. +</para> + +<para> +Samba also has a useful option for a Samba server to offer itself for +browsing on another subnet. It is recommended that this option is only +used for 'unusual' purposes: announcements over the internet, for +example. See <command>remote announce</command> in the +&smb.conf; man page. +</para> +</sect2> + +<sect2> +<title>Problem resolution</title> + +<para> +If something doesn't work then hopefully the log.nmb file will help +you track down the problem. Try a debug level of 2 or 3 for finding +problems. Also note that the current browse list usually gets stored +in text form in a file called <filename>browse.dat</filename>. +</para> + +<para> +Note that if it doesn't work for you, then you should still be able to +type the server name as <filename>\\SERVER</filename> in filemanager then +hit enter and filemanager should display the list of available shares. +</para> + +<para> +Some people find browsing fails because they don't have the global +<command>guest account</command> set to a valid account. Remember that the +IPC$ connection that lists the shares is done as guest, and thus you must +have a valid guest account. +</para> + +<para><emphasis> +MS Windows 2000 and upwards (as with Samba) can be configured to disallow +anonymous (ie: Guest account) access to the IPC$ share. In that case, the +MS Windows 2000/XP/2003 machine acting as an SMB/CIFS client will use the +name of the currently logged in user to query the IPC$ share. MS Windows +9X clients are not able to do this and thus will NOT be able to browse +server resources. +</emphasis></para> + +<para> +The other big problem people have is that their broadcast address, +netmask or IP address is wrong (specified with the "interfaces" option +in &smb.conf;) +</para> +</sect2> + +<sect2> +<title>Browsing across subnets</title> +<para> +Since the release of Samba 1.9.17(alpha1) Samba has been +updated to enable it to support the replication of browse lists +across subnet boundaries. New code and options have been added to +achieve this. This section describes how to set this feature up +in different settings. +</para> + +<para> +To see browse lists that span TCP/IP subnets (ie. networks separated +by routers that don't pass broadcast traffic) you must set up at least +one WINS server. The WINS server acts as a DNS for NetBIOS names, allowing +NetBIOS name to IP address translation to be done by doing a direct +query of the WINS server. This is done via a directed UDP packet on +port 137 to the WINS server machine. The reason for a WINS server is +that by default, all NetBIOS name to IP address translation is done +by broadcasts from the querying machine. This means that machines +on one subnet will not be able to resolve the names of machines on +another subnet without using a WINS server. +</para> + +<para> +Remember, for browsing across subnets to work correctly, all machines, +be they Windows 95, Windows NT, or Samba servers must have the IP address +of a WINS server given to them by a DHCP server, or by manual configuration +(for Win95 and WinNT, this is in the TCP/IP Properties, under Network +settings) for Samba this is in the &smb.conf; file. +</para> + +<sect3> +<title>How does cross subnet browsing work ?</title> + +<para> +Cross subnet browsing is a complicated dance, containing multiple +moving parts. It has taken Microsoft several years to get the code +that achieves this correct, and Samba lags behind in some areas. +Samba is capable of cross subnet browsing when configured correctly. +</para> + +<para> +Consider a network set up as follows : +</para> + +<para> +<programlisting> + (DMB) + N1_A N1_B N1_C N1_D N1_E + | | | | | + ------------------------------------------------------- + | subnet 1 | + +---+ +---+ + |R1 | Router 1 Router 2 |R2 | + +---+ +---+ + | | + | subnet 2 subnet 3 | + -------------------------- ------------------------------------ + | | | | | | | | + N2_A N2_B N2_C N2_D N3_A N3_B N3_C N3_D + (WINS) +</programlisting> +</para> + +<para> +Consisting of 3 subnets (1, 2, 3) connected by two routers +(R1, R2) - these do not pass broadcasts. Subnet 1 has 5 machines +on it, subnet 2 has 4 machines, subnet 3 has 4 machines. Assume +for the moment that all these machines are configured to be in the +same workgroup (for simplicities sake). Machine N1_C on subnet 1 +is configured as Domain Master Browser (ie. it will collate the +browse lists for the workgroup). Machine N2_D is configured as +WINS server and all the other machines are configured to register +their NetBIOS names with it. +</para> + +<para> +As all these machines are booted up, elections for master browsers +will take place on each of the three subnets. Assume that machine +N1_C wins on subnet 1, N2_B wins on subnet 2, and N3_D wins on +subnet 3 - these machines are known as local master browsers for +their particular subnet. N1_C has an advantage in winning as the +local master browser on subnet 1 as it is set up as Domain Master +Browser. +</para> + +<para> +On each of the three networks, machines that are configured to +offer sharing services will broadcast that they are offering +these services. The local master browser on each subnet will +receive these broadcasts and keep a record of the fact that +the machine is offering a service. This list of records is +the basis of the browse list. For this case, assume that +all the machines are configured to offer services so all machines +will be on the browse list. +</para> + +<para> +For each network, the local master browser on that network is +considered 'authoritative' for all the names it receives via +local broadcast. This is because a machine seen by the local +master browser via a local broadcast must be on the same +network as the local master browser and thus is a 'trusted' +and 'verifiable' resource. Machines on other networks that +the local master browsers learn about when collating their +browse lists have not been directly seen - these records are +called 'non-authoritative'. +</para> + +<para> +At this point the browse lists look as follows (these are +the machines you would see in your network neighborhood if +you looked in it on a particular network right now). +</para> + +<para> +<programlisting> +Subnet Browse Master List +------ ------------- ---- +Subnet1 N1_C N1_A, N1_B, N1_C, N1_D, N1_E + +Subnet2 N2_B N2_A, N2_B, N2_C, N2_D + +Subnet3 N3_D N3_A, N3_B, N3_C, N3_D +</programlisting> +</para> + +<para> +Note that at this point all the subnets are separate, no +machine is seen across any of the subnets. +</para> + +<para> +Now examine subnet 2. As soon as N2_B has become the local +master browser it looks for a Domain master browser to synchronize +its browse list with. It does this by querying the WINS server +(N2_D) for the IP address associated with the NetBIOS name +WORKGROUP<1B>. This name was registerd by the Domain master +browser (N1_C) with the WINS server as soon as it was booted. +</para> + +<para> +Once N2_B knows the address of the Domain master browser it +tells it that is the local master browser for subnet 2 by +sending a MasterAnnouncement packet as a UDP port 138 packet. +It then synchronizes with it by doing a NetServerEnum2 call. This +tells the Domain Master Browser to send it all the server +names it knows about. Once the domain master browser receives +the MasterAnnouncement packet it schedules a synchronization +request to the sender of that packet. After both synchronizations +are done the browse lists look like : +</para> + +<para> +<programlisting> +Subnet Browse Master List +------ ------------- ---- +Subnet1 N1_C N1_A, N1_B, N1_C, N1_D, N1_E, + N2_A(*), N2_B(*), N2_C(*), N2_D(*) + +Subnet2 N2_B N2_A, N2_B, N2_C, N2_D + N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*) + +Subnet3 N3_D N3_A, N3_B, N3_C, N3_D + +Servers with a (*) after them are non-authoritative names. +</programlisting> +</para> + +<para> +At this point users looking in their network neighborhood on +subnets 1 or 2 will see all the servers on both, users on +subnet 3 will still only see the servers on their own subnet. +</para> + +<para> +The same sequence of events that occured for N2_B now occurs +for the local master browser on subnet 3 (N3_D). When it +synchronizes browse lists with the domain master browser (N1_A) +it gets both the server entries on subnet 1, and those on +subnet 2. After N3_D has synchronized with N1_C and vica-versa +the browse lists look like. +</para> + +<para> +<programlisting> +Subnet Browse Master List +------ ------------- ---- +Subnet1 N1_C N1_A, N1_B, N1_C, N1_D, N1_E, + N2_A(*), N2_B(*), N2_C(*), N2_D(*), + N3_A(*), N3_B(*), N3_C(*), N3_D(*) + +Subnet2 N2_B N2_A, N2_B, N2_C, N2_D + N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*) + +Subnet3 N3_D N3_A, N3_B, N3_C, N3_D + N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*), + N2_A(*), N2_B(*), N2_C(*), N2_D(*) + +Servers with a (*) after them are non-authoritative names. +</programlisting> +</para> + +<para> +At this point users looking in their network neighborhood on +subnets 1 or 3 will see all the servers on all sunbets, users on +subnet 2 will still only see the servers on subnets 1 and 2, but not 3. +</para> + +<para> +Finally, the local master browser for subnet 2 (N2_B) will sync again +with the domain master browser (N1_C) and will recieve the missing +server entries. Finally - and as a steady state (if no machines +are removed or shut off) the browse lists will look like : +</para> + +<para> +<programlisting> +Subnet Browse Master List +------ ------------- ---- +Subnet1 N1_C N1_A, N1_B, N1_C, N1_D, N1_E, + N2_A(*), N2_B(*), N2_C(*), N2_D(*), + N3_A(*), N3_B(*), N3_C(*), N3_D(*) + +Subnet2 N2_B N2_A, N2_B, N2_C, N2_D + N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*) + N3_A(*), N3_B(*), N3_C(*), N3_D(*) + +Subnet3 N3_D N3_A, N3_B, N3_C, N3_D + N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*), + N2_A(*), N2_B(*), N2_C(*), N2_D(*) + +Servers with a (*) after them are non-authoritative names. +</programlisting> +</para> + +<para> +Synchronizations between the domain master browser and local +master browsers will continue to occur, but this should be a +steady state situation. +</para> + +<para> +If either router R1 or R2 fails the following will occur: +</para> + +<orderedlist> +<listitem> + <para> + Names of computers on each side of the inaccessible network fragments + will be maintained for as long as 36 minutes, in the network neighbourhood + lists. + </para> +</listitem> + +<listitem> + <para> + Attempts to connect to these inaccessible computers will fail, but the + names will not be removed from the network neighbourhood lists. + </para> +</listitem> + +<listitem> + <para> + If one of the fragments is cut off from the WINS server, it will only + be able to access servers on its local subnet, by using subnet-isolated + broadcast NetBIOS name resolution. The effects are similar to that of + losing access to a DNS server. + </para> +</listitem> +</orderedlist> +</sect3> +</sect2> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Other-Clients.xml b/docs/docbook/projdoc/Other-Clients.xml new file mode 100644 index 0000000000..068b9c0b32 --- /dev/null +++ b/docs/docbook/projdoc/Other-Clients.xml @@ -0,0 +1,373 @@ +<chapter id="Other-Clients"> +<chapterinfo> + &author.jmcd; + &author.jelmer; + + <pubdate>5 Mar 2001</pubdate> +</chapterinfo> + +<title>Samba and other CIFS clients</title> + +<para>This chapter contains client-specific information.</para> + +<sect1> +<title>Macintosh clients?</title> + +<para> +Yes. <ulink url="http://www.thursby.com/">Thursby</ulink> now have a CIFS Client / Server called <ulink url="http://www.thursby.com/products/dave.html">DAVE</ulink> +</para> + +<para> +They test it against Windows 95, Windows NT and samba for +compatibility issues. At the time of writing, DAVE was at version +1.0.1. The 1.0.0 to 1.0.1 update is available as a free download from +the Thursby web site (the speed of finder copies has been greatly +enhanced, and there are bug-fixes included). +</para> + +<para> +Alternatives - There are two free implementations of AppleTalk for +several kinds of UNIX machnes, and several more commercial ones. +These products allow you to run file services and print services +natively to Macintosh users, with no additional support required on +the Macintosh. The two free omplementations are +<ulink url="http://www.umich.edu/~rsug/netatalk/">Netatalk</ulink>, and +<ulink url="http://www.cs.mu.oz.au/appletalk/atalk.html">CAP</ulink>. +What Samba offers MS +Windows users, these packages offer to Macs. For more info on these +packages, Samba, and Linux (and other UNIX-based systems) see +<ulink url="http://www.eats.com/linux_mac_win.html">http://www.eats.com/linux_mac_win.html</ulink> +</para> + +</sect1> + +<sect1> +<title>OS2 Client</title> + + <sect2> + <title>How can I configure OS/2 Warp Connect or + OS/2 Warp 4 as a client for Samba?</title> + + <para>A more complete answer to this question can be + found on <ulink url="http://carol.wins.uva.nl/~leeuw/samba/warp.html"> + http://carol.wins.uva.nl/~leeuw/samba/warp.html</ulink>.</para> + + <para>Basically, you need three components:</para> + + <itemizedlist> + <listitem><para>The File and Print Client ('IBM Peer') + </para></listitem> + <listitem><para>TCP/IP ('Internet support') + </para></listitem> + <listitem><para>The "NetBIOS over TCP/IP" driver ('TCPBEUI') + </para></listitem> + </itemizedlist> + + <para>Installing the first two together with the base operating + system on a blank system is explained in the Warp manual. If Warp + has already been installed, but you now want to install the + networking support, use the "Selective Install for Networking" + object in the "System Setup" folder.</para> + + <para>Adding the "NetBIOS over TCP/IP" driver is not described + in the manual and just barely in the online documentation. Start + MPTS.EXE, click on OK, click on "Configure LAPS" and click + on "IBM OS/2 NETBIOS OVER TCP/IP" in 'Protocols'. This line + is then moved to 'Current Configuration'. Select that line, + click on "Change number" and increase it from 0 to 1. Save this + configuration.</para> + + <para>If the Samba server(s) is not on your local subnet, you + can optionally add IP names and addresses of these servers + to the "Names List", or specify a WINS server ('NetBIOS + Nameserver' in IBM and RFC terminology). For Warp Connect you + may need to download an update for 'IBM Peer' to bring it on + the same level as Warp 4. See the webpage mentioned above.</para> + </sect2> + + <sect2> + <title>How can I configure OS/2 Warp 3 (not Connect), + OS/2 1.2, 1.3 or 2.x for Samba?</title> + + <para>You can use the free Microsoft LAN Manager 2.2c Client + for OS/2 from + <ulink url="ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/"> + ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/</ulink>. + See <ulink url="http://carol.wins.uva.nl/~leeuw/lanman.html"> + http://carol.wins.uva.nl/~leeuw/lanman.html</ulink> for + more information on how to install and use this client. In + a nutshell, edit the file \OS2VER in the root directory of + the OS/2 boot partition and add the lines:</para> + + <para><programlisting> + 20=setup.exe + 20=netwksta.sys + 20=netvdd.sys + </programlisting></para> + + <para>before you install the client. Also, don't use the + included NE2000 driver because it is buggy. Try the NE2000 + or NS2000 driver from + <ulink url="ftp://ftp.cdrom.com/pub/os2/network/ndis/"> + ftp://ftp.cdrom.com/pub/os2/network/ndis/</ulink> instead. + </para> + </sect2> + + <sect2> + <title>Are there any other issues when OS/2 (any version) + is used as a client?</title> + + <para>When you do a NET VIEW or use the "File and Print + Client Resource Browser", no Samba servers show up. This can + be fixed by a patch from <ulink + url="http://carol.wins.uva.nl/~leeuw/samba/fix.html"> + http://carol.wins.uva.nl/~leeuw/samba/fix.html</ulink>. + The patch will be included in a later version of Samba. It also + fixes a couple of other problems, such as preserving long + filenames when objects are dragged from the Workplace Shell + to the Samba server. </para> + </sect2> + + <sect2> + <title>How do I get printer driver download working + for OS/2 clients?</title> + + <para>First, create a share called [PRINTDRV] that is + world-readable. Copy your OS/2 driver files there. Note + that the .EA_ files must still be separate, so you will need + to use the original install files, and not copy an installed + driver from an OS/2 system.</para> + + <para>Install the NT driver first for that printer. Then, + add to your smb.conf a parameter, os2 driver map = + <replaceable>filename</replaceable>". Then, in the file + specified by <replaceable>filename</replaceable>, map the + name of the NT driver name to the OS/2 driver name as + follows:</para> + + <para><command>nt driver name = os2 "driver + name"."device name"</command>, e.g.: + HP LaserJet 5L = LASERJET.HP LaserJet 5L</para> + + <para>You can have multiple drivers mapped in this file.</para> + + <para>If you only specify the OS/2 driver name, and not the + device name, the first attempt to download the driver will + actually download the files, but the OS/2 client will tell + you the driver is not available. On the second attempt, it + will work. This is fixed simply by adding the device name + to the mapping, after which it will work on the first attempt. + </para> + </sect2> +</sect1> + +<sect1> +<title>Windows for Workgroups</title> + +<sect2> +<title>Use latest TCP/IP stack from Microsoft</title> + +<para>Use the latest TCP/IP stack from microsoft if you use Windows +for workgroups. +</para> + +<para>The early TCP/IP stacks had lots of bugs.</para> + +<para> +Microsoft has released an incremental upgrade to their TCP/IP 32-Bit +VxD drivers. The latest release can be found on their ftp site at +ftp.microsoft.com, located in /peropsys/windows/public/tcpip/wfwt32.exe. +There is an update.txt file there that describes the problems that were +fixed. New files include WINSOCK.DLL, TELNET.EXE, WSOCK.386, VNBT.386, +WSTCP.386, TRACERT.EXE, NETSTAT.EXE, and NBTSTAT.EXE. +</para> + +</sect2> + +<sect2> +<title>Delete .pwl files after password change</title> + +<para> +WfWg does a lousy job with passwords. I find that if I change my +password on either the unix box or the PC the safest thing to do is to +delete the .pwl files in the windows directory. The PC will complain about not finding the files, but will soon get over it, allowing you to enter the new password. +</para> + +<para> +If you don't do this you may find that WfWg remembers and uses the old +password, even if you told it a new one. +</para> + +<para> +Often WfWg will totally ignore a password you give it in a dialog box. +</para> + +</sect2> + +<sect2> +<title>Configure WfW password handling</title> + +<para> +There is a program call admincfg.exe +on the last disk (disk 8) of the WFW 3.11 disk set. To install it +type EXPAND A:\ADMINCFG.EX_ C:\WINDOWS\ADMINCFG.EXE Then add an icon +for it via the "Progam Manager" "New" Menu. This program allows you +to control how WFW handles passwords. ie disable Password Caching etc +for use with <command>security = user</command> +</para> + +</sect2> + +<sect2> +<title>Case handling of passwords</title> + +<para>Windows for Workgroups uppercases the password before sending it to the server. Unix passwords can be case-sensitive though. Check the <ulink url="smb.conf.5.html">smb.conf(5)</ulink> information on <command>password level</command> to specify what characters samba should try to uppercase when checking.</para> + +</sect2> + +<sect2> +<title>Use TCP/IP as default protocol</title> + +<para>To support print queue reporting you may find +that you have to use TCP/IP as the default protocol under +WfWg. For some reason if you leave Netbeui as the default +it may break the print queue reporting on some systems. +It is presumably a WfWg bug.</para> + +</sect2> + +<sect2> +<title>Speed improvement</title> + +<para> +Note that some people have found that setting DefaultRcvWindow in +the [MSTCP] section of the SYSTEM.INI file under WfWg to 3072 gives a +big improvement. I don't know why. +</para> + +<para> +My own experience wth DefaultRcvWindow is that I get much better +performance with a large value (16384 or larger). Other people have +reported that anything over 3072 slows things down enourmously. One +person even reported a speed drop of a factor of 30 when he went from +3072 to 8192. I don't know why. +</para> +</sect2> +</sect1> + +<sect1> +<title>Windows '95/'98</title> + +<para> +When using Windows 95 OEM SR2 the following updates are recommended where Samba +is being used. Please NOTE that the above change will affect you once these +updates have been installed. +</para> + +<para> +There are more updates than the ones mentioned here. You are referred to the +Microsoft Web site for all currently available updates to your specific version +of Windows 95. +</para> + +<orderedlist> +<listitem><para>Kernel Update: KRNLUPD.EXE</para></listitem> +<listitem><para>Ping Fix: PINGUPD.EXE</para></listitem> +<listitem><para>RPC Update: RPCRTUPD.EXE</para></listitem> +<listitem><para>TCP/IP Update: VIPUPD.EXE</para></listitem> +<listitem><para>Redirector Update: VRDRUPD.EXE</para></listitem> +</orderedlist> + +<para> +Also, if using MS OutLook it is desirable to install the OLEUPD.EXE fix. This +fix may stop your machine from hanging for an extended period when exiting +OutLook and you may also notice a significant speedup when accessing network +neighborhood services. +</para> + +<sect2> +<title>Speed improvement</title> + +<para> +Configure the win95 TCPIP registry settings to give better +performance. I use a program called MTUSPEED.exe which I got off the +net. There are various other utilities of this type freely available. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Windows 2000 Service Pack 2</title> + +<para> +There are several annoyances with Windows 2000 SP2. One of which +only appears when using a Samba server to host user profiles +to Windows 2000 SP2 clients in a Windows domain. This assumes +that Samba is a member of the domain, but the problem will +likely occur if it is not. +</para> + +<para> +In order to server profiles successfully to Windows 2000 SP2 +clients (when not operating as a PDC), Samba must have +<command>nt acl support = no</command> +added to the file share which houses the roaming profiles. +If this is not done, then the Windows 2000 SP2 client will +complain about not being able to access the profile (Access +Denied) and create multiple copies of it on disk (DOMAIN.user.001, +DOMAIN.user.002, etc...). See the +<ulink url="smb.conf.5.html">smb.conf(5)</ulink> man page +for more details on this option. Also note that the +<command>nt acl support</command> parameter was formally a global parameter in +releases prior to Samba 2.2.2. +</para> + +<para> +The following is a minimal profile share: +</para> + +<para><programlisting> + [profile] + path = /export/profile + create mask = 0600 + directory mask = 0700 + nt acl support = no + read only = no +</programlisting></para> + +<para> +The reason for this bug is that the Win2k SP2 client copies +the security descriptor for the profile which contains +the Samba server's SID, and not the domain SID. The client +compares the SID for SAMBA\user and realizes it is +different that the one assigned to DOMAIN\user. Hence the reason +for the "access denied" message. +</para> + +<para> +By disabling the <command>nt acl support</command> parameter, Samba will send +the Win2k client a response to the QuerySecurityDescriptor +trans2 call which causes the client to set a default ACL +for the profile. This default ACL includes +</para> + +<para><command>DOMAIN\user "Full Control"</command></para> + +<note><para>This bug does not occur when using winbind to +create accounts on the Samba host for Domain users.</para></note> + +</sect1> + +<sect1> +<title>Windows NT 3.1</title> + +<para>If you have problems communicating across routers with Windows +NT 3.1 workstations, read <ulink url="http://support.microsoft.com/default.aspx?scid=kb;[LN];Q103765">this Microsoft Knowledge Base article</ulink>. + +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml b/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml new file mode 100644 index 0000000000..4b5179acc7 --- /dev/null +++ b/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml @@ -0,0 +1,389 @@ +<chapter id="pam"> +<chapterinfo> + &author.jht; + <pubdate> (Jun 21 2001) </pubdate> +</chapterinfo> + +<title>PAM Configuration for Centrally Managed Authentication</title> + +<sect1> +<title>Samba and PAM</title> + +<para> +A number of Unix systems (eg: Sun Solaris), as well as the +xxxxBSD family and Linux, now utilize the Pluggable Authentication +Modules (PAM) facility to provide all authentication, +authorization and resource control services. Prior to the +introduction of PAM, a decision to use an alternative to +the system password database (<filename>/etc/passwd</filename>) +would require the provision of alternatives for all programs that provide +security services. Such a choice would involve provision of +alternatives to such programs as: <command>login</command>, +<command>passwd</command>, <command>chown</command>, etc. +</para> + +<para> +PAM provides a mechanism that disconnects these security programs +from the underlying authentication/authorization infrastructure. +PAM is configured either through one file <filename>/etc/pam.conf</filename> (Solaris), +or by editing individual files that are located in <filename>/etc/pam.d</filename>. +</para> + +<note> + <para> + If the PAM authentication module (loadable link library file) is located in the + default location then it is not necessary to specify the path. In the case of + Linux, the default location is <filename>/lib/security</filename>. If the module + is located outside the default then the path must be specified as: + + <programlisting> + auth required /other_path/pam_strange_module.so + </programlisting> + </para> +</note> + +<para> +The following is an example <filename>/etc/pam.d/login</filename> configuration file. +This example had all options been uncommented is probably not usable +as it stacks many conditions before allowing successful completion +of the login process. Essentially all conditions can be disabled +by commenting them out except the calls to <filename>pam_pwdb.so</filename>. +</para> + +<para><programlisting> + #%PAM-1.0 + # The PAM configuration file for the `login' service + # + auth required pam_securetty.so + auth required pam_nologin.so + # auth required pam_dialup.so + # auth optional pam_mail.so + auth required pam_pwdb.so shadow md5 + # account requisite pam_time.so + account required pam_pwdb.so + session required pam_pwdb.so + # session optional pam_lastlog.so + # password required pam_cracklib.so retry=3 + password required pam_pwdb.so shadow md5 +</programlisting></para> + +<para> +PAM allows use of replacable modules. Those available on a +sample system include: +</para> + +<para><prompt>$</prompt><userinput>/bin/ls /lib/security</userinput> +<programlisting> + pam_access.so pam_ftp.so pam_limits.so + pam_ncp_auth.so pam_rhosts_auth.so pam_stress.so + pam_cracklib.so pam_group.so pam_listfile.so + pam_nologin.so pam_rootok.so pam_tally.so + pam_deny.so pam_issue.so pam_mail.so + pam_permit.so pam_securetty.so pam_time.so + pam_dialup.so pam_lastlog.so pam_mkhomedir.so + pam_pwdb.so pam_shells.so pam_unix.so + pam_env.so pam_ldap.so pam_motd.so + pam_radius.so pam_smbpass.so pam_unix_acct.so + pam_wheel.so pam_unix_auth.so pam_unix_passwd.so + pam_userdb.so pam_warn.so pam_unix_session.so +</programlisting></para> + +<para> +The following example for the login program replaces the use of +the <filename>pam_pwdb.so</filename> module which uses the system +password database (<filename>/etc/passwd</filename>, +<filename>/etc/shadow</filename>, <filename>/etc/group</filename>) with +the module <filename>pam_smbpass.so</filename> which uses the Samba +database which contains the Microsoft MD4 encrypted password +hashes. This database is stored in either +<filename>/usr/local/samba/private/smbpasswd</filename>, +<filename>/etc/samba/smbpasswd</filename>, or in +<filename>/etc/samba.d/smbpasswd</filename>, depending on the +Samba implementation for your Unix/Linux system. The +<filename>pam_smbpass.so</filename> module is provided by +Samba version 2.2.1 or later. It can be compiled by specifying the +<command>--with-pam_smbpass</command> options when running Samba's +<filename>configure</filename> script. For more information +on the <filename>pam_smbpass</filename> module, see the documentation +in the <filename>source/pam_smbpass</filename> directory of the Samba +source distribution. +</para> + +<para><programlisting> + #%PAM-1.0 + # The PAM configuration file for the `login' service + # + auth required pam_smbpass.so nodelay + account required pam_smbpass.so nodelay + session required pam_smbpass.so nodelay + password required pam_smbpass.so nodelay +</programlisting></para> + +<para> +The following is the PAM configuration file for a particular +Linux system. The default condition uses <filename>pam_pwdb.so</filename>. +</para> + +<para><programlisting> + #%PAM-1.0 + # The PAM configuration file for the `samba' service + # + auth required pam_pwdb.so nullok nodelay shadow audit + account required pam_pwdb.so audit nodelay + session required pam_pwdb.so nodelay + password required pam_pwdb.so shadow md5 +</programlisting></para> + +<para> +In the following example the decision has been made to use the +smbpasswd database even for basic samba authentication. Such a +decision could also be made for the passwd program and would +thus allow the smbpasswd passwords to be changed using the passwd +program. +</para> + +<para><programlisting> + #%PAM-1.0 + # The PAM configuration file for the `samba' service + # + auth required pam_smbpass.so nodelay + account required pam_pwdb.so audit nodelay + session required pam_pwdb.so nodelay + password required pam_smbpass.so nodelay smbconf=/etc/samba.d/smb.conf +</programlisting></para> + +<note><para>PAM allows stacking of authentication mechanisms. It is +also possible to pass information obtained within one PAM module through +to the next module in the PAM stack. Please refer to the documentation for +your particular system implementation for details regarding the specific +capabilities of PAM in this environment. Some Linux implmentations also +provide the <filename>pam_stack.so</filename> module that allows all +authentication to be configured in a single central file. The +<filename>pam_stack.so</filename> method has some very devoted followers +on the basis that it allows for easier administration. As with all issues in +life though, every decision makes trade-offs, so you may want examine the +PAM documentation for further helpful information. +</para></note> + +<sect2> +<title>PAM Configuration in smb.conf</title> + +<para> +There is an option in smb.conf called <ulink +url="smb.conf.5.html#OBEYPAMRESTRICTIONS">obey pam restrictions</ulink>. +The following is from the on-line help for this option in SWAT; +</para> + +<para> +When Samba is configured to enable PAM support (i.e. +<constant>--with-pam</constant>), this parameter will +control whether or not Samba should obey PAM's account +and session management directives. The default behavior +is to use PAM for clear text authentication only and to +ignore any account or session management. Note that Samba always +ignores PAM for authentication in the case of +<ulink url="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords = yes</ulink>. +The reason is that PAM modules cannot support the challenge/response +authentication mechanism needed in the presence of SMB +password encryption. +</para> + +<para>Default: <command>obey pam restrictions = no</command></para> + +</sect2> + +<sect2> +<title>Password Synchronisation using pam_smbpass.so</title> + +<para> +pam_smbpass is a PAM module which can be used on conforming systems to +keep the smbpasswd (Samba password) database in sync with the unix +password file. PAM (Pluggable Authentication Modules) is an API supported +under some Unices, such as Solaris, HPUX and Linux, that provides a +generic interface to authentication mechanisms. +</para> + +<para> +For more information on PAM, see http://ftp.kernel.org/pub/linux/libs/pam/ +</para> + +<para> +This module authenticates a local smbpasswd user database. If you require +support for authenticating against a remote SMB server, or if you're +concerned about the presence of suid root binaries on your system, it is +recommended that you use pam_winbind instead. +</para> + +<para><programlisting> +Options recognized by this module are as follows: + + debug - log more debugging info + audit - like debug, but also logs unknown usernames + use_first_pass - don't prompt the user for passwords; + take them from PAM_ items instead + try_first_pass - try to get the password from a previous + PAM module, fall back to prompting the user + use_authtok - like try_first_pass, but *fail* if the new + PAM_AUTHTOK has not been previously set. + (intended for stacking password modules only) + not_set_pass - don't make passwords used by this module + available to other modules. + nodelay - don't insert ~1 second delays on authentication + failure. + nullok - null passwords are allowed. + nonull - null passwords are not allowed. Used to + override the Samba configuration. + migrate - only meaningful in an "auth" context; + used to update smbpasswd file with a + password used for successful authentication. + smbconf=< file > - specify an alternate path to the smb.conf + file. +</programlisting></para> + +<para><programlisting> +Thanks go to the following people: + + * Andrew Morgan < morgan@transmeta.com >, for providing the Linux-PAM + framework, without which none of this would have happened + + * Christian Gafton < gafton@redhat.com > and Andrew Morgan again, for the + pam_pwdb module upon which pam_smbpass was originally based + + * Luke Leighton < lkcl@switchboard.net > for being receptive to the idea, + and for the occasional good-natured complaint about the project's status + that keep me working on it :) + + * and of course, all the other members of the Samba team + <http://www.samba.org/samba/team.html>, for creating a great product + and for giving this project a purpose + + --------------------- + Stephen Langasek < vorlon@netexpress.net > +</programlisting></para> + +<para> +The following are examples of the use of pam_smbpass.so in the format of Linux +<filename>/etc/pam.d/</filename> files structure. Those wishing to implement this +tool on other platforms will need to adapt this appropriately. +</para> + +<sect3> +<title>Password Synchonisation Configuration</title> + +<para> +A sample PAM configuration that shows the use of pam_smbpass to make +sure private/smbpasswd is kept in sync when /etc/passwd (/etc/shadow) +is changed. Useful when an expired password might be changed by an +application (such as ssh). +</para> + +<para><programlisting> + #%PAM-1.0 + # password-sync + # + auth requisite pam_nologin.so + auth required pam_unix.so + account required pam_unix.so + password requisite pam_cracklib.so retry=3 + password requisite pam_unix.so shadow md5 use_authtok try_first_pass + password required pam_smbpass.so nullok use_authtok try_first_pass + session required pam_unix.so +</programlisting></para> +</sect3> + +<sect3> +<title>Password Migration Configuration</title> + +<para> +A sample PAM configuration that shows the use of pam_smbpass to migrate +from plaintext to encrypted passwords for Samba. Unlike other methods, +this can be used for users who have never connected to Samba shares: +password migration takes place when users ftp in, login using ssh, pop +their mail, etc. +</para> + +<para><programlisting> + #%PAM-1.0 + # password-migration + # + auth requisite pam_nologin.so + # pam_smbpass is called IFF pam_unix succeeds. + auth requisite pam_unix.so + auth optional pam_smbpass.so migrate + account required pam_unix.so + password requisite pam_cracklib.so retry=3 + password requisite pam_unix.so shadow md5 use_authtok try_first_pass + password optional pam_smbpass.so nullok use_authtok try_first_pass + session required pam_unix.so +</programlisting></para> +</sect3> + +<sect3> +<title>Mature Password Configuration</title> + +<para> +A sample PAM configuration for a 'mature' smbpasswd installation. +private/smbpasswd is fully populated, and we consider it an error if +the smbpasswd doesn't exist or doesn't match the Unix password. +</para> + +<para><programlisting> + #%PAM-1.0 + # password-mature + # + auth requisite pam_nologin.so + auth required pam_unix.so + account required pam_unix.so + password requisite pam_cracklib.so retry=3 + password requisite pam_unix.so shadow md5 use_authtok try_first_pass + password required pam_smbpass.so use_authtok use_first_pass + session required pam_unix.so +</programlisting></para> +</sect3> + +<sect3> +<title>Kerberos Password Integration Configuration</title> + +<para> +A sample PAM configuration that shows pam_smbpass used together with +pam_krb5. This could be useful on a Samba PDC that is also a member of +a Kerberos realm. +</para> + +<para><programlisting> + #%PAM-1.0 + # kdc-pdc + # + auth requisite pam_nologin.so + auth requisite pam_krb5.so + auth optional pam_smbpass.so migrate + account required pam_krb5.so + password requisite pam_cracklib.so retry=3 + password optional pam_smbpass.so nullok use_authtok try_first_pass + password required pam_krb5.so use_authtok try_first_pass + session required pam_krb5.so +</programlisting></para> +</sect3> + +</sect2> +</sect1> + +<sect1> +<title>Distributed Authentication</title> + +<para> +The astute administrator will realize from this that the +combination of <filename>pam_smbpass.so</filename>, +<command>winbindd</command>, and a distributed +passdb backend, such as ldap, will allow the establishment of a +centrally managed, distributed +user/password database that can also be used by all +PAM (eg: Linux) aware programs and applications. This arrangement +can have particularly potent advantages compared with the +use of Microsoft Active Directory Service (ADS) in so far as +reduction of wide area network authentication traffic. +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/PolicyMgmt.xml b/docs/docbook/projdoc/PolicyMgmt.xml new file mode 100644 index 0000000000..2ae3fa5ea7 --- /dev/null +++ b/docs/docbook/projdoc/PolicyMgmt.xml @@ -0,0 +1,384 @@ +<chapter id="PolicyMgmt"> +<chapterinfo> + &author.jht; + <pubdate>April 3 2003</pubdate> +</chapterinfo> +<title>System and Account Policies</title> + +<sect1> +<title>Creating and Managing System Policies</title> + +<para> +Under MS Windows platforms, particularly those following the release of MS Windows +NT4 and MS Windows 95) it is possible to create a type of file that would be placed +in the NETLOGON share of a domain controller. As the client logs onto the network +this file is read and the contents initiate changes to the registry of the client +machine. This file allows changes to be made to those parts of the registry that +affect users, groups of users, or machines. +</para> + +<para> +For MS Windows 9x/Me this file must be called <filename>Config.POL</filename> and may +be generated using a tool called <filename>poledit.exe</filename>, better known as the +Policy Editor. The policy editor was provided on the Windows 98 installation CD, but +dissappeared again with the introduction of MS Windows Me (Millenium Edition). From +comments from MS Windows network administrators it would appear that this tool became +a part of the MS Windows Me Resource Kit. +</para> + +<para> +MS Windows NT4 Server products include the <emphasis>System Policy Editor</emphasis> +under the <filename>Start -> Programs -> Administrative Tools</filename> menu item. +For MS Windows NT4 and later clients this file must be called <filename>NTConfig.POL</filename>. +</para> + +<para> +New with the introduction of MS Windows 2000 was the Microsoft Management Console +or MMC. This tool is the new wave in the ever changing landscape of Microsoft +methods for management of network access and security. Every new Microsoft product +or technology seems to obsolete the old rules and to introduce newer and more +complex tools and methods. To Microsoft's credit though, the MMC does appear to +be a step forward, but improved functionality comes at a great price. +</para> + +<para> +Before embarking on the configuration of network and system policies it is highly +advisable to read the documentation available from Microsoft's web site regarding +<ulink url="http://www.microsoft.com/ntserver/management/deployment/planguide/prof_policies.asp"> +Implementing Profiles and Policies in Windows NT 4.0 from http://www.microsoft.com/ntserver/management/deployment/planguide/prof_policies.asp</ulink> available from Microsoft. +There are a large number of documents in addition to this old one that should also +be read and understood. Try searching on the Microsoft web site for "Group Policies". +</para> + +<para> +What follows is a very brief discussion with some helpful notes. The information provided +here is incomplete - you are warned. +</para> + +<sect2> +<title>Windows 9x/Me Policies</title> + +<para> +You need the Win98 Group Policy Editor to set Group Profiles up under Windows 9x/Me. +It can be found on the Original full product Win98 installation CD under +<filename>tools/reskit/netadmin/poledit</filename>. Install this using the +Add/Remove Programs facility and then click on the 'Have Disk' tab. +</para> + +<para> +Use the Group Policy Editor to create a policy file that specifies the location of +user profiles and/or the <filename>My Documents</filename> etc. stuff. Then +save these settings in a file called <filename>Config.POL</filename> that needs to +be placed in the root of the [NETLOGON] share. If Win98 is configured to log onto +the Samba Domain, it will automatically read this file and update the Win9x/Me registry +of the machine as it logs on. +</para> + +<para> +Further details are covered in the Win98 Resource Kit documentation. +</para> + +<para> +If you do not take the right steps, then every so often Win9x/Me will check the +integrity of the registry and will restore it's settings from the back-up +copy of the registry it stores on each Win9x/Me machine. Hence, you will +occasionally notice things changing back to the original settings. +</para> + +<para> +Install the group policy handler for Win9x to pick up group policies. Look on the +Win98 CD in <filename>\tools\reskit\netadmin\poledit</filename>. +Install group policies on a Win9x client by double-clicking +<filename>grouppol.inf</filename>. Log off and on again a couple of times and see +if Win98 picks up group policies. Unfortunately this needs to be done on every +Win9x/Me machine that uses group policies. +</para> + +</sect2> +<sect2> +<title>Windows NT4 Style Policy Files</title> + +<para> +To create or edit <filename>ntconfig.pol</filename> you must use the NT Server +Policy Editor, <command>poledit.exe</command> which is included with NT4 Server +but <emphasis>not NT Workstation</emphasis>. There is a Policy Editor on a NT4 +Workstation but it is not suitable for creating <emphasis>Domain Policies</emphasis>. +Further, although the Windows 95 Policy Editor can be installed on an NT4 +Workstation/Server, it will not work with NT clients. However, the files from +the NT Server will run happily enough on an NT4 Workstation. +</para> + +<para> +You need <filename>poledit.exe, common.adm</filename> and <filename>winnt.adm</filename>. +It is convenient to put the two *.adm files in the <filename>c:\winnt\inf</filename> +directory which is where the binary will look for them unless told otherwise. Note also that that +directory is normally 'hidden'. +</para> + +<para> +The Windows NT policy editor is also included with the Service Pack 3 (and +later) for Windows NT 4.0. Extract the files using <command>servicepackname /x</command>, +i.e. that's <command>Nt4sp6ai.exe /x</command> for service pack 6a. The policy editor, +<command>poledit.exe</command> and the associated template files (*.adm) should +be extracted as well. It is also possible to downloaded the policy template +files for Office97 and get a copy of the policy editor. Another possible +location is with the Zero Administration Kit available for download from Microsoft. +</para> + +<sect3> +<title>Registry Tattoos</title> + + <para> + With NT4 style registry based policy changes, a large number of settings are not + automatically reversed as the user logs off. Since the settings that were in the + NTConfig.POL file were applied to the client machine registry and that apply to the + hive key HKEY_LOCAL_MACHINE are permanent until explicitly reversed. This is known + as tattooing. It can have serious consequences down-stream and the administrator must + be extremely careful not to lock out the ability to manage the machine at a later date. + </para> + + +</sect3> +</sect2> +<sect2> +<title>MS Windows 200x / XP Professional Policies</title> + +<para> +Windows NT4 System policies allows setting of registry parameters specific to +users, groups and computers (client workstations) that are members of the NT4 +style domain. Such policy file will work with MS Windows 2000 / XP clients also. +</para> + +<para> +New to MS Windows 2000 Microsoft introduced a new style of group policy that confers +a superset of capabilities compared with NT4 style policies. Obviously, the tool used +to create them is different, and the mechanism for implementing them is much changed. +</para> + +<para> +The older NT4 style registry based policies are known as <emphasis>Administrative Templates</emphasis> +in MS Windows 2000/XP Group Policy Objects (GPOs). The later includes ability to set various security +configurations, enforce Internet Explorer browser settings, change and redirect aspects of the +users' desktop (including: the location of <emphasis>My Documents</emphasis> files (directory), as +well as intrinsics of where menu items will appear in the Start menu). An additional new +feature is the ability to make available particular software Windows applications to particular +users and/or groups. +</para> + +<para> +Remember: NT4 policy files are named <filename>NTConfig.POL</filename> and are stored in the root +of the NETLOGON share on the domain controllers. A Windows NT4 user enters a username, a password +and selects the domain name to which the logon will attempt to take place. During the logon +process the client machine reads the NTConfig.POL file from the NETLOGON share on the authenticating +server, modifies the local registry values according to the settings in this file. +</para> + +<para> +Windows 2K GPOs are very feature rich. They are NOT stored in the NETLOGON share, rather part of +a Windows 200x policy file is stored in the Active Directory itself and the other part is stored +in a shared (and replicated) volume called the SYSVOL folder. This folder is present on all Active +Directory domain controllers. The part that is stored in the Active Directory itself is called the +group policy container (GPC), and the part that is stored in the replicated share called SYSVOL is +known as the group policy template (GPT). +</para> + +<para> +With NT4 clients the policy file is read and executed upon only as each user logs onto the network. +MS Windows 200x policies are much more complex - GPOs are processed and applied at client machine +startup (machine specific part) and when the user logs onto the network the user specific part +is applied. In MS Windows 200x style policy management each machine and/or user may be subject +to any number of concurently applicable (and applied) policy sets (GPOs). Active Directory allows +the administrator to also set filters over the policy settings. No such equivalent capability +exists with NT4 style policy files. +</para> + +<sect3> +<title>Administration of Win2K / XP Policies</title> + +<title>Instructions</title> +<para> +Instead of using the tool called "The System Policy Editor", commonly called Poledit (from the +executable name poledit.exe), GPOs are created and managed using a Microsoft Management Console +(MMC) snap-in as follows:</para> +<procedure> +<step> +<para> +Go to the Windows 200x / XP menu <filename>Start->Programs->Administrative Tools</filename> + and select the MMC snap-in called "Active Directory Users and Computers" +</para> +</step> + +<step><para> +Select the domain or organizational unit (OU) that you wish to manage, then right click +to open the context menu for that object, select the properties item. +</para></step> + +<step><para> +Now left click on the Group Policy tab, then left click on the New tab. Type a name +for the new policy you will create. +</para></step> + +<step><para> +Now left click on the Edit tab to commence the steps needed to create the GPO. +</para></step> +</procedure> + +<para> +All policy configuration options are controlled through the use of policy administrative +templates. These files have a .adm extension, both in NT4 as well as in Windows 200x / XP. +Beware however, since the .adm files are NOT interchangible across NT4 and Windows 200x. +The later introduces many new features as well as extended definition capabilities. It is +well beyond the scope of this documentation to explain how to program .adm files, for that +the adminsitrator is referred to the Microsoft Windows Resource Kit for your particular +version of MS Windows. +</para> + +<note> +<para> +The MS Windows 2000 Resource Kit contains a tool called gpolmig.exe. This tool can be used +to migrate an NT4 NTConfig.POL file into a Windows 200x style GPO. Be VERY careful how you +use this powerful tool. Please refer to the resource kit manuals for specific usage information. +</para> +</note> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>Managing Account/User Policies</title> + +<para> +Policies can define a specific user's settings or the settings for a group of users. The resulting +policy file contains the registry settings for all users, groups, and computers that will be using +the policy file. Separate policy files for each user, group, or computer are not not necessary. +</para> + +<para> +If you create a policy that will be automatically downloaded from validating domain controllers, +you should name the file NTconfig.POL. As system administrator, you have the option of renaming the +policy file and, by modifying the Windows NT-based workstation, directing the computer to update +the policy from a manual path. You can do this by either manually changing the registry or by using +the System Policy Editor. This path can even be a local path such that each machine has its own policy file, +but if a change is necessary to all machines, this change must be made individually to each workstation. +</para> + +<para> +When a Windows NT4/200x/XP machine logs onto the network the NETLOGON share on the authenticating domain +controller for the presence of the NTConfig.POL file. If one exists it is downloaded, parsed and then +applied to the user's part of the registry. +</para> + +<para> +MS Windows 200x/XP clients that log onto an MS Windows Active Directory security domain may additionally, +acquire policy settings through Group Policy Objects (GPOs) that are defined and stored in Active Directory +itself. The key benefit of using AS GPOs is that they impose no registry <emphasis>tatooing</emphasis> effect. +This has considerable advanage compared with the use of NTConfig.POL (NT4) style policy updates. +</para> + +<para> +In addition to user access controls that may be imposed or applied via system and/or group policies +in a manner that works in conjunction with user profiles, the user management environment under +MS Windows NT4/200x/XP allows per domain as well as per user account restrictions to be applied. +Common restrictions that are frequently used includes: +</para> + +<para> +<simplelist> + <member>Logon Hours</member> + <member>Password Aging</member> + <member>Permitted Logon from certain machines only</member> + <member>Account type (Local or Global)</member> + <member>User Rights</member> +</simplelist> +</para> + +<sect2> +<title>With Windows NT4/200x</title> + +<para> +The tools that may be used to configure these types of controls from the MS Windows environment are: +The NT4 User Manager for domains, the NT4 System and Group Policy Editor, the registry editor (regedt32.exe). +Under MS Windows 200x/XP this is done using the Microsoft Managment Console (MMC) with approapriate +"snap-ins", the registry editor, and potentially also the NT4 System and Group Policy Editor. +</para> +</sect2> + +<sect2> +<title>With a Samba PDC</title> + +<para> +With a Samba Domain Controller, the new tools for managing of user account and policy information includes: +<filename>smbpasswd, pdbedit, net, rpcclient.</filename>. The administrator should read the +man pages for these tools and become familiar with their use. +</para> + +</sect2> +</sect1> + +<sect1> +<title>System Startup and Logon Processing Overview</title> + +<para> +The following attempts to document the order of processing of system and user policies following a system +reboot and as part of the user logon: +</para> + +<orderedlist> + <listitem><para> + Network starts, then Remote Procedure Call System Service (RPCSS) and Multiple Universal Naming + Convention Provider (MUP) start + </para></listitem> + + <listitem><para> + Where Active Directory is involved, an ordered list of Group Policy Objects (GPOs) is downloaded + and applied. The list may include GPOs that: +<simplelist> + <member>Apply to the location of machines in a Directory</member> + <member>Apply only when settings have changed</member> + <member>Depend on configuration of scope of applicability: local, site, domain, organizational unit, etc.</member> +</simplelist> + No desktop user interface is presented until the above have been processed. + </para></listitem> + + <listitem><para> + Execution of start-up scripts (hidden and synchronous by defaut). + </para></listitem> + + <listitem><para> + A keyboard action to affect start of logon (Ctrl-Alt-Del). + </para></listitem> + + <listitem><para> + User credentials are validated, User profile is loaded (depends on policy settings). + </para></listitem> + + <listitem><para> + An ordered list of User GPOs is obtained. The list contents depends on what is configured in respsect of: + +<simplelist> + <member>Is user a domain member, thus subject to particular policies</member> + <member>Loopback enablement, and the state of the loopback policy (Merge or Replace)</member> + <member>Location of the Active Directory itself</member> + <member>Has the list of GPOs changed. No processing is needed if not changed.</member> +</simplelist> + </para></listitem> + + <listitem><para> + User Policies are applied from Active Directory. Note: There are several types. + </para></listitem> + + <listitem><para> + Logon scripts are run. New to Win2K and Active Directory, logon scripts may be obtained based on Group + Policy objects (hidden and executed synchronously). NT4 style logon scripts are then run in a normal + window. + </para></listitem> + + <listitem><para> + The User Interface as determined from the GPOs is presented. Note: In a Samba domain (like and NT4 + Domain) machine (system) policies are applied at start-up, User policies are applied at logon. + </para></listitem> +</orderedlist> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Portability.xml b/docs/docbook/projdoc/Portability.xml new file mode 100644 index 0000000000..72c3d20547 --- /dev/null +++ b/docs/docbook/projdoc/Portability.xml @@ -0,0 +1,235 @@ +<chapter id="Portability"> +<chapterinfo> + &author.jelmer; +</chapterinfo> + +<title>Portability</title> + +<para>Samba works on a wide range of platforms but the interface all the +platforms provide is not always compatible. This chapter contains +platform-specific information about compiling and using samba.</para> + +<sect1> +<title>HPUX</title> + +<para> +HP's implementation of supplementary groups is, er, non-standard (for +hysterical reasons). There are two group files, /etc/group and +/etc/logingroup; the system maps UIDs to numbers using the former, but +initgroups() reads the latter. Most system admins who know the ropes +symlink /etc/group to /etc/logingroup (hard link doesn't work for reasons +too stupid to go into here). initgroups() will complain if one of the +groups you're in in /etc/logingroup has what it considers to be an invalid +ID, which means outside the range [0..UID_MAX], where UID_MAX is (I think) +60000 currently on HP-UX. This precludes -2 and 65534, the usual 'nobody' +GIDs. +</para> + +<para> +If you encounter this problem, make sure that the programs that are failing +to initgroups() be run as users not in any groups with GIDs outside the +allowed range. +</para> + +<para>This is documented in the HP manual pages under setgroups(2) and passwd(4). +</para> + +<para> +On HPUX you must use gcc or the HP Ansi compiler. The free compiler +that comes with HP-UX is not Ansi compliant and cannot compile +Samba. +</para> + +</sect1> + +<sect1> +<title>SCO Unix</title> + +<para> +If you run an old version of SCO Unix then you may need to get important +TCP/IP patches for Samba to work correctly. Without the patch, you may +encounter corrupt data transfers using samba. +</para> + +<para> +The patch you need is UOD385 Connection Drivers SLS. It is available from +SCO (ftp.sco.com, directory SLS, files uod385a.Z and uod385a.ltr.Z). +</para> + +</sect1> + +<sect1> +<title>DNIX</title> + +<para> +DNIX has a problem with seteuid() and setegid(). These routines are +needed for Samba to work correctly, but they were left out of the DNIX +C library for some reason. +</para> + +<para> +For this reason Samba by default defines the macro NO_EID in the DNIX +section of includes.h. This works around the problem in a limited way, +but it is far from ideal, some things still won't work right. +</para> + +<para> +To fix the problem properly you need to assemble the following two +functions and then either add them to your C library or link them into +Samba. +</para> + +<para> +put this in the file <filename>setegid.s</filename>: +</para> + +<para><programlisting> + .globl _setegid +_setegid: + moveq #47,d0 + movl #100,a0 + moveq #1,d1 + movl 4(sp),a1 + trap #9 + bccs 1$ + jmp cerror +1$: + clrl d0 + rts +</programlisting></para> + +<para> +put this in the file <filename>seteuid.s</filename>: +</para> + +<para><programlisting> + .globl _seteuid +_seteuid: + moveq #47,d0 + movl #100,a0 + moveq #0,d1 + movl 4(sp),a1 + trap #9 + bccs 1$ + jmp cerror +1$: + clrl d0 + rts +</programlisting></para> + +<para> +after creating the above files you then assemble them using +</para> + +<para><command>as seteuid.s</command></para> +<para><command>as setegid.s</command></para> + +<para> +that should produce the files <filename>seteuid.o</filename> and +<filename>setegid.o</filename> +</para> + +<para> +then you need to add these to the LIBSM line in the DNIX section of +the Samba Makefile. Your LIBSM line will then look something like this: +</para> + +<para><programlisting> +LIBSM = setegid.o seteuid.o -ln +</programlisting></para> + +<para> +You should then remove the line: +</para> + +<para><programlisting> +#define NO_EID +</programlisting></para> + +<para>from the DNIX section of <filename>includes.h</filename></para> + +</sect1> + +<sect1> +<title>RedHat Linux Rembrandt-II</title> + +<para> +By default RedHat Rembrandt-II during installation adds an +entry to /etc/hosts as follows: +<programlisting> + 127.0.0.1 loopback "hostname"."domainname" +</programlisting> +</para> + +<para> +This causes Samba to loop back onto the loopback interface. +The result is that Samba fails to communicate correctly with +the world and therefor may fail to correctly negotiate who +is the master browse list holder and who is the master browser. +</para> + +<para> +Corrective Action: Delete the entry after the word loopback + in the line starting 127.0.0.1 +</para> +</sect1> + +<sect1> +<title>AIX</title> +<sect2> +<title>Sequential Read Ahead</title> +<!-- From an email by William Jojo <jojowil@hvcc.edu> --> +<para> +Disabling Sequential Read Ahead using <userinput>vmtune -r 0</userinput> improves +samba performance significally. +</para> +</sect2> +</sect1> + +<sect1> +<title>Solaris</title> + +<sect2> +<title>Locking improvements</title> + +<para>Some people have been experiencing problems with F_SETLKW64/fcntl +when running samba on solaris. The built in file locking mechanism was +not scalable. Performance would degrade to the point where processes would +get into loops of trying to lock a file. It woul try a lock, then fail, +then try again. The lock attempt was failing before the grant was +occurring. So the visible manifestation of this would be a handful of +processes stealing all of the CPU, and when they were trussed they would +be stuck if F_SETLKW64 loops. +</para> + +<para> +Sun released patches for Solaris 2.6, 8, and 9. The patch for Solaris 7 +has not been released yet. +</para> + +<para> +The patch revision for 2.6 is 105181-34 +for 8 is 108528-19 +and for 9 is 112233-04 +</para> + +<para> +After the install of these patches it is recommended to reconfigure +and rebuild samba. +</para> + +<para>Thanks to Joe Meslovich for reporting</para> + +</sect2> + +<sect2 id="winbind-solaris9"> +<title>Winbind on Solaris 9</title> +<para> +Nsswitch on Solaris 9 refuses to use the winbind nss module. This behavior +is fixed by Sun in patch 113476-05 which as of March 2003 is not in any +roll-up packages. +</para> +</sect2> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/Problems.xml b/docs/docbook/projdoc/Problems.xml new file mode 100644 index 0000000000..eb43b63b63 --- /dev/null +++ b/docs/docbook/projdoc/Problems.xml @@ -0,0 +1,276 @@ +<chapter id="problems"> + +<chapterinfo> + &author.jerry; + &author.jelmer; + <author> + <firstname>David</firstname><surname>Bannon</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>dbannon@samba.org</email></address> + </affiliation> + </author> + <pubdate>8 Apr 2003</pubdate> +</chapterinfo> + +<title>Analysing and solving samba problems</title> + +<para> +There are many sources of information available in the form +of mailing lists, RFC's and documentation. The docs that come +with the samba distribution contain very good explanations of +general SMB topics such as browsing.</para> + +<sect1> +<title>Diagnostics tools</title> + + <para> +One of the best diagnostic tools for debugging problems is Samba itself. +You can use the -d option for both smbd and nmbd to specify what +'debug level' at which to run. See the man pages on smbd, nmbd and +smb.conf for more information on debugging options. The debug +level can range from 1 (the default) to 10 (100 for debugging passwords). +</para> + +<para> +Another helpful method of debugging is to compile samba using the +<command>gcc -g </command> flag. This will include debug +information in the binaries and allow you to attach gdb to the +running smbd / nmbd process. In order to attach gdb to an smbd +process for an NT workstation, first get the workstation to make the +connection. Pressing ctrl-alt-delete and going down to the domain box +is sufficient (at least, on the first time you join the domain) to +generate a 'LsaEnumTrustedDomains'. Thereafter, the workstation +maintains an open connection, and therefore there will be an smbd +process running (assuming that you haven't set a really short smbd +idle timeout) So, in between pressing ctrl alt delete, and actually +typing in your password, you can attach gdb and continue. +</para> + +<para> +Some useful samba commands worth investigating: +</para> + +<itemizedlist> + <listitem><para>testparam | more</para></listitem> + <listitem><para>smbclient -L //{netbios name of server}</para></listitem> +</itemizedlist> + +<para> +An SMB enabled version of tcpdump is available from +<ulink url="http://www.tcpdump.org/">http://www.tcpdup.org/</ulink>. +Ethereal, another good packet sniffer for Unix and Win32 +hosts, can be downloaded from <ulink +url="http://www.ethereal.com/">http://www.ethereal.com</ulink>. +</para> + +<para> +For tracing things on the Microsoft Windows NT, Network Monitor +(aka. netmon) is available on the Microsoft Developer Network CD's, +the Windows NT Server install CD and the SMS CD's. The version of +netmon that ships with SMS allows for dumping packets between any two +computers (i.e. placing the network interface in promiscuous mode). +The version on the NT Server install CD will only allow monitoring +of network traffic directed to the local NT box and broadcasts on the +local subnet. Be aware that Ethereal can read and write netmon +formatted files. +</para> + +</sect1> + +<sect1> +<title>Installing 'Network Monitor' on an NT Workstation or a Windows 9x box</title> + +<para> +Installing netmon on an NT workstation requires a couple +of steps. The following are for installing Netmon V4.00.349, which comes +with Microsoft Windows NT Server 4.0, on Microsoft Windows NT +Workstation 4.0. The process should be similar for other versions of +Windows NT / Netmon. You will need both the Microsoft Windows +NT Server 4.0 Install CD and the Workstation 4.0 Install CD. +</para> + +<para> +Initially you will need to install 'Network Monitor Tools and Agent' +on the NT Server. To do this +</para> + +<itemizedlist> + <listitem><para>Goto Start - Settings - Control Panel - + Network - Services - Add </para></listitem> + + <listitem><para>Select the 'Network Monitor Tools and Agent' and + click on 'OK'.</para></listitem> + + <listitem><para>Click 'OK' on the Network Control Panel. + </para></listitem> + + <listitem><para>Insert the Windows NT Server 4.0 install CD + when prompted.</para></listitem> +</itemizedlist> + +<para> +At this point the Netmon files should exist in +<filename>%SYSTEMROOT%\System32\netmon\*.*</filename>. +Two subdirectories exist as well, <filename>parsers\</filename> +which contains the necessary DLL's for parsing the netmon packet +dump, and <filename>captures\</filename>. +</para> + +<para> +In order to install the Netmon tools on an NT Workstation, you will +first need to install the 'Network Monitor Agent' from the Workstation +install CD. +</para> + +<itemizedlist> + <listitem><para>Goto Start - Settings - Control Panel - + Network - Services - Add</para></listitem> + + <listitem><para>Select the 'Network Monitor Agent' and click + on 'OK'.</para></listitem> + + <listitem><para>Click 'OK' on the Network Control Panel. + </para></listitem> + + <listitem><para>Insert the Windows NT Workstation 4.0 install + CD when prompted.</para></listitem> +</itemizedlist> + +<para> +Now copy the files from the NT Server in %SYSTEMROOT%\System32\netmon\*.* +to %SYSTEMROOT%\System32\netmon\*.* on the Workstation and set +permissions as you deem appropriate for your site. You will need +administrative rights on the NT box to run netmon. +</para> + +<para> +To install Netmon on a Windows 9x box install the network monitor agent +from the Windows 9x CD (\admin\nettools\netmon). There is a readme +file located with the netmon driver files on the CD if you need +information on how to do this. Copy the files from a working +Netmon installation. +</para> + +</sect1> + +<sect1> +<title>Useful URL's</title> +<itemizedlist> + +<listitem><para>Home of Samba site <ulink url="http://samba.org"> + http://samba.org</ulink>. We have a mirror near you !</para></listitem> + +<listitem><para> The <emphasis>Development</emphasis> document +on the Samba mirrors might mention your problem. If so, +it might mean that the developers are working on it.</para></listitem> + +<listitem><para>See how Scott Merrill simulates a BDC behavior at + <ulink url="http://www.skippy.net/linux/smb-howto.html"> + http://www.skippy.net/linux/smb-howto.html</ulink>. </para></listitem> + +<listitem><para>Although 2.0.7 has almost had its day as a PDC, David Bannon will + keep the 2.0.7 PDC pages at <ulink url="http://bioserve.latrobe.edu.au/samba"> + http://bioserve.latrobe.edu.au/samba</ulink> going for a while yet.</para></listitem> + +<listitem><para>Misc links to CIFS information + <ulink url="http://samba.org/cifs/">http://samba.org/cifs/</ulink></para></listitem> + +<listitem><para>NT Domains for Unix <ulink url="http://mailhost.cb1.com/~lkcl/ntdom/"> + http://mailhost.cb1.com/~lkcl/ntdom/</ulink></para></listitem> + +<listitem><para>FTP site for older SMB specs: + <ulink url="ftp://ftp.microsoft.com/developr/drg/CIFS/"> + ftp://ftp.microsoft.com/developr/drg/CIFS/</ulink></para></listitem> + +</itemizedlist> + +</sect1> + +<sect1> +<title>Getting help from the mailing lists</title> + +<para> +There are a number of Samba related mailing lists. Go to <ulink +url="http://samba.org">http://samba.org</ulink>, click on your nearest mirror +and then click on <command>Support</command> and then click on <command> +Samba related mailing lists</command>. +</para> + +<para> +For questions relating to Samba TNG go to +<ulink url="http://www.samba-tng.org/">http://www.samba-tng.org/</ulink> +It has been requested that you don't post questions about Samba-TNG to the +main stream Samba lists.</para> + +<para> +If you post a message to one of the lists please observe the following guide lines : +</para> + +<itemizedlist> + +<listitem><para> Always remember that the developers are volunteers, they are +not paid and they never guarantee to produce a particular feature at +a particular time. Any time lines are 'best guess' and nothing more. +</para></listitem> + +<listitem><para> Always mention what version of samba you are using and what +operating system its running under. You should probably list the +relevant sections of your &smb.conf; file, at least the options +in [global] that affect PDC support.</para></listitem> + +<listitem><para>In addition to the version, if you obtained Samba via +CVS mention the date when you last checked it out.</para></listitem> + +<listitem><para> Try and make your question clear and brief, lots of long, +convoluted questions get deleted before they are completely read ! +Don't post html encoded messages (if you can select colour or font +size its html).</para></listitem> + +<listitem><para> If you run one of those nifty 'I'm on holidays' things when +you are away, make sure its configured to not answer mailing lists. +</para></listitem> + +<listitem><para> Don't cross post. Work out which is the best list to post to +and see what happens, i.e. don't post to both samba-ntdom and samba-technical. +Many people active on the lists subscribe to more +than one list and get annoyed to see the same message two or more times. +Often someone will see a message and thinking it would be better dealt +with on another, will forward it on for you.</para></listitem> + +<listitem><para>You might include <emphasis>partial</emphasis> +log files written at a debug level set to as much as 20. +Please don't send the entire log but enough to give the context of the +error messages.</para></listitem> + +<listitem><para>(Possibly) If you have a complete netmon trace ( from the opening of +the pipe to the error ) you can send the *.CAP file as well.</para></listitem> + +<listitem><para>Please think carefully before attaching a document to an email. +Consider pasting the relevant parts into the body of the message. The samba +mailing lists go to a huge number of people, do they all need a copy of your +smb.conf in their attach directory?</para></listitem> + +</itemizedlist> + +</sect1> + +<sect1> +<title>How to get off the mailinglists</title> + +<para>To have your name removed from a samba mailing list, go to the +same place you went to to get on it. Go to <ulink +url="http://lists.samba.org/">http://lists.samba.org</ulink>, +click on your nearest mirror and then click on <command>Support</command> and +then click on <command> Samba related mailing lists</command>. Or perhaps see +<ulink url="http://lists.samba.org/mailman/roster/samba-ntdom">here</ulink> +</para> + +<para> +Please don't post messages to the list asking to be removed, you will just +be referred to the above address (unless that process failed in some way...) +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/ProfileMgmt.xml b/docs/docbook/projdoc/ProfileMgmt.xml new file mode 100644 index 0000000000..82897808b2 --- /dev/null +++ b/docs/docbook/projdoc/ProfileMgmt.xml @@ -0,0 +1,1126 @@ +<chapter id="ProfileMgmt"> +<chapterinfo> + &author.jht; + <pubdate>April 3 2003</pubdate> +</chapterinfo> + +<title>Desktop Profile Management</title> + +<sect1> +<title>Roaming Profiles</title> + +<warning> +<para> +Roaming profiles support is different for Win9x / Me and Windows NT4/200x. +</para> +</warning> + +<para> +Before discussing how to configure roaming profiles, it is useful to see how +Windows 9x / Me and Windows NT4/200x clients implement these features. +</para> + +<para> +Windows 9x / Me clients send a NetUserGetInfo request to the server to get the user's +profiles location. However, the response does not have room for a separate +profiles location field, only the user's home share. This means that Win9X/Me +profiles are restricted to being stored in the user's home directory. +</para> + + +<para> +Windows NT4/200x clients send a NetSAMLogon RPC request, which contains many fields, +including a separate field for the location of the user's profiles. +</para> + +<sect2> +<title>Samba Configuration for Profile Handling</title> + +<para> +This section documents how to configure Samba for MS Windows client profile support. +</para> + +<sect3> +<title>NT4/200x User Profiles</title> + +<para> +To support Windowns NT4/200x clients, in the [global] section of smb.conf set the +following (for example): +</para> + +<para> +<programlisting> + logon path = \\profileserver\profileshare\profilepath\%U\moreprofilepath +</programlisting> + + This is typically implemented like: + +<programlisting> + logon path = \\%L\Profiles\%u +</programlisting> +where %L translates to the name of the Samba server and %u translates to the user name +</para> + +<para> +The default for this option is \\%N\%U\profile, namely \\sambaserver\username\profile. +The \\N%\%U service is created automatically by the [homes] service. If you are using +a samba server for the profiles, you _must_ make the share specified in the logon path +browseable. Please refer to the man page for smb.conf in respect of the different +symantics of %L and %N, as well as %U and %u. +</para> + +<note> +<para> +MS Windows NT/2K clients at times do not disconnect a connection to a server +between logons. It is recommended to NOT use the <command>homes</command> +meta-service name as part of the profile share path. +</para> +</note> +</sect3> + +<sect3> +<title>Windows 9x / Me User Profiles</title> + +<para> +To support Windows 9x / Me clients, you must use the "logon home" parameter. Samba has +now been fixed so that <userinput>net use /home</userinput> now works as well, and it, too, relies +on the <command>logon home</command> parameter. +</para> + +<para> +By using the logon home parameter, you are restricted to putting Win9x / Me +profiles in the user's home directory. But wait! There is a trick you +can use. If you set the following in the <command>[global]</command> section of your &smb.conf; file: +</para> +<para><programlisting> + logon home = \\%L\%U\.profiles +</programlisting></para> + +<para> +then your Windows 9x / Me clients will dutifully put their clients in a subdirectory +of your home directory called <filename>.profiles</filename> (thus making them hidden). +</para> + +<para> +Not only that, but <userinput>net use /home</userinput> will also work, because of a feature in +Windows 9x / Me. It removes any directory stuff off the end of the home directory area +and only uses the server and share portion. That is, it looks like you +specified \\%L\%U for <command>logon home</command>. +</para> +</sect3> + +<sect3> +<title>Mixed Windows 9x / Me and Windows NT4/200x User Profiles</title> + +<para> +You can support profiles for both Win9X and WinNT clients by setting both the +<command>logon home</command> and <command>logon path</command> parameters. For example: +</para> + +<para><programlisting> + logon home = \\%L\%u\.profiles + logon path = \\%L\profiles\%u +</programlisting></para> + +</sect3> +<sect3> +<title>Disabling Roaming Profile Support</title> + +<para> +A question often asked is "How may I enforce use of local profiles?" or +"How do I disable Roaming Profiles?" +</para> + +<para> +There are three ways of doing this: +</para> + +<itemizedlist> + <listitem><para> + <command>In smb.conf:</command> affect the following settings and ALL clients + will be forced to use a local profile: + <programlisting> + logon home = + logon path = + </programlisting></para></listitem> + + <listitem><para> + <command>MS Windows Registry:</command> by using the Microsoft Management Console + gpedit.msc to instruct your MS Windows XP machine to use only a local profile. This + of course modifies registry settings. The full path to the option is: + <programlisting> + Local Computer Policy\ + Computer Configuration\ + Administrative Templates\ + System\ + User Profiles\ + + Disable: Only Allow Local User Profiles + Disable: Prevent Roaming Profile Change from Propogating to the Server + </programlisting> + </para> + </listitem> + + <listitem><para> + <command>Change of Profile Type:</command> From the start menu right click on the + MY Computer icon, select <emphasis>Properties</emphasis>, click on the "<emphasis>User Profiles</emphasis> + tab, select the profile you wish to change from Roaming type to Local, click <emphasis>Change Type</emphasis>. + </para></listitem> +</itemizedlist> + +<para> +Consult the MS Windows registry guide for your particular MS Windows version for more +information about which registry keys to change to enforce use of only local user +profiles. +</para> + +<note><para> +The specifics of how to convert a local profile to a roaming profile, or a roaming profile +to a local one vary according to the version of MS Windows you are running. Consult the +Microsoft MS Windows Resource Kit for your version of Windows for specific information. +</para></note> + +</sect3> +</sect2> + +<sect2> +<title>Windows Client Profile Configuration Information</title> + +<sect3> +<title>Windows 9x / Me Profile Setup</title> + +<para> +When a user first logs in on Windows 9X, the file user.DAT is created, +as are folders "Start Menu", "Desktop", "Programs" and "Nethood". +These directories and their contents will be merged with the local +versions stored in c:\windows\profiles\username on subsequent logins, +taking the most recent from each. You will need to use the [global] +options "preserve case = yes", "short preserve case = yes" and +"case sensitive = no" in order to maintain capital letters in shortcuts +in any of the profile folders. +</para> + +<para> +The user.DAT file contains all the user's preferences. If you wish to +enforce a set of preferences, rename their user.DAT file to user.MAN, +and deny them write access to this file. +</para> + +<orderedlist> + <listitem> + <para> + On the Windows 9x / Me machine, go to Control Panel -> Passwords and + select the User Profiles tab. Select the required level of + roaming preferences. Press OK, but do _not_ allow the computer + to reboot. + </para> + </listitem> + + <listitem> + <para> + On the Windows 9x / Me machine, go to Control Panel -> Network -> + Client for Microsoft Networks -> Preferences. Select 'Log on to + NT Domain'. Then, ensure that the Primary Logon is 'Client for + Microsoft Networks'. Press OK, and this time allow the computer + to reboot. + </para> + </listitem> +</orderedlist> + +<para> +Under Windows 9x / Me Profiles are downloaded from the Primary Logon. +If you have the Primary Logon as 'Client for Novell Networks', then +the profiles and logon script will be downloaded from your Novell +Server. If you have the Primary Logon as 'Windows Logon', then the +profiles will be loaded from the local machine - a bit against the +concept of roaming profiles, it would seem! +</para> + +<para> +You will now find that the Microsoft Networks Login box contains +[user, password, domain] instead of just [user, password]. Type in +the samba server's domain name (or any other domain known to exist, +but bear in mind that the user will be authenticated against this +domain and profiles downloaded from it, if that domain logon server +supports it), user name and user's password. +</para> + +<para> +Once the user has been successfully validated, the Windows 9x / Me machine +will inform you that 'The user has not logged on before' and asks you +if you wish to save the user's preferences? Select 'yes'. +</para> + +<para> +Once the Windows 9x / Me client comes up with the desktop, you should be able +to examine the contents of the directory specified in the "logon path" +on the samba server and verify that the "Desktop", "Start Menu", +"Programs" and "Nethood" folders have been created. +</para> + +<para> +These folders will be cached locally on the client, and updated when +the user logs off (if you haven't made them read-only by then). +You will find that if the user creates further folders or short-cuts, +that the client will merge the profile contents downloaded with the +contents of the profile directory already on the local client, taking +the newest folders and short-cuts from each set. +</para> + +<para> +If you have made the folders / files read-only on the samba server, +then you will get errors from the Windows 9x / Me machine on logon and logout, as +it attempts to merge the local and the remote profile. Basically, if +you have any errors reported by the Windows 9x / Me machine, check the Unix file +permissions and ownership rights on the profile directory contents, +on the samba server. +</para> + +<para> +If you have problems creating user profiles, you can reset the user's +local desktop cache, as shown below. When this user then next logs in, +they will be told that they are logging in "for the first time". +</para> + +<orderedlist> + <listitem> + <para> + instead of logging in under the [user, password, domain] dialog, + press escape. + </para> + </listitem> + + <listitem> + <para> + run the regedit.exe program, and look in: + </para> + + <para> + HKEY_LOCAL_MACHINE\Windows\CurrentVersion\ProfileList + </para> + + <para> + you will find an entry, for each user, of ProfilePath. Note the + contents of this key (likely to be c:\windows\profiles\username), + then delete the key ProfilePath for the required user. + + [Exit the registry editor]. + + </para> + </listitem> + + <listitem> + <para> + <emphasis>WARNING</emphasis> - before deleting the contents of the + directory listed in the ProfilePath (this is likely to be + <filename>c:\windows\profiles\username)</filename>, ask them if they + have any important files stored on their desktop or in their start menu. + Delete the contents of the directory ProfilePath (making a backup if any + of the files are needed). + </para> + + <para> + This will have the effect of removing the local (read-only hidden + system file) user.DAT in their profile directory, as well as the + local "desktop", "nethood", "start menu" and "programs" folders. + </para> + </listitem> + + <listitem> + <para> + search for the user's .PWL password-caching file in the c:\windows + directory, and delete it. + </para> + </listitem> + + <listitem> + <para> + log off the windows 9x / Me client. + </para> + </listitem> + + <listitem> + <para> + check the contents of the profile path (see "logon path" described + above), and delete the user.DAT or user.MAN file for the user, + making a backup if required. + </para> + </listitem> + +</orderedlist> + +<para> +If all else fails, increase samba's debug log levels to between 3 and 10, +and / or run a packet trace program such as ethereal or netmon.exe, and +look for error messages. +</para> + +<para> +If you have access to an Windows NT4/200x server, then first set up roaming profiles +and / or netlogons on the Windows NT4/200x server. Make a packet trace, or examine +the example packet traces provided with Windows NT4/200x server, and see what the +differences are with the equivalent samba trace. +</para> + +</sect3> + +<sect3> +<title>Windows NT4 Workstation</title> + +<para> +When a user first logs in to a Windows NT Workstation, the profile +NTuser.DAT is created. The profile location can be now specified +through the "logon path" parameter. +</para> + +<para> +There is a parameter that is now available for use with NT Profiles: +"logon drive". This should be set to <filename>H:</filename> or any other drive, and +should be used in conjunction with the new "logon home" parameter. +</para> + +<para> +The entry for the NT4 profile is a _directory_ not a file. The NT +help on profiles mentions that a directory is also created with a .PDS +extension. The user, while logging in, must have write permission to +create the full profile path (and the folder with the .PDS extension +for those situations where it might be created.) +</para> + +<para> +In the profile directory, Windows NT4 creates more folders than Windows 9x / Me. +It creates "Application Data" and others, as well as "Desktop", "Nethood", +"Start Menu" and "Programs". The profile itself is stored in a file +NTuser.DAT. Nothing appears to be stored in the .PDS directory, and +its purpose is currently unknown. +</para> + +<para> +You can use the System Control Panel to copy a local profile onto +a samba server (see NT Help on profiles: it is also capable of firing +up the correct location in the System Control Panel for you). The +NT Help file also mentions that renaming NTuser.DAT to NTuser.MAN +turns a profile into a mandatory one. +</para> + +<para> +The case of the profile is significant. The file must be called +NTuser.DAT or, for a mandatory profile, NTuser.MAN. +</para> +</sect3> + +<sect3> +<title>Windows 2000/XP Professional</title> + +<para> +You must first convert the profile from a local profile to a domain +profile on the MS Windows workstation as follows: +</para> + +<itemizedlist> + <listitem><para> + Log on as the LOCAL workstation administrator. + </para></listitem> + + <listitem><para> + Right click on the 'My Computer' Icon, select 'Properties' + </para></listitem> + + <listitem><para> + Click on the 'User Profiles' tab + </para></listitem> + + <listitem><para> + Select the profile you wish to convert (click on it once) + </para></listitem> + + <listitem><para> + Click on the button 'Copy To' + </para></listitem> + + <listitem><para> + In the "Permitted to use" box, click on the 'Change' button. + </para></listitem> + + <listitem><para> + Click on the 'Look in" area that lists the machine name, when you click + here it will open up a selection box. Click on the domain to which the + profile must be accessible. + </para> + + <note><para>You will need to log on if a logon box opens up. Eg: In the connect + as: MIDEARTH\root, password: mypassword.</para></note> + </listitem> + + <listitem><para> + To make the profile capable of being used by anyone select 'Everyone' + </para></listitem> + + <listitem><para> + Click OK. The Selection box will close. + </para></listitem> + + <listitem><para> + Now click on the 'Ok' button to create the profile in the path you + nominated. + </para></listitem> +</itemizedlist> + +<para> +Done. You now have a profile that can be editted using the samba-3.0.0 +<filename>profiles</filename> tool. +</para> + +<note> +<para> +Under NT/2K the use of mandotory profiles forces the use of MS Exchange +storage of mail data. That keeps desktop profiles usable. +</para> +</note> + +<note> +<itemizedlist> +<listitem><para> +This is a security check new to Windows XP (or maybe only +Windows XP service pack 1). It can be disabled via a group policy in +Active Directory. The policy is:</para> + +<para>"Computer Configuration\Administrative Templates\System\User +Profiles\Do not check for user ownership of Roaming Profile Folders"</para> + +<para>...and it should be set to "Enabled". +Does the new version of samba have an Active Directory analogue? If so, +then you may be able to set the policy through this. +</para> + +<para> +If you cannot set group policies in samba, then you may be able to set +the policy locally on each machine. If you want to try this, then do +the following (N.B. I don't know for sure that this will work in the +same way as a domain group policy): +</para> + +</listitem> + +<listitem><para> +On the XP workstation log in with an Administrator account. +</para></listitem> + + <listitem><para>Click: "Start", "Run"</para></listitem> + <listitem><para>Type: "mmc"</para></listitem> + <listitem><para>Click: "OK"</para></listitem> + + <listitem><para>A Microsoft Management Console should appear.</para></listitem> + <listitem><para>Click: File, "Add/Remove Snap-in...", "Add"</para></listitem> + <listitem><para>Double-Click: "Group Policy"</para></listitem> + <listitem><para>Click: "Finish", "Close"</para></listitem> + <listitem><para>Click: "OK"</para></listitem> + + <listitem><para>In the "Console Root" window:</para></listitem> + <listitem><para>Expand: "Local Computer Policy", "Computer Configuration",</para></listitem> + <listitem><para>"Administrative Templates", "System", "User Profiles"</para></listitem> + <listitem><para>Double-Click: "Do not check for user ownership of Roaming Profile</para></listitem> + <listitem><para>Folders"</para></listitem> + <listitem><para>Select: "Enabled"</para></listitem> + <listitem><para>Click: OK"</para></listitem> + + <listitem><para>Close the whole console. You do not need to save the settings (this + refers to the console settings rather than the policies you have + changed).</para></listitem> + + <listitem><para>Reboot</para></listitem> +</itemizedlist> +</note> +</sect3> +</sect2> + +<sect2> +<title>Sharing Profiles between W9x/Me and NT4/200x/XP workstations</title> + +<para> +Sharing of desktop profiles between Windows versions is NOT recommended. +Desktop profiles are an evolving phenomenon and profiles for later versions +of MS Windows clients add features that may interfere with earlier versions +of MS Windows clients. Probably the more salient reason to NOT mix profiles +is that when logging off an earlier version of MS Windows the older format +of profile contents may overwrite information that belongs to the newer +version resulting in loss of profile information content when that user logs +on again with the newer version of MS Windows. +</para> + +<para> +If you then want to share the same Start Menu / Desktop with W9x/Me, you will +need to specify a common location for the profiles. The smb.conf parameters +that need to be common are <emphasis>logon path</emphasis> and +<emphasis>logon home</emphasis>. +</para> + +<para> +If you have this set up correctly, you will find separate user.DAT and +NTuser.DAT files in the same profile directory. +</para> + +</sect2> + +<sect2> +<title>Profile Migration from Windows NT4/200x Server to Samba</title> + +<para> +There is nothing to stop you specifying any path that you like for the +location of users' profiles. Therefore, you could specify that the +profile be stored on a samba server, or any other SMB server, as long as +that SMB server supports encrypted passwords. +</para> + +<sect3> +<title>Windows NT4 Profile Management Tools</title> + +<para> +Unfortunately, the Resource Kit information is specific to the version of MS Windows +NT4/200x. The correct resource kit is required for each platform. +</para> + +<para> +Here is a quick guide: +</para> + +<itemizedlist> + +<listitem><para> +On your NT4 Domain Controller, right click on 'My Computer', then +select the tab labelled 'User Profiles'. +</para></listitem> + +<listitem><para> +Select a user profile you want to migrate and click on it. +</para> + +<note><para>I am using the term "migrate" lossely. You can copy a profile to +create a group profile. You can give the user 'Everyone' rights to the +profile you copy this to. That is what you need to do, since your samba +domain is not a member of a trust relationship with your NT4 PDC.</para></note> +</listitem> + + <listitem><para>Click the 'Copy To' button.</para></listitem> + + <listitem><para>In the box labelled 'Copy Profile to' add your new path, eg: + <filename>c:\temp\foobar</filename></para></listitem> + + <listitem><para>Click on the button labelled 'Change' in the "Permitted to use" box.</para></listitem> + + <listitem><para>Click on the group 'Everyone' and then click OK. This closes the + 'chose user' box.</para></listitem> + + <listitem><para>Now click OK.</para></listitem> +</itemizedlist> + +<para> +Follow the above for every profile you need to migrate. +</para> + +</sect3> + +<sect3> +<title>Side bar Notes</title> + +<para> +You should obtain the SID of your NT4 domain. You can use smbpasswd to do +this. Read the man page.</para> + +<para> +With Samba-3.0.0 alpha code you can import all you NT4 domain accounts +using the net samsync method. This way you can retain your profile +settings as well as all your users. +</para> + +</sect3> + +<sect3> +<title>moveuser.exe</title> + +<para> +The W2K professional resource kit has moveuser.exe. moveuser.exe changes +the security of a profile from one user to another. This allows the account +domain to change, and/or the user name to change. +</para> + +</sect3> + +<sect3> +<title>Get SID</title> + +<para> +You can identify the SID by using GetSID.exe from the Windows NT Server 4.0 +Resource Kit. +</para> + +<para> +Windows NT 4.0 stores the local profile information in the registry under +the following key: +HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList +</para> + +<para> +Under the ProfileList key, there will be subkeys named with the SIDs of the +users who have logged on to this computer. (To find the profile information +for the user whose locally cached profile you want to move, find the SID for +the user with the GetSID.exe utility.) Inside of the appropriate user's +subkey, you will see a string value named ProfileImagePath. +</para> + +</sect3> +</sect2> +</sect1> + +<sect1> +<title>Mandatory profiles</title> + +<para> +A Mandatory Profile is a profile that the user does NOT have the ability to overwrite. +During the user's session it may be possible to change the desktop environment, but +as the user logs out all changes made will be lost. If it is desired to NOT allow the +user any ability to change the desktop environment then this must be done through +policy settings. See previous chapter. +</para> + +<note> +<para> +Under NO circumstances should the profile directory (or it's contents) be made read-only +as this may render the profile un-usable. +</para> +</note> + +<para> +For MS Windows NT4/200x/XP the above method can be used to create mandatory profiles +also. To convert a group profile into a mandatory profile simply locate the NTUser.DAT +file in the copied profile and rename it to NTUser.MAN. +</para> + +<para> +For MS Windows 9x / Me it is the User.DAT file that must be renamed to User.MAN to +affect a mandatory profile. +</para> + +</sect1> + +<sect1> +<title>Creating/Managing Group Profiles</title> + +<para> +Most organisations are arranged into departments. There is a nice benenfit in +this fact since usually most users in a department will require the same desktop +applications and the same desktop layout. MS Windows NT4/200x/XP will allow the +use of Group Profiles. A Group Profile is a profile that is created firstly using +a template (example) user. Then using the profile migration tool (see above) the +profile is assigned access rights for the user group that needs to be given access +to the group profile. +</para> + +<para> +The next step is rather important. PLEASE NOTE: Instead of assigning a group profile +to users (ie: Using User Manager) on a "per user" basis, the group itself is assigned +the now modified profile. +</para> + +<note> + <para> + Be careful with group profiles, if the user who is a member of a group also + has a personal profile, then the result will be a fusion (merge) of the two. + </para> +</note> + +</sect1> + +<sect1> +<title>Default Profile for Windows Users</title> + +<para> +MS Windows 9x / Me and NT4/200x/XP will use a default profile for any user for whom +a profile does not already exist. Armed with a knowledge of where the default profile +is located on the Windows workstation, and knowing which registry keys affect the path +from which the default profile is created, it is possible to modify the default profile +to one that has been optimised for the site. This has significant administrative +advantages. +</para> + +<sect2> +<title>MS Windows 9x/Me</title> + +<para> +To enable default per use profiles in Windows 9x / Me you can either use the Windows 98 System +Policy Editor or change the registry directly. +</para> + +<para> +To enable default per user profiles in Windows 9x / Me, launch the System Policy Editor, then +select File -> Open Registry, then click on the Local Computer icon, click on Windows 98 System, +select User Profiles, click on the enable box. Do not forget to save the registry changes. +</para> + +<para> +To modify the registry directly, launch the Registry Editor (regedit.exe), select the hive +<filename>HKEY_LOCAL_MACHINE\Network\Logon</filename>. Now add a DWORD type key with the name +"User Profiles", to enable user profiles set the value to 1, to disable user profiles set it to 0. +</para> + +<sect3> +<title>How User Profiles Are Handled in Windows 9x / Me?</title> + +<para> +When a user logs on to a Windows 9x / Me machine, the local profile path, +<filename>HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\ProfileList</filename>, is checked +for an existing entry for that user: +</para> + +<para> +If the user has an entry in this registry location, Windows 9x / Me checks for a locally cached +version of the user profile. Windows 9x / Me also checks the user's home directory (or other +specified directory if the location has been modified) on the server for the User Profile. +If a profile exists in both locations, the newer of the two is used. If the User Profile exists +on the server, but does not exist on the local machine, the profile on the server is downloaded +and used. If the User Profile only exists on the local machine, that copy is used. +</para> + +<para> +If a User Profile is not found in either location, the Default User Profile from the Windows 9x / Me +machine is used and is copied to a newly created folder for the logged on user. At log off, any +changes that the user made are written to the user's local profile. If the user has a roaming +profile, the changes are written to the user's profile on the server. +</para> + +</sect3> +</sect2> + +<sect2> +<title>MS Windows NT4 Workstation</title> + +<para> +On MS Windows NT4 the default user profile is obtained from the location +<filename>%SystemRoot%\Profiles</filename> which in a default installation will translate to +<filename>C:\WinNT\Profiles</filename>. Under this directory on a clean install there will be +three (3) directories: <filename>Administrator, All Users, Default User</filename>. +</para> + +<para> +The <filename>All Users</filename> directory contains menu settings that are common across all +system users. The <filename>Default User</filename> directory contains menu entries that are +customisable per user depending on the profile settings chosen/created. +</para> + +<para> +When a new user first logs onto an MS Windows NT4 machine a new profile is created from: +</para> + +<simplelist> + <member>All Users settings</member> + <member>Default User settings (contains the default NTUser.DAT file)</member> +</simplelist> + +<para> +When a user logs onto an MS Windows NT4 machine that is a member of a Microsoft security domain +the following steps are followed in respect of profile handling: +</para> + +<orderedlist> + <listitem> + <para> + The users' account information which is obtained during the logon process contains + the location of the users' desktop profile. The profile path may be local to the + machine or it may be located on a network share. If there exists a profile at the location + of the path from the user account, then this profile is copied to the location + <filename>%SystemRoot%\Profiles\%USERNAME%</filename>. This profile then inherits the + settings in the <filename>All Users</filename> profile in the <filename>%SystemRoot%\Profiles</filename> + location. + </para> + </listitem> + + <listitem> + <para> + If the user account has a profile path, but at it's location a profile does not exist, + then a new profile is created in the <filename>%SystemRoot%\Profiles\%USERNAME%</filename> + directory from reading the <filename>Default User</filename> profile. + </para> + </listitem> + + <listitem> + <para> + If the NETLOGON share on the authenticating server (logon server) contains a policy file + (<filename>NTConfig.POL</filename>) then it's contents are applied to the <filename>NTUser.DAT</filename> + which is applied to the <filename>HKEY_CURRENT_USER</filename> part of the registry. + </para> + </listitem> + + <listitem> + <para> + When the user logs out, if the profile is set to be a roaming profile it will be written + out to the location of the profile. The <filename>NTuser.DAT</filename> file is then + re-created from the contents of the <filename>HKEY_CURRENT_USER</filename> contents. + Thus, should there not exist in the NETLOGON share an <filename>NTConfig.POL</filename> at the + next logon, the effect of the provious <filename>NTConfig.POL</filename> will still be held + in the profile. The effect of this is known as <emphasis>tatooing</emphasis>. + </para> + </listitem> +</orderedlist> + +<para> +MS Windows NT4 profiles may be <emphasis>Local</emphasis> or <emphasis>Roaming</emphasis>. A Local profile +will stored in the <filename>%SystemRoot%\Profiles\%USERNAME%</filename> location. A roaming profile will +also remain stored in the same way, unless the following registry key is created: +</para> + +<para> +<programlisting> + HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\winlogon\ + "DeleteRoamingCache"=dword:00000001 +</programlisting> + +In which case, the local copy (in <filename>%SystemRoot%\Profiles\%USERNAME%</filename>) will be +deleted on logout. +</para> + +<para> +Under MS Windows NT4 default locations for common resources (like <filename>My Documents</filename> +may be redirected to a network share by modifying the following registry keys. These changes may be affected +via use of the System Policy Editor (to do so may require that you create your owns template extension +for the policy editor to allow this to be done through the GUI. Another way to do this is by way of first +creating a default user profile, then while logged in as that user, run regedt32 to edit the key settings. +</para> + +<para> +The Registry Hive key that affects the behaviour of folders that are part of the default user profile +are controlled by entries on Windows NT4 is: +</para> + +<para> +<programlisting> + HKEY_CURRENT_USER + \Software + \Microsoft + \Windows + \CurrentVersion + \Explorer + \User Shell Folders\ +</programlisting> +</para> + +<para> +The above hive key contains a list of automatically managed folders. The default entries are: +</para> + + <para> + <programlisting> + Name Default Value + -------------- ----------------------------------------- + AppData %USERPROFILE%\Application Data + Desktop %USERPROFILE%\Desktop + Favorites %USERPROFILE%\Favorites + NetHood %USERPROFILE%\NetHood + PrintHood %USERPROFILE%\PrintHood + Programs %USERPROFILE%\Start Menu\Programs + Recent %USERPROFILE%\Recent + SendTo %USERPROFILE%\SendTo + Start Menu %USERPROFILE%\Start Menu + Startup %USERPROFILE%\Start Menu\Programs\Startup + </programlisting> + </para> + +<para> +The registry key that contains the location of the default profile settings is: + +<programlisting> + HKEY_LOCAL_MACHINE + \SOFTWARE + \Microsoft + \Windows + \CurrentVersion + \Explorer + \User Shell Folders +</programlisting> + +The default entries are: + +<programlisting> + Common Desktop %SystemRoot%\Profiles\All Users\Desktop + Common Programs %SystemRoot%\Profiles\All Users\Programs + Common Start Menu %SystemRoot%\Profiles\All Users\Start Menu + Common Startup %SystemRoot%\Profiles\All Users\Start Menu\Progams\Startup +</programlisting> +</para> + +</sect2> + +<sect2> +<title>MS Windows 200x/XP</title> + + <note> + <para> + MS Windows XP Home Edition does use default per user profiles, but can not participate + in domain security, can not log onto an NT/ADS style domain, and thus can obtain the profile + only from itself. While there are benefits in doing this the beauty of those MS Windows + clients that CAN participate in domain logon processes allows the administrator to create + a global default profile and to enforce it through the use of Group Policy Objects (GPOs). + </para> + </note> + +<para> +When a new user first logs onto MS Windows 200x/XP machine the default profile is obtained from +<filename>C:\Documents and Settings\Default User</filename>. The administrator can modify (or change +the contents of this location and MS Windows 200x/XP will gladly use it. This is far from the optimum +arrangement since it will involve copying a new default profile to every MS Windows 200x/XP client +workstation. +</para> + +<para> +When MS Windows 200x/XP participate in a domain security context, and if the default user +profile is not found, then the client will search for a default profile in the NETLOGON share +of the authenticating server. ie: In MS Windows parlance: +<filename>%LOGONSERVER%\NETLOGON\Default User</filename> and if one exits there it will copy this +to the workstation to the <filename>C:\Documents and Settings\</filename> under the Windows +login name of the user. +</para> + + <note> + <para> + This path translates, in Samba parlance, to the smb.conf [NETLOGON] share. The directory + should be created at the root of this share and must be called <filename>Default Profile</filename>. + </para> + </note> + +<para> +If a default profile does not exist in this location then MS Windows 200x/XP will use the local +default profile. +</para> + +<para> +On loging out, the users' desktop profile will be stored to the location specified in the registry +settings that pertain to the user. If no specific policies have been created, or passed to the client +during the login process (as Samba does automatically), then the user's profile will be written to +the local machine only under the path <filename>C:\Documents and Settings\%USERNAME%</filename>. +</para> + +<para> +Those wishing to modify the default behaviour can do so through three methods: +</para> + +<itemizedlist> + <listitem> + <para> + Modify the registry keys on the local machine manually and place the new default profile in the + NETLOGON share root - NOT recommended as it is maintenance intensive. + </para> + </listitem> + + <listitem> + <para> + Create an NT4 style NTConfig.POL file that specified this behaviour and locate this file + in the root of the NETLOGON share along with the new default profile. + </para> + </listitem> + + <listitem> + <para> + Create a GPO that enforces this through Active Directory, and place the new default profile + in the NETLOGON share. + </para> + </listitem> +</itemizedlist> + +<para> +The Registry Hive key that affects the behaviour of folders that are part of the default user profile +are controlled by entries on Windows 200x/XP is: +</para> + +<para> +<programlisting> + HKEY_CURRENT_USER + \Software + \Microsoft + \Windows + \CurrentVersion + \Explorer + \User Shell Folders\ +</programlisting> +</para> + +<para> +The above hive key contains a list of automatically managed folders. The default entries are: +</para> + + <para> + <programlisting> + Name Default Value + -------------- ----------------------------------------- + AppData %USERPROFILE%\Application Data + Cache %USERPROFILE%\Local Settings\Temporary Internet Files + Cookies %USERPROFILE%\Cookies + Desktop %USERPROFILE%\Desktop + Favorites %USERPROFILE%\Favorites + History %USERPROFILE%\Local Settings\History + Local AppData %USERPROFILE%\Local Settings\Application Data + Local Settings %USERPROFILE%\Local Settings + My Pictures %USERPROFILE%\My Documents\My Pictures + NetHood %USERPROFILE%\NetHood + Personal %USERPROFILE%\My Documents + PrintHood %USERPROFILE%\PrintHood + Programs %USERPROFILE%\Start Menu\Programs + Recent %USERPROFILE%\Recent + SendTo %USERPROFILE%\SendTo + Start Menu %USERPROFILE%\Start Menu + Startup %USERPROFILE%\Start Menu\Programs\Startup + Templates %USERPROFILE%\Templates + </programlisting> + </para> + +<para> +There is also an entry called "Default" that has no value set. The default entry is of type REG_SZ, all +the others are of type REG_EXPAND_SZ. +</para> + +<para> +It makes a huge difference to the speed of handling roaming user profiles if all the folders are +stored on a dedicated location on a network server. This means that it will NOT be necessary to +write the Outlook PST file over the network for every login and logout. +</para> + +<para> +To set this to a network location you could use the following examples: + +<programlisting> + %LOGONSERVER%\%USERNAME%\Default Folders +</programlisting> + +This would store the folders in the user's home directory under a directory called "Default Folders" + +You could also use: + +<programlisting> + \\SambaServer\FolderShare\%USERNAME% +</programlisting> + +in which case the default folders will be stored in the server named <emphasis>SambaServer</emphasis> +in the share called <emphasis>FolderShare</emphasis> under a directory that has the name of the MS Windows +user as seen by the Linux/Unix file system. +</para> + +<para> +Please note that once you have created a default profile share, you MUST migrate a user's profile +(default or custom) to it. +</para> + +<para> +MS Windows 200x/XP profiles may be <emphasis>Local</emphasis> or <emphasis>Roaming</emphasis>. +A roaming profile will be cached locally unless the following registry key is created: +</para> + +<para> +<programlisting> + HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\winlogon\ + "DeleteRoamingCache"=dword:00000001 +</programlisting> + +In which case, the local cache copy will be deleted on logout. +</para> +</sect2> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/SWAT.xml b/docs/docbook/projdoc/SWAT.xml new file mode 100644 index 0000000000..f238e8e1b0 --- /dev/null +++ b/docs/docbook/projdoc/SWAT.xml @@ -0,0 +1,351 @@ +<chapter id="SWAT"> +<chapterinfo> + &author.jht; + <pubdate>April 21, 2003</pubdate> +</chapterinfo> + +<title>SWAT - The Samba Web Admininistration Tool</title> + +<para> +There are many and varied opinions regarding the usefulness or otherwise of SWAT. +No matter how hard one tries to produce the perfect configuration tool it remains +an object of personal taste. SWAT is a tool that will allow web based configuration +of samba. It has a wizard that may help to get samba configured quickly, it has context +sensitive help on each smb.conf parameter, it provides for monitoring of current state +of connection information, and it allows network wide MS Windows network password +management. +</para> + +<sect1> +<title>SWAT Features and Benefits</title> + +<para> +There are network administrators who believe that it is a good idea to write systems +documentation inside configuration files, for them SWAT will aways be a nasty tool. SWAT +does not store the configuration file in any intermediate form, rather, it stores only the +parameter settings, so when SWAT writes the smb.conf file to disk it will write only +those parameters that are at other than the default settings. The result is that all comments +will be lost from the smb.conf file. Additionally, the parameters will be written back in +internal ordering. +</para> + +<note><para> +So before using SWAT please be warned - SWAT will completely replace your smb.conf with +a fully optimised file that has been stripped of all comments you might have placed there +and only non-default settings will be written to the file. +</para></note> + +<sect2> +<title>Enabling SWAT for use</title> + +<para> +SWAT should be installed to run via the network super daemon. Depending on which system +your Unix/Linux system has you will have either an <filename>inetd</filename> or +<filename>xinetd</filename> based system. +</para> + +<para> +The nature and location of the network super-daemon varies with the operating system +implementation. The control file (or files) can be located in the file +<filename>/etc/inetd.conf</filename> or in the directory <filename>/etc/[x]inet.d</filename> +or similar. +</para> + +<para> +The control entry for the older style file might be: +</para> + +<para><programlisting> + # swat is the Samba Web Administration Tool + swat stream tcp nowait.400 root /usr/sbin/swat swat +</programlisting></para> + +<para> +A control file for the newer style xinetd could be: +</para> + +<para> +<programlisting> + # default: off + # description: SWAT is the Samba Web Admin Tool. Use swat \ + # to configure your Samba server. To use SWAT, \ + # connect to port 901 with your favorite web browser. + service swat + { + port = 901 + socket_type = stream + wait = no + only_from = localhost + user = root + server = /usr/sbin/swat + log_on_failure += USERID + disable = yes + } +</programlisting> + +</para> + +<para> +Both the above examples assume that the <filename>swat</filename> binary has been +located in the <filename>/usr/sbin</filename> directory. In addition to the above +SWAT will use a directory access point from which it will load it's help files +as well as other control information. The default location for this on most Linux +systems is in the directory <filename>/usr/share/samba/swat</filename>. The default +location using samba defaults will be <filename>/usr/local/samba/swat</filename>. +</para> + +<para> +Access to SWAT will prompt for a logon. If you log onto SWAT as any non-root user +the only permission allowed is to view certain aspects of configuration as well as +access to the password change facility. The buttons that will be exposed to the non-root +user are: <emphasis>HOME, STATUS, VIEW, PASSWORD</emphasis>. The only page that allows +change capability in this case is <emphasis>PASSWORD</emphasis>. +</para> + +<para> +So long as you log onto SWAT as the user <command>root</command> you should obtain +full change and commit ability. The buttons that will be exposed includes: +<emphasis>HOME, GLOBALS, SHARES, PRINTERS, WIZARD, STATUS, VIEW, PASSWORD</emphasis>. +</para> + +</sect2> + +<sect2> +<title>Securing SWAT through SSL</title> + +<para> +Lots of people have asked about how to setup SWAT with SSL to allow for secure remote +administration of Samba. Here is a method that works, courtesy of Markus Krieger +</para> + +<para> +Modifications to the swat setup are as following: +</para> + +<itemizedlist> + <listitem><para> + install OpenSSL + </para></listitem> + + <listitem><para> + generate certificate and private key + + <programlisting> + root# /usr/bin/openssl req -new -x509 -days 365 -nodes -config \ + /usr/share/doc/packages/stunnel/stunnel.cnf \ + -out /etc/stunnel/stunnel.pem -keyout /etc/stunnel/stunnel.pem + </programlisting></para></listitem> + + <listitem><para> + remove swat-entry from [x]inetd + </para></listitem> + + <listitem><para> + start stunnel + + <programlisting> + root# stunnel -p /etc/stunnel/stunnel.pem -d 901 \ + -l /usr/local/samba/bin/swat swat + </programlisting></para></listitem> +</itemizedlist> + +<para> +afterwards simply contact to swat by using the URL "https://myhost:901", accept the certificate +and the SSL connection is up. +</para> + +</sect2> + +<sect2> +<title>The SWAT Home Page</title> + +<para> +The SWAT title page provides access to the latest Samba documentation. The manual page for +each samba component is accessible from this page as are the Samba-HOWTO-Collection (this +document) as well as the O'Reilly book "Using Samba". +</para> + +<para> +Administrators who wish to validate their samba configuration may obtain useful information +from the man pages for the diganostic utilities. These are available from the SWAT home page +also. One diagnostic tool that is NOT mentioned on this page, but that is particularly +useful is <command>ethereal</command>, available from <ulink url="http://www.ethereal.com"> +http://www.ethereal.com</ulink>. +</para> + +<note><para> +SWAT can be configured to run in <emphasis>demo</emphasis> mode. This is NOT recommended +as it runs SWAT without authentication and with full administrative ability. ie: Allows +changes to smb.conf as well as general operation with root privilidges. The option that +creates this ability is the <command>-a</command> flag to swat. DO NOT USE THIS IN ANY +PRODUCTION ENVIRONMENT - you have been warned! +</para></note> + +</sect2> + +<sect2> +<title>Global Settings</title> + +<para> +The Globals button will expose a page that allows configuration of the global parameters +in smb.conf. There are three levels of exposure of the parameters: +</para> + +<itemizedlist> + <listitem><para> + <command>Basic</command> - exposes common configuration options. + </para></listitem> + + <listitem><para> + <command>Advanced</command> - exposes configuration options needed in more + complex environments. + </para></listitem> + + <listitem><para> + <command>Developer</command> - exposes configuration options that only the brave + will want to tamper with. + </para></listitem> +</itemizedlist> + +<para> +To switch to other than <emphasis>Basic</emphasis> editing ability click on either the +<emphasis>Advanced</emphasis> or the <emphasis>Developer</emphasis> dial, then click the +<emphasis>Commit Changes</emphasis> button. +</para> + +<para> +After making any changes to configuration parameters make sure that you click on the +<emphasis>Commit Changes</emphasis> button before moving to another area otherwise +your changes will be immediately lost. +</para> + +<note><para> +SWAT has context sensitive help. To find out what each parameter is for simply click the +<command>Help</command> link to the left of the configurartion parameter. +</para></note> + +</sect2> + +<sect2> +<title>Share Settings</title> + +<para> +To affect a currenly configured share, simply click on the pull down button between the +<emphasis>Choose Share</emphasis> and the <emphasis>Delete Share</emphasis> buttons, +select the share you wish to operate on, then to edit the settings click on the +<emphasis>Choose Share</emphasis> button, to delete the share simply press the +<emphasis>Delete Share</emphasis> button. +</para> + +<para> +To create a new share, next to the button labelled <emphasis>Create Share</emphasis> enter +into the text field the name of the share to be created, then click on the +<emphasis>Create Share</emphasis> button. +</para> + +</sect2> + +<sect2> +<title>Printers Settings</title> + +<para> +To affect a currenly configured printer, simply click on the pull down button between the +<emphasis>Choose Printer</emphasis> and the <emphasis>Delete Printer</emphasis> buttons, +select the printer you wish to operate on, then to edit the settings click on the +<emphasis>Choose Printer</emphasis> button, to delete the share simply press the +<emphasis>Delete Printer</emphasis> button. +</para> + +<para> +To create a new printer, next to the button labelled <emphasis>Create Printer</emphasis> enter +into the text field the name of the share to be created, then click on the +<emphasis>Create Printer</emphasis> button. +</para> + +</sect2> + +<sect2> +<title>The SWAT Wizard</title> + +<para> +The purpose if the SWAT Wizard is to help the Microsoft knowledgable network administrator +to configure Samba with a minimum of effort. +</para> + +<para> +The Wizard page provides a tool for rewiting the smb.conf file in fully optimised format. +This will also happen if you press the commit button. The two differ in the the rewrite button +ignores any changes that may have been made, while the Commit button causes all changes to be +affected. +</para> + +<para> +The <emphasis>Edit</emphasis> button permits the editing (setting) of the minimal set of +options that may be necessary to create a working samba server. +</para> + +<para> +Finally, there are a limited set of options that will determine what type of server samba +will be configured for, whether it will be a WINS server, participate as a WINS client, or +operate with no WINS support. By clicking on one button you can elect to epose (or not) user +home directories. +</para> + +</sect2> + +<sect2> +<title>The Status Page</title> + +<para> +The status page serves a limited purpose. Firstly, it allows control of the samba daemons. +The key daemons that create the samba server environment are: <command> smbd, nmbd, winbindd</command>. +</para> + +<para> +The daemons may be controlled individually or as a total group. Additionally, you may set +an automatic screen refresh timing. As MS Windows clients interact with Samba new smbd processes +will be continually spawned. The auto-refresh facility will allow you to track the changing +conditions with minimal effort. +</para> + +<para> +Lastly, the Status page may be used to terminate specific smbd client connections in order to +free files that may be locked. +</para> + +</sect2> + +<sect2> +<title>The View Page</title> + +<para> +This page allows the administrator to view the optimised smb.conf file and if you are +particularly massochistic will permit you also to see all possible global configuration +parameters and their settings. +</para> + +</sect2> + +<sect2> +<title>The Password Change Page</title> + +<para> +The Password Change page is a popular tool. This tool allows the creation, deletion, deactivation +and reactivation of MS Windows networking users on the local machine. Alternatively, you can use +this tool to change a local password for a user account. +</para> + +<para> +When logged in as a non-root account the user will have to provide the old password as well as +the new password (twice). When logged in as <command>root</command> only the new password is +required. +</para> + +<para> +One popular use for this tool is to change user passwords across a range of remote MS Windows +servers. +</para> + +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Samba-BDC-HOWTO.xml b/docs/docbook/projdoc/Samba-BDC-HOWTO.xml new file mode 100644 index 0000000000..2f3b568471 --- /dev/null +++ b/docs/docbook/projdoc/Samba-BDC-HOWTO.xml @@ -0,0 +1,250 @@ +<chapter id="samba-bdc"> + +<chapterinfo> + &author.vl; + <pubdate> (26 Apr 2001) </pubdate> +</chapterinfo> + +<title> +Samba Backup Domain Controller to Samba Domain Control +</title> + +<sect1> +<title>Prerequisite Reading</title> + +<para> +Before you continue reading in this chapter, please make sure +that you are comfortable with configuring a Samba PDC +as described in the <ulink url="Samba-PDC-HOWTO.html">Samba-PDC-HOWTO</ulink>. +</para> + + +</sect1> + +<sect1> + +<title>Background</title> + +<para> +What is a Domain Controller? It is a machine that is able to answer +logon requests from workstations in a Windows NT Domain. Whenever a +user logs into a Windows NT Workstation, the workstation connects to a +Domain Controller and asks him whether the username and password the +user typed in is correct. The Domain Controller replies with a lot of +information about the user, for example the place where the users +profile is stored, the users full name of the user. All this +information is stored in the NT user database, the so-called SAM. +</para> + +<para> +There are two kinds of Domain Controller in a NT 4 compatible Domain: +A Primary Domain Controller (PDC) and one or more Backup Domain +Controllers (BDC). The PDC contains the master copy of the +SAM. Whenever the SAM has to change, for example when a user changes +his password, this change has to be done on the PDC. A Backup Domain +Controller is a machine that maintains a read-only copy of the +SAM. This way it is able to reply to logon requests and authenticate +users in case the PDC is not available. During this time no changes to +the SAM are possible. Whenever changes to the SAM are done on the PDC, +all BDC receive the changes from the PDC. +</para> + +<para> +Since version 2.2 Samba officially supports domain logons for all +current Windows Clients, including Windows 2000 and XP. This text +assumes the domain to be named SAMBA. To be able to act as a PDC, some +parameters in the [global]-section of the smb.conf have to be set: +</para> + +<para><programlisting> + workgroup = SAMBA + domain master = yes + domain logons = yes +</programlisting></para> + +<para> +Several other things like a [homes] and a [netlogon] share also may be +set along with settings for the profile path, the users home drive and +others. This will not be covered in this document. +</para> + +</sect1> + + +<sect1> +<title>What qualifies a Domain Controller on the network?</title> + +<para> +Every machine that is a Domain Controller for the domain SAMBA has to +register the NetBIOS group name SAMBA#1c with the WINS server and/or +by broadcast on the local network. The PDC also registers the unique +NetBIOS name SAMBA#1b with the WINS server. The name type #1b is +normally reserved for the domain master browser, a role that has +nothing to do with anything related to authentication, but the +Microsoft Domain implementation requires the domain master browser to +be on the same machine as the PDC. +</para> + + +<sect2> +<title>How does a Workstation find its domain controller?</title> + +<para> +A NT workstation in the domain SAMBA that wants a local user to be +authenticated has to find the domain controller for SAMBA. It does +this by doing a NetBIOS name query for the group name SAMBA#1c. It +assumes that each of the machines it gets back from the queries is a +domain controller and can answer logon requests. To not open security +holes both the workstation and the selected (TODO: How is the DC +chosen) domain controller authenticate each other. After that the +workstation sends the user's credentials (his name and password) to +the domain controller, asking for approval. +</para> + +</sect2> + + +<sect2> +<title>When is the PDC needed?</title> + +<para> +Whenever a user wants to change his password, this has to be done on +the PDC. To find the PDC, the workstation does a NetBIOS name query +for SAMBA#1b, assuming this machine maintains the master copy of the +SAM. The workstation contacts the PDC, both mutually authenticate and +the password change is done. +</para> + +</sect2> + +</sect1> + + +<sect1> +<title>Can Samba be a Backup Domain Controller to an NT PDC?</title> + +<para> +With version 2.2, no. The native NT SAM replication protocols have +not yet been fully implemented. The Samba Team is working on +understanding and implementing the protocols, but this work has not +been finished for version 2.2. +</para> + +<para> +With version 3.0, the work on both the replication protocols and a +suitable storage mechanism has progressed, and some form of NT4 BDC +support is expected soon. +</para> + +<para> +Can I get the benefits of a BDC with Samba? Yes. The main reason for +implementing a BDC is availability. If the PDC is a Samba machine, +a second Samba machine can be set up to +service logon requests whenever the PDC is down. +</para> + +</sect1> + + +<sect1> +<title>How do I set up a Samba BDC?</title> + +<para> +Several things have to be done: +</para> + +<itemizedlist> + +<listitem><para> +The domain SID has to be the same on the PDC and the BDC. This used to +be stored in the file private/MACHINE.SID. This file is not created +anymore since Samba 2.2.5 or even earlier. Nowadays the domain SID is +stored in the file private/secrets.tdb. Simply copying the secrets.tdb +from the PDC to the BDC does not work, as the BDC would +generate a new SID for itself and override the domain SID with this +new BDC SID.</para> + +<para> +To retrieve the domain SID from the PDC or an existing BDC and store it in the +secrets.tdb, execute 'net rpc getsid' on the BDC. +</para></listitem> + +<listitem><para> +The Unix user database has to be synchronized from the PDC to the +BDC. This means that both the /etc/passwd and /etc/group have to be +replicated from the PDC to the BDC. This can be done manually +whenever changes are made, or the PDC is set up as a NIS master +server and the BDC as a NIS slave server. To set up the BDC as a +mere NIS client would not be enough, as the BDC would not be able to +access its user database in case of a PDC failure. +</para> +</listitem> + +<listitem><para> +The Samba password database in the file private/smbpasswd has to be +replicated from the PDC to the BDC. This is a bit tricky, see the +next section. +</para></listitem> + +<listitem><para> +Any netlogon share has to be replicated from the PDC to the +BDC. This can be done manually whenever login scripts are changed, +or it can be done automatically together with the smbpasswd +synchronization. +</para></listitem> + +</itemizedlist> + +<para> +Finally, the BDC has to be found by the workstations. This can be done +by setting +</para> + +<para><programlisting> + workgroup = samba + domain master = no + domain logons = yes +</programlisting></para> + +<para> +in the [global]-section of the smb.conf of the BDC. This makes the BDC +only register the name SAMBA#1c with the WINS server. This is no +problem as the name SAMBA#1c is a NetBIOS group name that is meant to +be registered by more than one machine. The parameter 'domain master = +no' forces the BDC not to register SAMBA#1b which as a unique NetBIOS +name is reserved for the Primary Domain Controller. +</para> + +<sect2> +<title>How do I replicate the smbpasswd file?</title> + +<para> +Replication of the smbpasswd file is sensitive. It has to be done +whenever changes to the SAM are made. Every user's password change is +done in the smbpasswd file and has to be replicated to the BDC. So +replicating the smbpasswd file very often is necessary. +</para> + +<para> +As the smbpasswd file contains plain text password equivalents, it +must not be sent unencrypted over the wire. The best way to set up +smbpasswd replication from the PDC to the BDC is to use the utility +rsync. rsync can use ssh as a transport. ssh itself can be set up to +accept *only* rsync transfer without requiring the user to type a +password. +</para> + + +</sect2> +<sect2> +<title>Can I do this all with LDAP?</title> +<para>The simple answer is YES. Samba's pdb_ldap code supports +binding to a replica LDAP server, and will also follow referrals and +rebind to the master if it ever needs to make a modification to the +database. (Normally BDCs are read only, so this will not occur +often). +</para> +</sect2> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Samba-PDC-HOWTO.xml b/docs/docbook/projdoc/Samba-PDC-HOWTO.xml new file mode 100644 index 0000000000..0189b59f2e --- /dev/null +++ b/docs/docbook/projdoc/Samba-PDC-HOWTO.xml @@ -0,0 +1,842 @@ +<chapter id="samba-pdc"> + + +<chapterinfo> + &author.jerry; + &author.jht; + <author> + <firstname>David</firstname><surname>Bannon</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>dbannon@samba.org</email></address> + </affiliation> + </author> + <pubdate> (26 Apr 2001) </pubdate> +</chapterinfo> + +<title> +Samba as an NT4 or Win2k Primary Domain Controller +</title> + + +<sect1> +<title>Prerequisite Reading</title> + +<para> +Before you continue reading in this chapter, please make sure +that you are comfortable with configuring basic files services +in smb.conf and how to enable and administer password +encryption in Samba. Theses two topics are covered in the +&smb.conf; manpage. +</para> + + +</sect1> + + + +<sect1> +<title> +Background +</title> + +<para> +This article outlines the steps necessary for configuring Samba as a PDC. +It is necessary to have a working Samba server prior to implementing the +PDC functionality. +</para> + +<itemizedlist> + <listitem><para> + Domain logons for Windows NT 4.0 / 200x / XP Professional clients. + </para></listitem> + + <listitem><para> + Placing Windows 9x / Me clients in user level security + </para></listitem> + + <listitem><para> + Retrieving a list of users and groups from a Samba PDC to + Windows 9x / Me / NT / 200x / XP Professional clients + </para></listitem> + + <listitem><para> + Roaming Profiles + </para></listitem> + + <listitem><para> + Network/System Policies + </para></listitem> +</itemizedlist> + +<note> +<para> +Roaming Profiles and System/Network policies are advanced network administration topics +that are covered separately in this document. +</para> +</note> + +<para> +The following functionalities are new to the Samba 3.0 release: +</para> + +<itemizedlist> + <listitem><para> + Windows NT 4 domain trusts + </para></listitem> + + <listitem><para> + Adding users via the User Manager for Domains + </para></listitem> +</itemizedlist> + +<para> +The following functionalities are NOT provided by Samba 3.0: +</para> + +<itemizedlist> + <listitem><para> + SAM replication with Windows NT 4.0 Domain Controllers + (i.e. a Samba PDC and a Windows NT BDC or vice versa) + </para></listitem> + + <listitem><para> + Acting as a Windows 2000 Domain Controller (i.e. Kerberos and + Active Directory) + </para></listitem> +</itemizedlist> + +<para> +Please note that Windows 9x / Me / XP Home clients are not true members of a domain +for reasons outlined in this article. Therefore the protocol for +support of Windows 9x-style domain logons is completely different +from NT4 / Win2k type domain logons and has been officially supported for some +time. +</para> + +<para><emphasis> +MS Windows XP Home edition is NOT able to join a domain and does not permit +the use of domain logons.</emphasis> +</para> + + +<para> +Implementing a Samba PDC can basically be divided into 3 broad +steps. +</para> + +<orderedlist numeration="arabic"> + <listitem><para> + Configuring the Samba PDC + </para></listitem> + + <listitem><para> + Creating machine trust accounts and joining clients to the domain + </para></listitem> + + <listitem><para> + Adding and managing domain user accounts + </para></listitem> +</orderedlist> + +<para> +There are other minor details such as user profiles, system +policies, etc... However, these are not necessarily specific +to a Samba PDC as much as they are related to Windows NT networking +concepts. +</para> + +</sect1> + + +<sect1> +<title>Configuring the Samba Domain Controller</title> + +<para> +The first step in creating a working Samba PDC is to +understand the parameters necessary in smb.conf. Here we +attempt to explain the parameters that are covered in +the &smb.conf; man page. +</para> + +<para> +Here is an example &smb.conf; for acting as a PDC: +</para> + +<para><programlisting> +[global] + ; Basic server settings + <ulink url="smb.conf.5.html#NETBIOSNAME">netbios name</ulink> = <replaceable>POGO</replaceable> + <ulink url="smb.conf.5.html#WORKGROUP">workgroup</ulink> = <replaceable>NARNIA</replaceable> + + ; User and Machine Account Backends + ; Choices are: tdbsam, tdbsam_nua, smbpasswd, smbpasswd_nua, ldapsam, ldapsam_nua, ... + ; mysqlsam, xmlsam, guest + <ulink url="smb.conf.5.html#PASSDBBACKEND">passdb backend</ulink> = ldapsam, guest + + ; we should act as the domain and local master browser + <ulink url="smb.conf.5.html#OSLEVEL">os level</ulink> = 64 + <ulink url="smb.conf.5.html#PERFERREDMASTER">preferred master</ulink> = yes + <ulink url="smb.conf.5.html#DOMAINMASTER">domain master</ulink> = yes + <ulink url="smb.conf.5.html#LOCALMASTER">local master</ulink> = yes + + ; security settings (must user security = user) + <ulink url="smb.conf.5.html#SECURITYEQUALSUSER">security</ulink> = user + + ; encrypted passwords are a requirement for a PDC + <ulink url="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords</ulink> = yes + + ; support domain logons + <ulink url="smb.conf.5.html#DOMAINLOGONS">domain logons</ulink> = yes + + ; where to store user profiles? + <ulink url="smb.conf.5.html#LOGONPATH">logon path</ulink> = \\%N\profiles\%u + + ; where is a user's home directory and where should it be mounted at? + <ulink url="smb.conf.5.html#LOGONDRIVE">logon drive</ulink> = H: + <ulink url="smb.conf.5.html#LOGONHOME">logon home</ulink> = \\homeserver\%u + + ; specify a generic logon script for all users + ; this is a relative **DOS** path to the [netlogon] share + <ulink url="smb.conf.5.html#LOGONSCRIPT">logon script</ulink> = logon.cmd + +; necessary share for domain controller +[netlogon] + <ulink url="smb.conf.5.html#PATH">path</ulink> = /usr/local/samba/lib/netlogon + <ulink url="smb.conf.5.html#READONLY">read only</ulink> = yes + <ulink url="smb.conf.5.html#WRITELIST">write list</ulink> = <replaceable>ntadmin</replaceable> + +; share for storing user profiles +[profiles] + <ulink url="smb.conf.5.html#PATH">path</ulink> = /export/smb/ntprofile + <ulink url="smb.conf.5.html#READONLY">read only</ulink> = no + <ulink url="smb.conf.5.html#CREATEMASK">create mask</ulink> = 0600 + <ulink url="smb.conf.5.html#DIRECTORYMASK">directory mask</ulink> = 0700 +</programlisting></para> + +<note><para> +The above parameters make for a full set of parameters that may define the server's mode +of operation. The following parameters are the essentials alone: + +<programlisting> + workgroup = NARNIA + domain logons = Yes + security = User +</programlisting> + +The additional parameters shown in the longer listing above just makes for a +more complete environment. +</para></note> + +<para> +There are a couple of points to emphasize in the above configuration. +</para> + +<itemizedlist> + <listitem><para> + Encrypted passwords must be enabled. For more details on how + to do this, refer to <link linkend="passdb">the User Database chapter</link>. + </para></listitem> + + <listitem><para> + The server must support domain logons and a + <filename>[netlogon]</filename> share + </para></listitem> + + <listitem><para> + The server must be the domain master browser in order for Windows + client to locate the server as a DC. Please refer to the various + Network Browsing documentation included with this distribution for + details. + </para></listitem> +</itemizedlist> + +<para> +Samba 3.0 offers a complete implementation of group mapping +between Windows NT groups and Unix groups (this is really quite +complicated to explain in a short space). +</para> + +</sect1> + + +<sect1> +<title>Creating Machine Trust Accounts and Joining Clients to the Domain</title> + +<para> +A machine trust account is a Samba account that is used to +authenticate a client machine (rather than a user) to the Samba +server. In Windows terminology, this is known as a "Computer +Account."</para> + +<para> +The password of a machine trust account acts as the shared secret for +secure communication with the Domain Controller. This is a security +feature to prevent an unauthorized machine with the same NetBIOS name +from joining the domain and gaining access to domain user/group +accounts. Windows NT, 200x, XP Professional clients use machine trust +accounts, but Windows 9x / Me / XP Home clients do not. Hence, a +Windows 9x / Me / XP Home client is never a true member of a domain +because it does not possess a machine trust account, and thus has no +shared secret with the domain controller. +</para> + +<para>A Windows PDC stores each machine trust account in the Windows +Registry. A Samba-3 PDC also has to store machine trust account information +in a suitable backend data store. With Samba-3 there can be multiple back-ends +for this including: +</para> + +<itemizedlist> + <listitem><para> + <emphasis>smbpasswd</emphasis> - the plain ascii file stored used by + earlier versions of Samba. This file configuration option requires + a Unix/Linux system account for EVERY entry (ie: both for user and for + machine accounts). This file will be located in the <emphasis>private</emphasis> + directory (default is /usr/local/samba/lib/private or on linux /etc/samba). + </para></listitem> + + <listitem><para> + <emphasis>smbpasswd_nua</emphasis> - This file is independant of the + system wide user accounts. The use of this back-end option requires + specification of the "non unix account range" option also. It is called + smbpasswd and will be located in the <filename>private</filename> directory. + </para></listitem> + + <listitem><para> + <emphasis>tdbsam</emphasis> - a binary database backend that will be + stored in the <emphasis>private</emphasis> directory in a file called + <emphasis>passwd.tdb</emphasis>. The key benefit of this binary format + file is that it can store binary objects that can not be accomodated + in the traditional plain text smbpasswd file. + </para></listitem> + + <listitem><para> + <emphasis>tdbsam_nua</emphasis> like the smbpasswd_nua option above, this + file allows the creation of arbitrary user and machine accounts without + requiring that account to be added to the system (/etc/passwd) file. It + too requires the specification of the "non unix account range" option + in the [globals] section of the &smb.conf; file. + </para></listitem> + + <listitem><para> + <emphasis>ldapsam</emphasis> - An LDAP based back-end. Permits the + LDAP server to be specified. eg: ldap://localhost or ldap://frodo.murphy.com + </para></listitem> + + <listitem><para> + <emphasis>ldapsam_nua</emphasis> - LDAP based back-end with no unix + account requirement, like smbpasswd_nua and tdbsam_nua above. + </para></listitem> +</itemizedlist> + +<para>Read the chapter about the <link linkend="passdb">User Database</link> +for details.</para> + +<note><para> +The new tdbsam and ldapsam account backends store vastly more information than +smbpasswd is capable of. The new backend database includes capacity to specify +per user settings for many parameters, over-riding global settings given in the +<filename>smb.conf</filename> file. eg: logon drive, logon home, logon path, etc. +</para></note> + +<para> +A Samba PDC, however, stores each machine trust account in two parts, +as follows: + +<itemizedlist> + <listitem><para>A Samba account, stored in the same location as user + LanMan and NT password hashes (currently + <filename>smbpasswd</filename>). The Samba account + possesses and uses only the NT password hash.</para></listitem> + + <listitem><para>A corresponding Unix account, typically stored in + <filename>/etc/passwd</filename>. (Future releases will alleviate the need to + create <filename>/etc/passwd</filename> entries.) </para></listitem> +</itemizedlist> +</para> + +<para> +There are two ways to create machine trust accounts: +</para> + +<itemizedlist> + <listitem><para> Manual creation. Both the Samba and corresponding + Unix account are created by hand.</para></listitem> + + <listitem><para> "On-the-fly" creation. The Samba machine trust + account is automatically created by Samba at the time the client + is joined to the domain. (For security, this is the + recommended method.) The corresponding Unix account may be + created automatically or manually. </para> + </listitem> + +</itemizedlist> + +<sect2> +<title>Manual Creation of Machine Trust Accounts</title> + +<para> +The first step in manually creating a machine trust account is to +manually create the corresponding Unix account in +<filename>/etc/passwd</filename>. This can be done using +<command>vipw</command> or other 'add user' command that is normally +used to create new Unix accounts. The following is an example for a +Linux based Samba server: +</para> + +<para> + <prompt>root# </prompt><command>/usr/sbin/useradd -g 100 -d /dev/null -c <replaceable>"machine +nickname"</replaceable> -s /bin/false <replaceable>machine_name</replaceable>$ </command> +</para> +<para> +<prompt>root# </prompt><command>passwd -l <replaceable>machine_name</replaceable>$</command> +</para> + +<para>On *BSD systems, this can be done using the 'chpass' utility:</para> + +<para> +<prompt>root# </prompt><command>chpass -a "<replaceable>machine_name</replaceable>$:*:101:100::0:0:Workstation <replaceable>machine_name</replaceable>:/dev/null:/sbin/nologin"</command> +</para> + +<para> +The <filename>/etc/passwd</filename> entry will list the machine name +with a "$" appended, won't have a password, will have a null shell and no +home directory. For example a machine named 'doppy' would have an +<filename>/etc/passwd</filename> entry like this: +</para> + +<para><programlisting> +doppy$:x:505:501:<replaceable>machine_nickname</replaceable>:/dev/null:/bin/false +</programlisting></para> + +<para> +Above, <replaceable>machine_nickname</replaceable> can be any +descriptive name for the client, i.e., BasementComputer. +<replaceable>machine_name</replaceable> absolutely must be the NetBIOS +name of the client to be joined to the domain. The "$" must be +appended to the NetBIOS name of the client or Samba will not recognize +this as a machine trust account. +</para> + + +<para> +Now that the corresponding Unix account has been created, the next step is to create +the Samba account for the client containing the well-known initial +machine trust account password. This can be done using the <ulink +url="smbpasswd.8.html"><command>smbpasswd(8)</command></ulink> command +as shown here: +</para> + +<para> +<prompt>root# </prompt><userinput>smbpasswd -a -m <replaceable>machine_name</replaceable></userinput> +</para> + +<para> +where <replaceable>machine_name</replaceable> is the machine's NetBIOS +name. The RID of the new machine account is generated from the UID of +the corresponding Unix account. +</para> + +<warning> + <title>Join the client to the domain immediately</title> + + <para> + Manually creating a machine trust account using this method is the + equivalent of creating a machine trust account on a Windows NT PDC using + the "Server Manager". From the time at which the account is created + to the time which the client joins the domain and changes the password, + your domain is vulnerable to an intruder joining your domain using + a machine with the same NetBIOS name. A PDC inherently trusts + members of the domain and will serve out a large degree of user + information to such clients. You have been warned! + </para> +</warning> +</sect2> + + +<sect2> +<title>"On-the-Fly" Creation of Machine Trust Accounts</title> + +<para> +The second (and recommended) way of creating machine trust accounts is +simply to allow the Samba server to create them as needed when the client +is joined to the domain. </para> + +<para>Since each Samba machine trust account requires a corresponding +Unix account, a method for automatically creating the +Unix account is usually supplied; this requires configuration of the +<ulink url="smb.conf.5.html#ADDMACHINESCRIPT">add machine script</ulink> +option in <filename>smb.conf</filename>. This +method is not required, however; corresponding Unix accounts may also +be created manually. +</para> + + +<para>Below is an example for a RedHat 6.2 Linux system. +</para> + +<para><programlisting> +[global] + # <...remainder of parameters...> + add machine script = /usr/sbin/useradd -d /dev/null -g 100 -s /bin/false -M %u +</programlisting></para> + +</sect2> + + +<sect2><title>Joining the Client to the Domain</title> + +<para> +The procedure for joining a client to the domain varies with the +version of Windows. +</para> + +<itemizedlist> +<listitem><para><emphasis>Windows 2000</emphasis></para> + + <para> + When the user elects to join the client to a domain, Windows prompts for + an account and password that is privileged to join the domain. A Samba administrative + account (i.e., a Samba account that has root privileges on the Samba server) must be + entered here; the operation will fail if an ordinary user account is given. + The password for this account should be set to a different password than the associated + <filename>/etc/passwd</filename> entry, for security reasons. + </para> + + <para> + The session key of the Samba administrative account acts as an + encryption key for setting the password of the machine trust + account. The machine trust account will be created on-the-fly, or + updated if it already exists. + </para> + +</listitem> + +<listitem><para><emphasis>Windows NT</emphasis></para> + + <para> If the machine trust account was created manually, on the + Identification Changes menu enter the domain name, but do not + check the box "Create a Computer Account in the Domain." In this case, + the existing machine trust account is used to join the machine to + the domain.</para> + + <para> If the machine trust account is to be created + on-the-fly, on the Identification Changes menu enter the domain + name, and check the box "Create a Computer Account in the Domain." In + this case, joining the domain proceeds as above for Windows 2000 + (i.e., you must supply a Samba administrative account when + prompted).</para> +</listitem> + +<listitem><para><emphasis>Samba</emphasis></para> + <para>Joining a samba client to a domain is documented in + the <link linkend="domain-member">Domain Member</link> chapter. +</para></listitem> +</itemizedlist> + +</sect2> +</sect1> + +<sect1> +<title>Common Problems and Errors</title> + +<sect2> +<title>I cannot include a '$' in a machine name</title> +<para> +A 'machine name' in (typically) <filename>/etc/passwd</filename> +of the machine name with a '$' appended. FreeBSD (and other BSD +systems?) won't create a user with a '$' in their name. +</para> + +<para> +The problem is only in the program used to make the entry. Once made, it works perfectly. +Create a user without the '$' using <command>vipw</command> to edit the entry, adding +the '$'. Or create the whole entry with vipw if you like, make sure you use a unique User ID! +</para> +</sect2> + +<sect2> +<title>I get told "You already have a connection to the Domain...." +or "Cannot join domain, the credentials supplied conflict with an +existing set.." when creating a machine trust account.</title> + +<para> +This happens if you try to create a machine trust account from the +machine itself and already have a connection (e.g. mapped drive) +to a share (or IPC$) on the Samba PDC. The following command +will remove all network drive connections: +</para> + +<para> +<prompt>C:\WINNT\></prompt> <command>net use * /d</command> +</para> + +<para> +Further, if the machine is already a 'member of a workgroup' that +is the same name as the domain you are joining (bad idea) you will +get this message. Change the workgroup name to something else, it +does not matter what, reboot, and try again. +</para> +</sect2> + +<sect2> +<title>The system can not log you on (C000019B)....</title> + +<para>I joined the domain successfully but after upgrading +to a newer version of the Samba code I get the message, "The system +can not log you on (C000019B), Please try again or consult your +system administrator" when attempting to logon. +</para> + +<para> +This occurs when the domain SID stored in the secrets.tdb database +is changed. The most common cause of a change in domain SID is when +the domain name and/or the server name (netbios name) is changed. +The only way to correct the problem is to restore the original domain +SID or remove the domain client from the domain and rejoin. The domain +SID may be reset using either the net or rpcclient utilities. +</para> + +<para> +The reset or change the domain SID you can use the net command as follows: + +<programlisting> + net getlocalsid 'OLDNAME' + net setlocalsid 'SID' +</programlisting> +</para> + +</sect2> + +<sect2> +<title>The machine trust account for this computer either does not +exist or is not accessible.</title> + +<para> +When I try to join the domain I get the message "The machine account +for this computer either does not exist or is not accessible". What's +wrong? +</para> + +<para> +This problem is caused by the PDC not having a suitable machine trust account. +If you are using the <parameter>add machine script</parameter> method to create +accounts then this would indicate that it has not worked. Ensure the domain +admin user system is working. +</para> + +<para> +Alternatively if you are creating account entries manually then they +have not been created correctly. Make sure that you have the entry +correct for the machine trust account in smbpasswd file on the Samba PDC. +If you added the account using an editor rather than using the smbpasswd +utility, make sure that the account name is the machine NetBIOS name +with a '$' appended to it ( i.e. computer_name$ ). There must be an entry +in both /etc/passwd and the smbpasswd file. Some people have reported +that inconsistent subnet masks between the Samba server and the NT +client have caused this problem. Make sure that these are consistent +for both client and server. +</para> +</sect2> + +<sect2> +<title>When I attempt to login to a Samba Domain from a NT4/W2K workstation, +I get a message about my account being disabled.</title> + +<para> +At first be ensure to enable the useraccounts with <command>smbpasswd -e +%user%</command>, this is normally done, when you create an account. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Domain Control for Windows 9x/ME</title> + +<para> +A domain and a workgroup are exactly the same thing in terms of network +browsing. The difference is that a distributable authentication +database is associated with a domain, for secure login access to a +network. Also, different access rights can be granted to users if they +successfully authenticate against a domain logon server. Samba-3 does this +now in the same way that MS Windows NT/2K. +</para> + +<para> +The SMB client logging on to a domain has an expectation that every other +server in the domain should accept the same authentication information. +Network browsing functionality of domains and workgroups is identical and +is explained in this documentation under the browsing discussions. +It should be noted, that browsing is totally orthogonal to logon support. +</para> + +<para> +Issues related to the single-logon network model are discussed in this +section. Samba supports domain logons, network logon scripts, and user +profiles for MS Windows for workgroups and MS Windows 9X/ME clients +which are the focus of this section. +</para> + + +<para> +When an SMB client in a domain wishes to logon it broadcast requests for a +logon server. The first one to reply gets the job, and validates its +password using whatever mechanism the Samba administrator has installed. +It is possible (but very stupid) to create a domain where the user +database is not shared between servers, i.e. they are effectively workgroup +servers advertising themselves as participating in a domain. This +demonstrates how authentication is quite different from but closely +involved with domains. +</para> + + +<para> +Using these features you can make your clients verify their logon via +the Samba server; make clients run a batch file when they logon to +the network and download their preferences, desktop and start menu. +</para> + +<para> +Before launching into the configuration instructions, it is +worthwhile to look at how a Windows 9x/ME client performs a logon: +</para> + +<orderedlist> +<listitem> + <para> + The client broadcasts (to the IP broadcast address of the subnet it is in) + a NetLogon request. This is sent to the NetBIOS name DOMAIN<1c> at the + NetBIOS layer. The client chooses the first response it receives, which + contains the NetBIOS name of the logon server to use in the format of + \\SERVER. + </para> +</listitem> + +<listitem> + <para> + The client then connects to that server, logs on (does an SMBsessetupX) and + then connects to the IPC$ share (using an SMBtconX). + </para> +</listitem> + +<listitem> + <para> + The client then does a NetWkstaUserLogon request, which retrieves the name + of the user's logon script. + </para> +</listitem> + +<listitem> + <para> + The client then connects to the NetLogon share and searches for this + and if it is found and can be read, is retrieved and executed by the client. + After this, the client disconnects from the NetLogon share. + </para> +</listitem> + +<listitem> + <para> + The client then sends a NetUserGetInfo request to the server, to retrieve + the user's home share, which is used to search for profiles. Since the + response to the NetUserGetInfo request does not contain much more then + the user's home share, profiles for Win9X clients MUST reside in the user + home directory. + </para> +</listitem> + +<listitem> + <para> + The client then connects to the user's home share and searches for the + user's profile. As it turns out, you can specify the user's home share as + a sharename and path. For example, \\server\fred\.profile. + If the profiles are found, they are implemented. + </para> +</listitem> + +<listitem> + <para> + The client then disconnects from the user's home share, and reconnects to + the NetLogon share and looks for CONFIG.POL, the policies file. If this is + found, it is read and implemented. + </para> +</listitem> +</orderedlist> + + +<sect2> +<title>Configuration Instructions: Network Logons</title> + +<para> +The main difference between a PDC and a Windows 9x logon +server configuration is that +</para> + +<itemizedlist> + +<listitem><para> +Password encryption is not required for a Windows 9x logon server. +</para></listitem> + +<listitem><para> +Windows 9x/ME clients do not possess machine trust accounts. +</para></listitem> + +</itemizedlist> + +<para> +Therefore, a Samba PDC will also act as a Windows 9x logon +server. +</para> + + +<warning> +<title>security mode and master browsers</title> + +<para> +There are a few comments to make in order to tie up some +loose ends. There has been much debate over the issue of whether +or not it is ok to configure Samba as a Domain Controller in security +modes other than <constant>USER</constant>. The only security mode +which will not work due to technical reasons is <constant>SHARE</constant> +mode security. <constant>DOMAIN</constant> and <constant>SERVER</constant> +mode security is really just a variation on SMB user level security. +</para> + +<para> +Actually, this issue is also closely tied to the debate on whether +or not Samba must be the domain master browser for its workgroup +when operating as a DC. While it may technically be possible +to configure a server as such (after all, browsing and domain logons +are two distinctly different functions), it is not a good idea to do +so. You should remember that the DC must register the DOMAIN#1b NetBIOS +name. This is the name used by Windows clients to locate the DC. +Windows clients do not distinguish between the DC and the DMB. +For this reason, it is very wise to configure the Samba DC as the DMB. +</para> + +<para> +Now back to the issue of configuring a Samba DC to use a mode other +than "security = user". If a Samba host is configured to use +another SMB server or DC in order to validate user connection +requests, then it is a fact that some other machine on the network +(the "password server") knows more about the user than the Samba host. +99% of the time, this other host is a domain controller. Now +in order to operate in domain mode security, the "workgroup" parameter +must be set to the name of the Windows NT domain (which already +has a domain controller, right?) +</para> + +<para> +Therefore configuring a Samba box as a DC for a domain that +already by definition has a PDC is asking for trouble. +Therefore, you should always configure the Samba DC to be the DMB +for its domain. +</para> +</warning> + +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/ServerType.xml b/docs/docbook/projdoc/ServerType.xml new file mode 100644 index 0000000000..7229a50201 --- /dev/null +++ b/docs/docbook/projdoc/ServerType.xml @@ -0,0 +1,143 @@ +<chapter id="ServerType"> +<chapterinfo> + &author.jht; +</chapterinfo> + +<title>Nomenclature of Server Types</title> + +<para>Adminstrators of Microsoft networks often refer to there being three +different type of servers:</para> + +<itemizedlist> + <listitem><para>Stand Alone Server</para></listitem> + <listitem><para>Domain Member Server</para></listitem> + <listitem><para>Domain Controller</para> + <itemizedlist> + <listitem><para>Primary Domain Controller</para></listitem> + <listitem><para>Backup Domain Controller</para></listitem> + <listitem><para>ADS Domain Controller</para></listitem> + </itemizedlist> + </listitem> +</itemizedlist> + +<para>A network administrator who is familiar with these terms and who +wishes to migrate to or use Samba will want to know what these terms mean +within a Samba context.</para> + +<sect1> +<title>Stand Alone Server</title> + +<para> +The term <emphasis>stand alone server</emphasis> means that the server +will provide local authentication and access control for all resources +that are available from it. In general this means that there will be a +local user database. In more technical terms, it means that resources +on the machine will either be made available in either SHARE mode or in +USER mode. SHARE mode and USER mode security are documented under +discussions regarding "security mode". The smb.conf configuration parameters +that control security mode are: "security = user" and "security = share". +</para> + +<para> +No special action is needed other than to create user accounts. Stand-alone +servers do NOT provide network logon services, meaning that machines that +use this server do NOT perform a domain logon but instead make use only of +the MS Windows logon which is local to the MS Windows workstation/server. +</para> + +<para> +Samba tends to blur the distinction a little in respect of what is +a stand alone server. This is because the authentication database may be +local or on a remote server, even if from the samba protocol perspective +the samba server is NOT a member of a domain security context. +</para> + +<para> +Through the use of PAM (Pluggable Authentication Modules) and nsswitch +(the name service switcher) the source of authentication may reside on +another server. We would be inclined to call this the authentication server. +This means that the samba server may use the local Unix/Linux system +password database (/etc/passwd or /etc/shadow), may use a local smbpasswd +file (/etc/samba/smbpasswd or /usr/local/samba/lib/private/smbpasswd), or +may use an LDAP back end, or even via PAM and Winbind another CIFS/SMB +server for authentication. +</para> + +</sect1> + +<sect1> +<title>Domain Member Server</title> + +<para> +This mode of server operation involves the samba machine being made a member +of a domain security context. This means by definition that all user authentication +will be done from a centrally defined authentication regime. The authentication +regime may come from an NT3/4 style (old domain technology) server, or it may be +provided from an Active Directory server (ADS) running on MS Windows 2000 or later. +</para> + +<para><emphasis> +Of course it should be clear that the authentication back end itself could be from any +distributed directory architecture server that is supported by Samba. This can be +LDAP (from OpenLDAP), or Sun's iPlanet, of NetWare Directory Server, etc. +</emphasis></para> + +<para> +Please refer to the section on Howto configure Samba as a Primary Domain Controller +and for more information regarding how to create a domain machine account for a +domain member server as well as for information regarding how to enable the samba +domain member machine to join the domain and to be fully trusted by it. +</para> + +</sect1> + +<sect1> +<title>Domain Controller</title> + +<para> +Over the years public perceptions of what Domain Control really is has taken on an +almost mystical nature. Before we branch into a brief overview of what Domain Control +is the following types of controller are known: +</para> + +<sect2> +<title>Domain Controller Types</title> + +<simplelist> + <member>Primary Domain Controller</member> + <member>Backup Domain Controller</member> + <member>ADS Domain Controller</member> +</simplelist> + +<para> +The <emphasis>Primary Domain Controller</emphasis> or PDC plays an important role in the MS +Windows NT3 and NT4 Domain Control architecture, but not in the manner that so many +expect. The PDC seeds the Domain Control database (a part of the Windows registry) and +it plays a key part in synchronisation of the domain authentication database. +</para> + +<para> +New to Samba-3.0.0 is the ability to use a back-end file that holds the same type of data as +the NT4 style SAM (Security Account Manager) database (one of the registry files). +The samba-3.0.0 SAM can be specified via the smb.conf file parameter "passwd backend" and +valid options include <emphasis> smbpasswd tdbsam ldapsam nisplussam plugin unixsam</emphasis>. +The smbpasswd, tdbsam and ldapsam options can have a "_nua" suffix to indicate that No Unix +Accounts need to be created. In other words, the Samba SAM will be independant of Unix/Linux +system accounts, provided a uid range is defined from which SAM accounts can be created. +</para> + +<para> +The <emphasis>Backup Domain Controller</emphasis> or BDC plays a key role in servicing network +authentication requests. The BDC is biased to answer logon requests so that on a network segment +that has a BDC and a PDC the BDC will be most likely to service network logon requests. The PDC will +answer network logon requests when the BDC is too busy (high load). A BDC can be promoted to +a PDC. If the PDC is on line at the time that the BDC is promoted to PDC the previous PDC is +automatically demoted to a BDC. +</para> + +<para> +At this time Samba is NOT capable of acting as an <emphasis>ADS Domain Controller</emphasis>. +</para> +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/Speed.xml b/docs/docbook/projdoc/Speed.xml new file mode 100644 index 0000000000..2509883916 --- /dev/null +++ b/docs/docbook/projdoc/Speed.xml @@ -0,0 +1,211 @@ +<chapter id="speed"> + +<chapterinfo> + <author> + <firstname>Paul</firstname><surname>Cochrane</surname> + <affiliation> + <orgname>Dundee Limb Fitting Centre</orgname> + <address><email>paulc@dth.scot.nhs.uk</email></address> + </affiliation> + </author> + &author.jelmer; +</chapterinfo> + +<title>Samba performance issues</title> + +<sect1> +<title>Comparisons</title> + +<para> +The Samba server uses TCP to talk to the client. Thus if you are +trying to see if it performs well you should really compare it to +programs that use the same protocol. The most readily available +programs for file transfer that use TCP are ftp or another TCP based +SMB server. +</para> + +<para> +If you want to test against something like a NT or WfWg server then +you will have to disable all but TCP on either the client or +server. Otherwise you may well be using a totally different protocol +(such as Netbeui) and comparisons may not be valid. +</para> + +<para> +Generally you should find that Samba performs similarly to ftp at raw +transfer speed. It should perform quite a bit faster than NFS, +although this very much depends on your system. +</para> + +<para> +Several people have done comparisons between Samba and Novell, NFS or +WinNT. In some cases Samba performed the best, in others the worst. I +suspect the biggest factor is not Samba vs some other system but the +hardware and drivers used on the various systems. Given similar +hardware Samba should certainly be competitive in speed with other +systems. +</para> + +</sect1> + +<sect1> +<title>Socket options</title> + +<para> +There are a number of socket options that can greatly affect the +performance of a TCP based server like Samba. +</para> + +<para> +The socket options that Samba uses are settable both on the command +line with the -O option, or in the smb.conf file. +</para> + +<para> +The <command>socket options</command> section of the &smb.conf; manual page describes how +to set these and gives recommendations. +</para> + +<para> +Getting the socket options right can make a big difference to your +performance, but getting them wrong can degrade it by just as +much. The correct settings are very dependent on your local network. +</para> + +<para> +The socket option TCP_NODELAY is the one that seems to make the +biggest single difference for most networks. Many people report that +adding <command>socket options = TCP_NODELAY</command> doubles the read +performance of a Samba drive. The best explanation I have seen for this is +that the Microsoft TCP/IP stack is slow in sending tcp ACKs. +</para> + +</sect1> + +<sect1> +<title>Read size</title> + +<para> +The option <command>read size</command> affects the overlap of disk +reads/writes with network reads/writes. If the amount of data being +transferred in several of the SMB commands (currently SMBwrite, SMBwriteX and +SMBreadbraw) is larger than this value then the server begins writing +the data before it has received the whole packet from the network, or +in the case of SMBreadbraw, it begins writing to the network before +all the data has been read from disk. +</para> + +<para> +This overlapping works best when the speeds of disk and network access +are similar, having very little effect when the speed of one is much +greater than the other. +</para> + +<para> +The default value is 16384, but very little experimentation has been +done yet to determine the optimal value, and it is likely that the best +value will vary greatly between systems anyway. A value over 65536 is +pointless and will cause you to allocate memory unnecessarily. +</para> + +</sect1> + +<sect1> +<title>Max xmit</title> + +<para> +At startup the client and server negotiate a <command>maximum transmit</command> size, +which limits the size of nearly all SMB commands. You can set the +maximum size that Samba will negotiate using the <command>max xmit = </command> option +in &smb.conf;. Note that this is the maximum size of SMB requests that +Samba will accept, but not the maximum size that the *client* will accept. +The client maximum receive size is sent to Samba by the client and Samba +honours this limit. +</para> + +<para> +It defaults to 65536 bytes (the maximum), but it is possible that some +clients may perform better with a smaller transmit unit. Trying values +of less than 2048 is likely to cause severe problems. +</para> + +<para> +In most cases the default is the best option. +</para> + +</sect1> + +<sect1> +<title>Log level</title> + +<para> +If you set the log level (also known as <command>debug level</command>) higher than 2 +then you may suffer a large drop in performance. This is because the +server flushes the log file after each operation, which can be very +expensive. +</para> +</sect1> + +<sect1> +<title>Read raw</title> + +<para> +The <command>read raw</command> operation is designed to be an optimised, low-latency +file read operation. A server may choose to not support it, +however. and Samba makes support for <command>read raw</command> optional, with it +being enabled by default. +</para> + +<para> +In some cases clients don't handle <command>read raw</command> very well and actually +get lower performance using it than they get using the conventional +read operations. +</para> + +<para> +So you might like to try <command>read raw = no</command> and see what happens on your +network. It might lower, raise or not affect your performance. Only +testing can really tell. +</para> + +</sect1> + +<sect1> +<title>Write raw</title> + +<para> +The <command>write raw</command> operation is designed to be an optimised, low-latency +file write operation. A server may choose to not support it, +however. and Samba makes support for <command>write raw</command> optional, with it +being enabled by default. +</para> + +<para> +Some machines may find <command>write raw</command> slower than normal write, in which +case you may wish to change this option. +</para> + +</sect1> + +<sect1> +<title>Slow Logins</title> + +<para> +Slow logins are almost always due to the password checking time. Using +the lowest practical <command>password level</command> will improve things. +</para> + +</sect1> + +<sect1> +<title>Client tuning</title> + +<para> +Often a speed problem can be traced to the client. The client (for +example Windows for Workgroups) can often be tuned for better TCP +performance. Check the sections on the various clients in +<link linkend="Other-Clients">Samba and Other Clients</link>. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/UNIX_INSTALL.xml b/docs/docbook/projdoc/UNIX_INSTALL.xml new file mode 100644 index 0000000000..3ad83c1f9d --- /dev/null +++ b/docs/docbook/projdoc/UNIX_INSTALL.xml @@ -0,0 +1,176 @@ +<chapter id="install"> +<chapterinfo> + &author.tridge; + &author.jelmer; + <author><firstname>Karl</firstname><surname>Auer</surname></author> + <!-- Isn't some of this written by others as well? --> + +</chapterinfo> + +<title>How to Install and Test SAMBA</title> + +<sect1> + <title>Obtaining and installing samba</title> + + <para>Binary packages of samba are included in almost any Linux or + Unix distribution. There are also some packages available at + <ulink url="http://samba.org/">the samba homepage</ulink>. + </para> + + <para>If you need to compile samba from source, check the + <link linkend="compiling">appropriate appendix chapter</link>.</para> +</sect1> + +<sect1> + <title>Configuring samba</title> + + <para>Samba's configuration is stored in the smb.conf file, + that usually resides in <filename>/etc/samba/smb.conf</filename> + or <filename>/usr/local/samba/lib/smb.conf</filename>. You can either + edit this file yourself or do it using one of the many graphical + tools that are available, such as the web-based interface swat, that + is included with samba.</para> + +<sect2> + <title>Editing the <filename>smb.conf</filename> file</title> + + <para>There are sample configuration files in the examples + subdirectory in the distribution. I suggest you read them + carefully so you can see how the options go together in + practice. See the man page for all the options.</para> + + <para>The simplest useful configuration file would be + something like this:</para> + + <para><programlisting> +[global] + workgroup = MYGROUP + +[homes] + guest ok = no + read only = no + </programlisting></para> + + <para>which would allow connections by anyone with an + account on the server, using either their login name or + "<command>homes</command>" as the service name. (Note that I also set the + workgroup that Samba is part of. See BROWSING.txt for details)</para> + + <para>Make sure you put the <filename>smb.conf</filename> file in the same place + you specified in the<filename>Makefile</filename> (the default is to + look for it in <filename>/usr/local/samba/lib/</filename>).</para> + + <para>For more information about security settings for the + <command>[homes]</command> share please refer to the chapter + <link linkend="securing-samba">Securing Samba</link>.</para> + +<sect3> + <title>Test your config file with + <command>testparm</command></title> + + <para>It's important that you test the validity of your + <filename>smb.conf</filename> file using the <application>testparm</application> program. + If testparm runs OK then it will list the loaded services. If + not it will give an error message.</para> + + <para>Make sure it runs OK and that the services look + reasonable before proceeding. </para> + + <para>Always run testparm again when you change + <filename>smb.conf</filename>!</para> + +</sect3> +</sect2> + + <sect2> + <title>SWAT</title> + + <para> + SWAT is a web-based interface that helps you configure samba. + SWAT might not be available in the samba package on your platform, + but in a separate package. Please read the swat manpage + on compiling, installing and configuring swat from source. + </para> + + <para>To launch SWAT just run your favorite web browser and + point it at "http://localhost:901/". Replace <replaceable>localhost</replaceable> with the name of the computer you are running samba on if you + are running samba on a different computer than your browser.</para> + + <para>Note that you can attach to SWAT from any IP connected + machine but connecting from a remote machine leaves your + connection open to password sniffing as passwords will be sent + in the clear over the wire. </para> + </sect2> +</sect1> + +<sect1> + <title>Try listing the shares available on your + server</title> + + <para><prompt>$ </prompt><userinput>smbclient -L + <replaceable>yourhostname</replaceable></userinput></para> + + <para>You should get back a list of shares available on + your server. If you don't then something is incorrectly setup. + Note that this method can also be used to see what shares + are available on other LanManager clients (such as WfWg).</para> + + <para>If you choose user level security then you may find + that Samba requests a password before it will list the shares. + See the <command>smbclient</command> man page for details. (you + can force it to list the shares without a password by + adding the option -U% to the command line. This will not work + with non-Samba servers)</para> +</sect1> + +<sect1> + <title>Try connecting with the unix client</title> + + <para><prompt>$ </prompt><userinput>smbclient <replaceable> + //yourhostname/aservice</replaceable></userinput></para> + + <para>Typically the <replaceable>yourhostname</replaceable> + would be the name of the host where you installed &smbd;. + The <replaceable>aservice</replaceable> is + any service you have defined in the &smb.conf; + file. Try your user name if you just have a <command>[homes]</command> + section + in &smb.conf;.</para> + + <para>For example if your unix host is <replaceable>bambi</replaceable> + and your login name is <replaceable>fred</replaceable> you would type:</para> + + <para><prompt>$ </prompt><userinput>smbclient //<replaceable>bambi</replaceable>/<replaceable>fred</replaceable> + </userinput></para> +</sect1> + +<sect1> + <title>Try connecting from a DOS, WfWg, Win9x, WinNT, + Win2k, OS/2, etc... client</title> + + <para>Try mounting disks. eg:</para> + + <para><prompt>C:\WINDOWS\> </prompt><userinput>net use d: \\servername\service + </userinput></para> + + <para>Try printing. eg:</para> + + <para><prompt>C:\WINDOWS\> </prompt><userinput>net use lpt1: + \\servername\spoolservice</userinput></para> + + <para><prompt>C:\WINDOWS\> </prompt><userinput>print filename + </userinput></para> +</sect1> + +<sect1> + <title>What If Things Don't Work?</title> + + <para>Then you might read the file chapter + <link linkend="diagnosis">Diagnosis</link> and the + FAQ. If you are still stuck then try to follow + the <link linkend="problems">Analysing and Solving Problems chapter</link> + Samba has been successfully installed at thousands of sites worldwide, + so maybe someone else has hit your problem and has overcome it. </para> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/VFS.xml b/docs/docbook/projdoc/VFS.xml new file mode 100644 index 0000000000..225411b427 --- /dev/null +++ b/docs/docbook/projdoc/VFS.xml @@ -0,0 +1,230 @@ +<chapter id="VFS"> +<chapterinfo> + &author.jelmer; + &author.jht; + <author><firstname>Alexander</firstname><surname>Bokovoy</surname></author> + <author><firstname>Tim</firstname><surname>Potter</surname></author> + <author><firstname>Simo</firstname><surname>Sorce</surname></author> +</chapterinfo> +<title>Stackable VFS modules</title> + +<sect1> +<title>Introduction and configuration</title> + +<para> +Since samba 3.0, samba supports stackable VFS(Virtual File System) modules. +Samba passes each request to access the unix file system thru the loaded VFS modules. +This chapter covers all the modules that come with the samba source and references to +some external modules. +</para> + +<para> +You may have problems to compile these modules, as shared libraries are +compiled and linked in different ways on different systems. +They currently have been tested against GNU/linux and IRIX. +</para> + +<para> +To use the VFS modules, create a share similar to the one below. The +important parameter is the <command>vfs object</command> parameter which must point to +the exact pathname of the shared library objects. For example, to log all access +to files and use a recycle bin: + +<programlisting> + [audit] + comment = Audited /data directory + path = /data + vfs object = /path/to/audit.so /path/to/recycle.so + writeable = yes + browseable = yes +</programlisting> +</para> + +<para> +The modules are used in the order they are specified. +</para> + +<para> +Further documentation on writing VFS modules for Samba can be found in +the Samba Developers Guide. +</para> + +</sect1> + +<sect1> +<title>Included modules</title> + +<sect2> +<title>audit</title> +<para>A simple module to audit file access to the syslog +facility. The following operations are logged: +<simplelist> +<member>share</member> +<member>connect/disconnect</member> +<member>directory opens/create/remove</member> +<member>file open/close/rename/unlink/chmod</member> +</simplelist> +</para> +</sect2> + +<sect2> +<title>extd_audit</title> +<para> +This module is identical with the <emphasis>audit</emphasis> module above except +that it sends audit logs to both syslog as well as the smbd log file/s. The +loglevel for this module is set in the smb.conf file. +</para> + +<para> +The logging information that will be written to the smbd log file is controlled by +the <emphasis>log level</emphasis> parameter in <filename>smb.conf</filename>. The +following information will be recorded: +</para> + +<table frame="all"><title>Extended Auditing Log Information</title> +<tgroup cols="2" align="center"> + <thead> + <row><entry align="center">Log Level</entry><entry>Log Details - File and Directory Operations</entry></row> + </thead> + <tbody> + <row><entry align="center">0</entry><entry align="left">Creation / Deletion</entry></row> + <row><entry align="center">1</entry><entry align="left">Create / Delete / Rename / Permission Changes</entry></row> + <row><entry align="center">2</entry><entry align="left">Create / Delete / Rename / Perm Change / Open / Close</entry></row> + </tbody> +</tgroup> +</table> + +</sect2> + +<sect2> +<title>recycle</title> +<para> +A recycle-bin like module. When used any unlink call +will be intercepted and files moved to the recycle +directory instead of being deleted. +</para> + +<para>Supported options: +<variablelist> + <varlistentry> + <term>vfs_recycle_bin:repository</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>vfs_recycle_bin:keeptree</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>vfs_recycle_bin:versions</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>vfs_recycle_bin:touch</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>vfs_recycle_bin:maxsize</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>vfs_recycle_bin:exclude</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>vfs_recycle_bin:exclude_dir</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> + + <varlistentry> + <term>vfs_recycle_bin:noversions</term> + <listitem><para>FIXME</para></listitem> + </varlistentry> +</variablelist> +</para> + +</sect2> + +<sect2> +<title>netatalk</title> +<para> +A netatalk module, that will ease co-existence of samba and +netatalk file sharing services. +</para> + +<para>Advantages compared to the old netatalk module: +<simplelist> +<member>it doesn't care about creating of .AppleDouble forks, just keeps them in sync</member> +<member>if share in smb.conf doesn't contain .AppleDouble item in hide or veto list, it will be added automatically</member> +</simplelist> +</para> + +</sect2> + +</sect1> + +<sect1> +<title>VFS modules available elsewhere</title> + +<para> +This section contains a listing of various other VFS modules that +have been posted but don't currently reside in the Samba CVS +tree for one reason or another (e.g. it is easy for the maintainer +to have his or her own CVS tree). +</para> + +<para> +No statemets about the stability or functionality of any module +should be implied due to its presence here. +</para> + +<sect2> +<title>DatabaseFS</title> + +<para> +URL: <ulink url="http://www.css.tayloru.edu/~elorimer/databasefs/index.php">http://www.css.tayloru.edu/~elorimer/databasefs/index.php</ulink> +</para> + +<para>By <ulink url="mailto:elorimer@css.tayloru.edu">Eric Lorimer</ulink>.</para> + +<para> +I have created a VFS module which implements a fairly complete read-only +filesystem. It presents information from a database as a filesystem in +a modular and generic way to allow different databases to be used +(originally designed for organizing MP3s under directories such as +"Artists," "Song Keywords," etc... I have since applied it to a student +roster database very easily). The directory structure is stored in the +database itself and the module makes no assumptions about the database +structure beyond the table it requires to run. +</para> + +<para> +Any feedback would be appreciated: comments, suggestions, patches, +etc... If nothing else, hopefully it might prove useful for someone +else who wishes to create a virtual filesystem. +</para> + +</sect2> + +<sect2> +<title>vscan</title> +<para>URL: <ulink url="http://www.openantivirus.org/">http://www.openantivirus.org/</ulink></para> + +<para> +samba-vscan is a proof-of-concept module for Samba, which +uses the VFS (virtual file system) features of Samba 2.2.x/3.0 +alphaX. Of couse, Samba has to be compiled with VFS support. +samba-vscan supports various virus scanners and is maintained +by Rainer Link. +</para> + +</sect2> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/locking.xml b/docs/docbook/projdoc/locking.xml new file mode 100644 index 0000000000..adb4356497 --- /dev/null +++ b/docs/docbook/projdoc/locking.xml @@ -0,0 +1,396 @@ +<chapter id="locking"> +<chapterinfo> + &author.jeremy; + &author.jelmer; + &author.jht; +</chapterinfo> +<title>File and Record Locking</title> + +<sect1> +<title>Discussion</title> + +<para> +One area which sometimes causes trouble is locking. +</para> + +<para> +There are two types of locking which need to be performed by a SMB server. +The first is <emphasis>record locking</emphasis> which allows a client to lock +a range of bytes in a open file. The second is the <emphasis>deny modes</emphasis> +that are specified when a file is open. +</para> + +<para> +Record locking semantics under Unix is very different from record locking under +Windows. Versions of Samba before 2.2 have tried to use the native fcntl() unix +system call to implement proper record locking between different Samba clients. +This can not be fully correct due to several reasons. The simplest is the fact +that a Windows client is allowed to lock a byte range up to 2^32 or 2^64, +depending on the client OS. The unix locking only supports byte ranges up to 2^31. +So it is not possible to correctly satisfy a lock request above 2^31. There are +many more differences, too many to be listed here. +</para> + +<para> +Samba 2.2 and above implements record locking completely independent of the +underlying unix system. If a byte range lock that the client requests happens +to fall into the range 0-2^31, Samba hands this request down to the Unix system. +All other locks can not be seen by unix anyway. +</para> + +<para> +Strictly a SMB server should check for locks before every read and write call on +a file. Unfortunately with the way fcntl() works this can be slow and may overstress +the rpc.lockd. It is also almost always unnecessary as clients are supposed to +independently make locking calls before reads and writes anyway if locking is +important to them. By default Samba only makes locking calls when explicitly asked +to by a client, but if you set <emphasis>strict locking = yes</emphasis> then it +will make lock checking calls on every read and write. +</para> + +<para> +You can also disable by range locking completely using <emphasis>locking = no</emphasis>. +This is useful for those shares that don't support locking or don't need it +(such as cdroms). In this case Samba fakes the return codes of locking calls to +tell clients that everything is OK. +</para> + +<para> +The second class of locking is the <emphasis>deny modes</emphasis>. These +are set by an application when it opens a file to determine what types of +access should be allowed simultaneously with its open. A client may ask for +DENY_NONE, DENY_READ, DENY_WRITE or DENY_ALL. There are also special compatibility +modes called DENY_FCB and DENY_DOS. +</para> +</sect1> + +<sect1> +<title>Samba Opportunistic Locking Control</title> + +<para> +Opportunistic locking essentially means that the client is allowed to download and cache +a file on their hard drive while making changes; if a second client wants to access the +file, the first client receives a break and must synchronise the file back to the server. +This can give significant performance gains in some cases; some programs insist on +synchronising the contents of the entire file back to the server for a single change. +</para> + +<para> +Level1 Oplocks (aka just plain "oplocks") is another term for opportunistic locking. +</para> + +<para> +Level2 Oplocks provids opportunistic locking for a file that will be treated as +<emphasis>read only</emphasis>. Typically this is used on files that are read-only or +on files that the client has no initial intention to write to at time of opening the file. +</para> + +<para> +Kernel Oplocks are essentially a method that allows the Linux kernel to co-exist with +Samba's oplocked files, although this has provided better integration of MS Windows network +file locking with the under lying OS, SGI IRIX and Linux are the only two OS's that are +oplock aware at this time. +</para> + +<para> +Unless your system supports kernel oplocks, you should disable oplocks if you are +accessing the same files from both Unix/Linux and SMB clients. Regardless, oplocks should +always be disabled if you are sharing a database file (e.g., Microsoft Access) between +multiple clients, as any break the first client receives will affect synchronisation of +the entire file (not just the single record), which will result in a noticable performance +impairment and, more likely, problems accessing the database in the first place. Notably, +Microsoft Outlook's personal folders (*.pst) react very badly to oplocks. If in doubt, +disable oplocks and tune your system from that point. +</para> + +<para> +If client-side caching is desirable and reliable on your network, you will benefit from +turning on oplocks. If your network is slow and/or unreliable, or you are sharing your +files among other file sharing mechanisms (e.g., NFS) or across a WAN, or multiple people +will be accessing the same files frequently, you probably will not benefit from the overhead +of your client sending oplock breaks and will instead want to disable oplocks for the share. +</para> + +<para> +Another factor to consider is the perceived performance of file access. If oplocks provide no +measurable speed benefit on your network, it might not be worth the hassle of dealing with them. +</para> + +<para> +You can disable oplocks on a per-share basis with the following: + +<programlisting> + oplocks = False + level2 oplocks = False +</programlisting> + +Alternately, you could disable oplocks on a per-file basis within the share: + +<programlisting> + veto oplock files = /*.mdb/*.MDB/*.dbf/*.DBF/ +</programlisting> +</para> + +<para> +If you are experiencing problems with oplocks as apparent from Samba's log entries, +you may want to play it safe and disable oplocks and level2 oplocks. +</para> + +</sect1> + +<sect1> +<title>MS Windows Opportunistic Locking and Caching Controls</title> + +<para> +There is a known issue when running applications (like Norton Anti-Virus) on a Windows 2000/ XP +workstation computer that can affect any application attempting to access shared database files +across a network. This is a result of a default setting configured in the Windows 2000/XP +operating system known as <emphasis>Opportunistic Locking</emphasis>. When a workstation +attempts to access shared data files located on another Windows 2000/XP computer, +the Windows 2000/XP operating system will attempt to increase performance by locking the +files and caching information locally. When this occurs, the application is unable to +properly function, which results in an <emphasis>Access Denied</emphasis> + error message being displayed during network operations. +</para> + +<para> +All Windows operating systems in the NT family that act as database servers for data files +(meaning that data files are stored there and accessed by other Windows PCs) may need to +have opportunistic locking disabled in order to minimize the risk of data file corruption. +This includes Windows 9x/Me, Windows NT, Windows 200x and Windows XP. +</para> + +<para> +If you are using a Windows NT family workstation in place of a server, you must also +disable opportunistic locking (oplocks) on that workstation. For example, if you use a +PC with the Windows NT Workstation operating system instead of Windows NT Server, and you +have data files located on it that are accessed from other Windows PCs, you may need to +disable oplocks on that system. +</para> + +<para> +The major difference is the location in the Windows registry where the values for disabling +oplocks are entered. Instead of the LanManServer location, the LanManWorkstation location +may be used. +</para> + +<para> +You can verify (or change or add, if necessary) this Registry value using the Windows +Registry Editor. When you change this registry value, you will have to reboot the PC +to ensure that the new setting goes into effect. +</para> + +<para> +The location of the client registry entry for opportunistic locking has changed in +Windows 2000 from the earlier location in Microsoft Windows NT. +</para> + +<note><para> +Windows 2000 will still respect the EnableOplocks registry value used to disable oplocks +in earlier versions of Windows. +</para></note> + +<para> +You can also deny the granting of opportunistic locks by changing the following registry entries: +</para> + +<para> +<programlisting> + HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\MRXSmb\Parameters\ + + OplocksDisabled REG_DWORD 0 or 1 + Default: 0 (not disabled) +</programlisting> +</para> + +<note><para> +The OplocksDisabled registry value configures Windows clients to either request or not +request opportunistic locks on a remote file. To disable oplocks, the value of + OplocksDisabled must be set to 1. +</para></note> + +<para> +<programlisting> + HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\LanmanServer\Parameters + + EnableOplocks REG_DWORD 0 or 1 + Default: 1 (Enabled by Default) + + EnableOpLockForceClose REG_DWORD 0 or 1 + Default: 0 (Disabled by Default) +</programlisting> +</para> + +<note><para> +The EnableOplocks value configures Windows-based servers (including Workstations sharing +files) to allow or deny opportunistic locks on local files. +</para></note> + +<para> +To force closure of open oplocks on close or program exit EnableOpLockForceClose must be set to 1. +</para> + +<para> +An illustration of how level II oplocks work: +</para> + +<itemizedlist> + <listitem><para> + Station 1 opens the file, requesting oplock. + </para></listitem> + <listitem><para> + Since no other station has the file open, the server grants station 1 exclusive oplock. + </para></listitem> + <listitem><para> + Station 2 opens the file, requesting oplock. + </para></listitem> + <listitem><para> + Since station 1 has not yet written to the file, the server asks station 1 to Break + to Level II Oplock. + </para></listitem> + <listitem><para> + Station 1 complies by flushing locally buffered lock information to the server. + </para></listitem> + <listitem><para> + Station 1 informs the server that it has Broken to Level II Oplock (alternatively, + station 1 could have closed the file). + </para></listitem> + <listitem><para> + The server responds to station 2's open request, granting it level II oplock. + Other stations can likewise open the file and obtain level II oplock. + </para></listitem> + <listitem><para> + Station 2 (or any station that has the file open) sends a write request SMB. + The server returns the write response. + </para></listitem> + <listitem><para> + The server asks all stations that have the file open to Break to None, meaning no + station holds any oplock on the file. Because the workstations can have no cached + writes or locks at this point, they need not respond to the break-to-none advisory; + all they need do is invalidate locally cashed read-ahead data. + </para></listitem> +</itemizedlist> + +<sect2> +<title>Workstation Service Entries</title> + +<para><programlisting> + \HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters + + UseOpportunisticLocking REG_DWORD 0 or 1 + Default: 1 (true) +</programlisting></para> + +<para> +Indicates whether the redirector should use opportunistic-locking (oplock) performance +enhancement. This parameter should be disabled only to isolate problems. +</para> + +</sect2> +<sect2> +<title>Server Service Entries</title> + +<para><programlisting> + \HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\LanmanServer\Parameters + + EnableOplocks REG_DWORD 0 or 1 + Default: 1 (true) +</programlisting></para> + +<para> +Specifies whether the server allows clients to use oplocks on files. Oplocks are a +significant performance enhancement, but have the potential to cause lost cached +data on some networks, particularly wide-area networks. +</para> + +<para><programlisting> + MinLinkThroughput REG_DWORD 0 to infinite bytes per second + Default: 0 +</programlisting></para> + +<para> +Specifies the minimum link throughput allowed by the server before it disables +raw and opportunistic locks for this connection. +</para> + +<para><programlisting> + MaxLinkDelay REG_DWORD 0 to 100,000 seconds + Default: 60 +</programlisting></para> + +<para> +Specifies the maximum time allowed for a link delay. If delays exceed this number, +the server disables raw I/O and opportunistic locking for this connection. +</para> + +<para><programlisting> + OplockBreakWait REG_DWORD 10 to 180 seconds + Default: 35 +</programlisting></para> + +<para> +Specifies the time that the server waits for a client to respond to an oplock break +request. Smaller values can allow detection of crashed clients more quickly but can +potentially cause loss of cached data. +</para> + +</sect2> +</sect1> + +<sect1> +<title>Persistent Data Corruption</title> + +<para> +If you have applied all of the settings discussed in this paper but data corruption problems +and other symptoms persist, here are some additional things to check out: +</para> + +<para> +We have credible reports from developers that faulty network hardware, such as a single +faulty network card, can cause symptoms similar to read caching and data corruption. +If you see persistent data corruption even after repeated reindexing, you may have to +rebuild the data files in question. This involves creating a new data file with the +same definition as the file to be rebuilt and transferring the data from the old file +to the new one. There are several known methods for doing this that can be found in +our Knowledge Base. +</para> + +</sect1> + +<sect1> +<title>Additional Reading</title> + +<para> +You may want to check for an updated version of this white paper on our Web site from +time to time. Many of our white papers are updated as information changes. For those papers, +the Last Edited date is always at the top of the paper. +</para> + +<para> +Section of the Microsoft MSDN Library on opportunistic locking: +</para> + +<para> +Opportunistic Locks, Microsoft Developer Network (MSDN), Windows Development > +Windows Base Services > Files and I/O > SDK Documentation > File Storage > File Systems +> About File Systems > Opportunistic Locks, Microsoft Corporation. +<ulink url="http://msdn.microsoft.com/library/en-us/fileio/storage_5yk3.asp">http://msdn.microsoft.com/library/en-us/fileio/storage_5yk3.asp</ulink> +</para> + +<para> +Microsoft Knowledge Base Article Q224992 "Maintaining Transactional Integrity with OPLOCKS", +Microsoft Corporation, April 1999, <ulink url="=http://support.microsoft.com/default.aspx?scid=kb;en-us;Q224992">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q224992</ulink>. +</para> + +<para> +Microsoft Knowledge Base Article Q296264 "Configuring Opportunistic Locking in Windows 2000", +Microsoft Corporation, April 2001, <ulink url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q296264">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q296264</ulink>. +</para> + +<para> +Microsoft Knowledge Base Article Q129202 "PC Ext: Explanation of Opportunistic Locking on Windows NT", + Microsoft Corporation, April 1995, <ulink url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202</ulink>. +</para> + +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/msdfs_setup.xml b/docs/docbook/projdoc/msdfs_setup.xml new file mode 100644 index 0000000000..a86cd74235 --- /dev/null +++ b/docs/docbook/projdoc/msdfs_setup.xml @@ -0,0 +1,116 @@ +<chapter id="msdfs"> + +<chapterinfo> + <author> + <firstname>Shirish</firstname><surname>Kalele</surname> + <affiliation> + <orgname>Samba Team & Veritas Software</orgname> + <address> + <email>samba@samba.org</email> + </address> + </affiliation> + </author> + + <pubdate>12 Jul 2000</pubdate> +</chapterinfo> + + +<title>Hosting a Microsoft Distributed File System tree on Samba</title> + +<sect1> + + <title>Instructions</title> + + <para>The Distributed File System (or Dfs) provides a means of + separating the logical view of files and directories that users + see from the actual physical locations of these resources on the + network. It allows for higher availability, smoother storage expansion, + load balancing etc. For more information about Dfs, refer to <ulink + url="http://www.microsoft.com/NTServer/nts/downloads/winfeatures/NTSDistrFile/AdminGuide.asp"> + Microsoft documentation</ulink>. </para> + + <para>This document explains how to host a Dfs tree on a Unix + machine (for Dfs-aware clients to browse) using Samba.</para> + + <para>To enable SMB-based DFS for Samba, configure it with the + <parameter>--with-msdfs</parameter> option. Once built, a + Samba server can be made a Dfs server by setting the global + boolean <ulink url="smb.conf.5.html#HOSTMSDFS"><parameter> + host msdfs</parameter></ulink> parameter in the <filename>smb.conf + </filename> file. You designate a share as a Dfs root using the share + level boolean <ulink url="smb.conf.5.html#MSDFSROOT"><parameter> + msdfs root</parameter></ulink> parameter. A Dfs root directory on + Samba hosts Dfs links in the form of symbolic links that point + to other servers. For example, a symbolic link + <filename>junction->msdfs:storage1\share1</filename> in + the share directory acts as the Dfs junction. When Dfs-aware + clients attempt to access the junction link, they are redirected + to the storage location (in this case, \\storage1\share1).</para> + + <para>Dfs trees on Samba work with all Dfs-aware clients ranging + from Windows 95 to 2000.</para> + + <para>Here's an example of setting up a Dfs tree on a Samba + server.</para> + + <para><programlisting> +# The smb.conf file: +[global] + netbios name = SAMBA + host msdfs = yes + +[dfs] + path = /export/dfsroot + msdfs root = yes + </programlisting></para> + + + <para>In the /export/dfsroot directory we set up our dfs links to + other servers on the network.</para> + + <para><prompt>root# </prompt><userinput>cd /export/dfsroot</userinput></para> + <para><prompt>root# </prompt><userinput>chown root /export/dfsroot</userinput></para> + <para><prompt>root# </prompt><userinput>chmod 755 /export/dfsroot</userinput></para> + <para><prompt>root# </prompt><userinput>ln -s msdfs:storageA\\shareA linka</userinput></para> + <para><prompt>root# </prompt><userinput>ln -s msdfs:serverB\\share,serverC\\share linkb</userinput></para> + + + <para>You should set up the permissions and ownership of + the directory acting as the Dfs root such that only designated + users can create, delete or modify the msdfs links. Also note + that symlink names should be all lowercase. This limitation exists + to have Samba avoid trying all the case combinations to get at + the link name. Finally set up the symbolic links to point to the + network shares you want, and start Samba.</para> + + <para>Users on Dfs-aware clients can now browse the Dfs tree + on the Samba server at \\samba\dfs. Accessing + links linka or linkb (which appear as directories to the client) + takes users directly to the appropriate shares on the network.</para> + + <sect2> + <title>Notes</title> + + <itemizedlist> + <listitem><para>Windows clients need to be rebooted + if a previously mounted non-dfs share is made a dfs + root or vice versa. A better way is to introduce a + new share and make it the dfs root.</para> + </listitem> + + <listitem><para>Currently there's a restriction that msdfs + symlink names should all be lowercase.</para> + </listitem> + + <listitem><para>For security purposes, the directory + acting as the root of the Dfs tree should have ownership + and permissions set so that only designated users can + modify the symbolic links in the directory.</para> + </listitem> + </itemizedlist> + </sect2> +</sect1> + + + +</chapter> diff --git a/docs/docbook/projdoc/passdb.xml b/docs/docbook/projdoc/passdb.xml new file mode 100644 index 0000000000..cc497f7d93 --- /dev/null +++ b/docs/docbook/projdoc/passdb.xml @@ -0,0 +1,970 @@ +<chapter id="passdb"> +<chapterinfo> + &author.jelmer; + &author.jerry; + &author.jeremy; + &author.jht; + <author> + <firstname>Olivier (lem)</firstname><surname>Lemaire</surname> + <affiliation> + <orgname>IDEALX</orgname> + <address><email>olem@IDEALX.org</email></address> + </affiliation> + </author> + + <pubdate>February 2003</pubdate> +</chapterinfo> + +<title>User information database</title> + +<sect1> + <title>Introduction</title> + + <para>Old windows clients send plain text passwords over the wire. + Samba can check these passwords by crypting them and comparing them + to the hash stored in the unix user database. + </para> + + <para> + Newer windows clients send encrypted passwords (so-called + Lanman and NT hashes) over + the wire, instead of plain text passwords. The newest clients + will only send encrypted passwords and refuse to send plain text + passwords, unless their registry is tweaked. + </para> + + <para>These passwords can't be converted to unix style encrypted + passwords. Because of that you can't use the standard unix + user database, and you have to store the Lanman and NT hashes + somewhere else. </para> + + <para>Next to a differently encrypted passwords, + windows also stores certain data for each user + that is not stored in a unix user database, e.g. + workstations the user may logon from, the location where his/her + profile is stored, etc. + Samba retrieves and stores this information using a "passdb backend". + Commonly + available backends are LDAP, plain text file, MySQL and nisplus. + For more information, see the documentation about the + <command>passdb backend = </command> parameter. + </para> +</sect1> + +<sect1> + <title>Important Notes About Security</title> + + <para>The unix and SMB password encryption techniques seem similar + on the surface. This similarity is, however, only skin deep. The unix + scheme typically sends clear text passwords over the network when + logging in. This is bad. The SMB encryption scheme never sends the + cleartext password over the network but it does store the 16 byte + hashed values on disk. This is also bad. Why? Because the 16 byte hashed + values are a "password equivalent". You cannot derive the user's + password from them, but they could potentially be used in a modified + client to gain access to a server. This would require considerable + technical knowledge on behalf of the attacker but is perfectly possible. + You should thus treat the data stored in whatever + passdb backend you use (smbpasswd file, ldap, mysql) as though it contained the + cleartext passwords of all your users. Its contents must be kept + secret, and the file should be protected accordingly.</para> + + <para>Ideally we would like a password scheme which neither requires + plain text passwords on the net or on disk. Unfortunately this + is not available as Samba is stuck with being compatible with + other SMB systems (WinNT, WfWg, Win95 etc). </para> + + <warning> + <para>Note that Windows NT 4.0 Service pack 3 changed the + default for permissible authentication so that plaintext + passwords are <emphasis>never</emphasis> sent over the wire. + The solution to this is either to switch to encrypted passwords + with Samba or edit the Windows NT registry to re-enable plaintext + passwords. See the document WinNT.txt for details on how to do + this.</para> + + <para>Other Microsoft operating systems which also exhibit + this behavior includes</para> + + <para> These versions of MS Windows do not support full domain + security protocols, although they may log onto a domain environment. + Of these Only MS Windows XP Home does NOT support domain logons.</para> + + <simplelist> + <member>MS DOS Network client 3.0 with + the basic network redirector installed</member> + + <member>Windows 95 with the network redirector + update installed</member> + + <member>Windows 98 [se]</member> + + <member>Windows Me</member> + + <member>Windows XP Home</member> + </simplelist> + + <para> The following versions of MS Windows fully support domain + security protocols.</para> + + <simplelist> + <member>Windows NT 3.5x</member> + <member>Windows NT 4.0</member> + <member>Windows 2000 Professional</member> + <member>Windows 200x Server/Advanced Server</member> + <member>Windows XP Professional</member> + </simplelist> + </warning> + + <note><para>All current release of + Microsoft SMB/CIFS clients support authentication via the + SMB Challenge/Response mechanism described here. Enabling + clear text authentication does not disable the ability + of the client to participate in encrypted authentication.</para></note> + + <para>MS Windows clients will cache the encrypted password alone. + Even when plain text passwords are re-enabled, through the appropriate + registry change, the plain text password is NEVER cached. This means that + in the event that a network connections should become disconnected (broken) + only the cached (encrypted) password will be sent to the resource server + to affect a auto-reconnect. If the resource server does not support encrypted + passwords the auto-reconnect will fail. <emphasis>USE OF ENCRYPTED PASSWORDS + IS STRONGLY ADVISED.</emphasis></para> + + <sect2> + <title>Advantages of SMB Encryption</title> + + <simplelist> + <member>Plain text passwords are not passed across + the network. Someone using a network sniffer cannot just + record passwords going to the SMB server.</member> + + <member>WinNT doesn't like talking to a server + that does not support encrypted passwords. It will refuse + to browse the server if the server is also in user level + security mode. It will insist on prompting the user for the + password on each connection, which is very annoying. The + only things you can do to stop this is to use SMB encryption. + </member> + + <member>Encrypted password support allows automatic share + (resource) reconnects.</member> + </simplelist> + </sect2> + + + <sect2> + <title>Advantages of non-encrypted passwords</title> + + <simplelist> + <member>Plain text passwords are not kept + on disk, and are NOT cached in memory. </member> + + <member>Uses same password file as other unix + services such as login and ftp</member> + + <member>Use of other services (such as telnet and ftp) which + send plain text passwords over the net, so sending them for SMB + isn't such a big deal.</member> + </simplelist> + </sect2> +</sect1> + + +<sect1> + <title>The smbpasswd Command</title> + + <para>The smbpasswd utility is a utility similar to the + <command>passwd</command> or <command>yppasswd</command> programs. + It maintains the two 32 byte password fields in the passdb backend. </para> + + <para><command>smbpasswd</command> works in a client-server mode + where it contacts the local smbd to change the user's password on its + behalf. This has enormous benefits - as follows.</para> + + <para><command>smbpasswd</command> has the capability + to change passwords on Windows NT servers (this only works when + the request is sent to the NT Primary Domain Controller if you + are changing an NT Domain user's password).</para> + + <para>To run smbpasswd as a normal user just type :</para> + + <para><prompt>$ </prompt><userinput>smbpasswd</userinput></para> + <para><prompt>Old SMB password: </prompt><userinput><type old value here - + or hit return if there was no old password></userinput></para> + <para><prompt>New SMB Password: </prompt><userinput><type new value> + </userinput></para> + <para><prompt>Repeat New SMB Password: </prompt><userinput><re-type new value + </userinput></para> + + <para>If the old value does not match the current value stored for + that user, or the two new values do not match each other, then the + password will not be changed.</para> + + <para>If invoked by an ordinary user it will only allow the user + to change his or her own Samba password.</para> + + <para>If run by the root user smbpasswd may take an optional + argument, specifying the user name whose SMB password you wish to + change. Note that when run as root smbpasswd does not prompt for + or check the old password value, thus allowing root to set passwords + for users who have forgotten their passwords.</para> + + <para><command>smbpasswd</command> is designed to work in the same way + and be familiar to UNIX users who use the <command>passwd</command> or + <command>yppasswd</command> commands.</para> + + <para>For more details on using <command>smbpasswd</command> refer + to the man page which will always be the definitive reference.</para> +</sect1> + +<!-- +<sect1> +<title>The <command>pdbedit</command> command</title> +FIXME +</sect1> +--> + +<sect1> +<title>Plain text</title> +<para> +Older versions of samba retrieved user information from the unix user database +and eventually some other fields from the file <filename>/etc/samba/smbpasswd</filename> +or <filename>/etc/smbpasswd</filename>. When password encryption is disabled, no +data is stored at all. +</para> +</sect1> + +<sect1> +<title>TDB</title> +<para>Samba can also store the user data in a "TDB" (Trivial Database). Using this backend +doesn't require any additional configuration. This backend is recommended for new installations that +don not require LDAP. +</para> +</sect1> + +<sect1> +<title>LDAP</title> + +<sect2> +<title>Introduction</title> + +<para> +This document describes how to use an LDAP directory for storing Samba user +account information traditionally stored in the smbpasswd(5) file. It is +assumed that the reader already has a basic understanding of LDAP concepts +and has a working directory server already installed. For more information +on LDAP architectures and Directories, please refer to the following sites. +</para> + +<itemizedlist> + <listitem><para>OpenLDAP - <ulink url="http://www.openldap.org/">http://www.openldap.org/</ulink></para></listitem> + <listitem><para>iPlanet Directory Server - <ulink url="http://iplanet.netscape.com/directory">http://iplanet.netscape.com/directory</ulink></para></listitem> +</itemizedlist> + +<para> +Note that <ulink url="http://www.ora.com/">O'Reilly Publishing</ulink> is working on +a guide to LDAP for System Administrators which has a planned release date of +early summer, 2002. +</para> + +<para> +Two additional Samba resources which may prove to be helpful are +</para> + +<itemizedlist> + <listitem><para>The <ulink url="http://www.unav.es/cti/ldap-smb/ldap-smb-3-howto.html">Samba-PDC-LDAP-HOWTO</ulink> + maintained by Ignacio Coupeau.</para></listitem> + + <listitem><para>The NT migration scripts from <ulink url="http://samba.idealx.org/">IDEALX</ulink> that are + geared to manage users and group in such a Samba-LDAP Domain Controller configuration. + </para></listitem> +</itemizedlist> + +</sect2> + +<sect2> +<title>Encrypted Password Database</title> + +<para> +Traditionally, when configuring <ulink url="smb.conf.5.html#ENCRYPTPASSWORDS">"encrypt +passwords = yes"</ulink> in Samba's <filename>smb.conf</filename> file, user account +information such as username, LM/NT password hashes, password change times, and account +flags have been stored in the <filename>smbpasswd(5)</filename> file. There are several +disadvantages to this approach for sites with very large numbers of users (counted +in the thousands). +</para> + +<itemizedlist> +<listitem><para> +The first is that all lookups must be performed sequentially. Given that +there are approximately two lookups per domain logon (one for a normal +session connection such as when mapping a network drive or printer), this +is a performance bottleneck for large sites. What is needed is an indexed approach +such as is used in databases. +</para></listitem> + +<listitem><para> +The second problem is that administrators who desired to replicate a +smbpasswd file to more than one Samba server were left to use external +tools such as <command>rsync(1)</command> and <command>ssh(1)</command> +and wrote custom, in-house scripts. +</para></listitem> + +<listitem><para> +And finally, the amount of information which is stored in an +smbpasswd entry leaves no room for additional attributes such as +a home directory, password expiration time, or even a Relative +Identified (RID). +</para></listitem> +</itemizedlist> + +<para> +As a result of these defeciencies, a more robust means of storing user attributes +used by smbd was developed. The API which defines access to user accounts +is commonly referred to as the samdb interface (previously this was called the passdb +API, and is still so named in the CVS trees). +</para> + +<para> +There are a few points to stress about that the ldapsam +does not provide. The LDAP support referred to in the this documentation does not +include: +</para> + +<itemizedlist> + <listitem><para>A means of retrieving user account information from + an Windows 2000 Active Directory server.</para></listitem> + <listitem><para>A means of replacing /etc/passwd.</para></listitem> +</itemizedlist> + +<para> +The second item can be accomplished by using LDAP NSS and PAM modules. LGPL +versions of these libraries can be obtained from PADL Software +(<ulink url="http://www.padl.com/">http://www.padl.com/</ulink>). More +information about the configuration of these packages may be found at "LDAP, +System Administration; Gerald Carter, O'Reilly; Chapter 6: Replacing NIS". +</para> + +</sect2> + +<sect2> +<title>Supported LDAP Servers</title> + +<!-- FIXME: This is outdated for 3.0 --> + +<para> +The LDAP samdb code in 2.2.3 (and later) has been developed and tested +using the OpenLDAP 2.0 server and client libraries. +The same code should be able to work with Netscape's Directory Server +and client SDK. However, due to lack of testing so far, there are bound +to be compile errors and bugs. These should not be hard to fix. +If you are so inclined, please be sure to forward all patches to +<ulink url="mailto:samba-patches@samba.org">samba-patches@samba.org</ulink> and +<ulink url="mailto:jerry@samba.org">jerry@samba.org</ulink>. +</para> + +</sect2> + +<sect2> +<title>Schema and Relationship to the RFC 2307 posixAccount</title> + + +<para> +Samba 3.0 includes the necessary schema file for OpenLDAP 2.0 in +<filename>examples/LDAP/samba.schema</filename>. The sambaAccount objectclass is given here: +</para> + +<para><programlisting> +objectclass ( 1.3.1.5.1.4.1.7165.2.2.2 NAME 'sambaAccount' SUP top AUXILIARY + DESC 'Samba Account' + MUST ( uid $ rid ) + MAY ( cn $ lmPassword $ ntPassword $ pwdLastSet $ logonTime $ + logoffTime $ kickoffTime $ pwdCanChange $ pwdMustChange $ acctFlags $ + displayName $ smbHome $ homeDrive $ scriptPath $ profilePath $ + description $ userWorkstations $ primaryGroupID $ domain )) +</programlisting></para> + +<para> +The samba.schema file has been formatted for OpenLDAP 2.0. The OID's are +owned by the Samba Team and as such is legal to be openly published. +If you translate the schema to be used with Netscape DS, please +submit the modified schema file as a patch to <ulink +url="mailto:jerry@samba.org">jerry@samba.org</ulink> +</para> + +<para> +Just as the smbpasswd file is meant to store information which supplements a +user's <filename>/etc/passwd</filename> entry, so is the sambaAccount object +meant to supplement the UNIX user account information. A sambaAccount is a +<constant>STRUCTURAL</constant> objectclass so it can be stored individually +in the directory. However, there are several fields (e.g. uid) which overlap +with the posixAccount objectclass outlined in RFC2307. This is by design. +</para> + +<!--olem: we should perhaps have a note about shadowAccounts too as many +systems use them, isn'it ? --> + +<para> +In order to store all user account information (UNIX and Samba) in the directory, +it is necessary to use the sambaAccount and posixAccount objectclasses in +combination. However, smbd will still obtain the user's UNIX account +information via the standard C library calls (e.g. getpwnam(), et. al.). +This means that the Samba server must also have the LDAP NSS library installed +and functioning correctly. This division of information makes it possible to +store all Samba account information in LDAP, but still maintain UNIX account +information in NIS while the network is transitioning to a full LDAP infrastructure. +</para> +</sect2> + +<sect2> +<title>Configuring Samba with LDAP</title> + + +<sect3> +<title>OpenLDAP configuration</title> + +<para> +To include support for the sambaAccount object in an OpenLDAP directory +server, first copy the samba.schema file to slapd's configuration directory. +</para> + +<para> +<prompt>root# </prompt><userinput>cp samba.schema /etc/openldap/schema/</userinput> +</para> + +<para> +Next, include the <filename>samba.schema</filename> file in <filename>slapd.conf</filename>. +The sambaAccount object contains two attributes which depend upon other schema +files. The 'uid' attribute is defined in <filename>cosine.schema</filename> and +the 'displayName' attribute is defined in the <filename>inetorgperson.schema</filename> +file. Both of these must be included before the <filename>samba.schema</filename> file. +</para> + +<para><programlisting> +## /etc/openldap/slapd.conf + +## schema files (core.schema is required by default) +include /etc/openldap/schema/core.schema + +## needed for sambaAccount +include /etc/openldap/schema/cosine.schema +include /etc/openldap/schema/inetorgperson.schema +include /etc/openldap/schema/samba.schema +include /etc/openldap/schema/nis.schema + +.... +</programlisting></para> + +<para> +It is recommended that you maintain some indices on some of the most usefull attributes, +like in the following example, to speed up searches made on sambaAccount objectclasses +(and possibly posixAccount and posixGroup as well). +</para> +<para><programlisting> +# Indices to maintain +## required by OpenLDAP 2.0 +index objectclass eq + +## support pb_getsampwnam() +index uid pres,eq +## support pdb_getsambapwrid() +index rid eq + +## uncomment these if you are storing posixAccount and +## posixGroup entries in the directory as well +##index uidNumber eq +##index gidNumber eq +##index cn eq +##index memberUid eq + +# (both fetched via ldapsearch): +index primaryGroupID eq +index displayName pres,eq + +</programlisting></para> +</sect3> + + +<sect3> +<title>Configuring Samba</title> + +<para> +The following parameters are available in smb.conf only with <parameter>--with-ldapsam</parameter> +was included when compiling Samba. +</para> + +<itemizedlist> + <listitem><para><ulink url="smb.conf.5.html#PASSDBBACKEND">passdb backend [ldapsam|ldapsam_nua]:url</ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#LDAPSSL">ldap ssl</ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#LDAPADMINDN">ldap admin dn</ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#LDAPSUFFIX">ldap suffix</ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#LDAPFILTER">ldap filter</ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#LDAPPORT">ldap port</ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#LDAPMACHINSUFFIX">ldap machine suffix</ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#LDAPUSERSUFFIX">ldap user suffix</ulink></para></listitem> + <listitem><para><ulink url="smb.conf.5.html#LDAPDELETEDN">ldap delete dn</ulink></para></listitem> + +</itemizedlist> + +<para> +These are described in the <ulink url="smb.conf.5.html">smb.conf(5)</ulink> man +page and so will not be repeated here. However, a sample smb.conf file for +use with an LDAP directory could appear as +</para> + +<para><programlisting> +## /usr/local/samba/lib/smb.conf +[global] + security = user + encrypt passwords = yes + + netbios name = TASHTEGO + workgroup = NARNIA + + # ldap related parameters + + # define the DN to use when binding to the directory servers + # The password for this DN is not stored in smb.conf. Rather it + # must be set by using 'smbpasswd -w <replaceable>secretpw</replaceable>' to store the + # passphrase in the secrets.tdb file. If the "ldap admin dn" values + # change, this password will need to be reset. + ldap admin dn = "cn=Samba Manager,ou=people,dc=samba,dc=org" + + # Define the SSL option when connecting to the directory + # ('off', 'start tls', or 'on' (default)) + ldap ssl = start tls + + passdb backend ldapsam:ldap://ahab.samba.org + + # smbpasswd -x delete the entire dn-entry + ldap delete dn = no + + # the machine and user suffix added to the base suffix + # wrote WITHOUT quotes. NULL siffixes by default + ldap user suffix = ou=People + ldap machine suffix = ou=Systems + + # define the port to use in the LDAP session (defaults to 636 when + # "ldap ssl = on") + ldap port = 389 + + # specify the base DN to use when searching the directory + ldap suffix = "ou=people,dc=samba,dc=org" + + # generally the default ldap search filter is ok + # ldap filter = "(&(uid=%u)(objectclass=sambaAccount))" +</programlisting></para> + + +</sect3> +</sect2> + + +<sect2> +<title>Accounts and Groups management</title> + +<para> +As users accounts are managed thru the sambaAccount objectclass, you should +modify your existing administration tools to deal with sambaAccount attributes. +</para> + +<para> +Machines accounts are managed with the sambaAccount objectclass, just +like users accounts. However, it's up to you to store thoses accounts +in a different tree of you LDAP namespace: you should use +"ou=Groups,dc=plainjoe,dc=org" to store groups and +"ou=People,dc=plainjoe,dc=org" to store users. Just configure your +NSS and PAM accordingly (usually, in the /etc/ldap.conf configuration +file). +</para> + +<para> +In Samba release 3.0, the group management system is based on posix +groups. This means that Samba makes usage of the posixGroup objectclass. +For now, there is no NT-like group system management (global and local +groups). +</para> + +</sect2> + +<sect2> +<title>Security and sambaAccount</title> + + +<para> +There are two important points to remember when discussing the security +of sambaAccount entries in the directory. +</para> + +<itemizedlist> + <listitem><para><emphasis>Never</emphasis> retrieve the lmPassword or + ntPassword attribute values over an unencrypted LDAP session.</para></listitem> + <listitem><para><emphasis>Never</emphasis> allow non-admin users to + view the lmPassword or ntPassword attribute values.</para></listitem> +</itemizedlist> + +<para> +These password hashes are clear text equivalents and can be used to impersonate +the user without deriving the original clear text strings. For more information +on the details of LM/NT password hashes, refer to the <link +linkend="passdb">User Database</link> of the Samba-HOWTO-Collection. +</para> + +<para> +To remedy the first security issue, the "ldap ssl" smb.conf parameter defaults +to require an encrypted session (<command>ldap ssl = on</command>) using +the default port of 636 +when contacting the directory server. When using an OpenLDAP 2.0 server, it +is possible to use the use the StartTLS LDAP extended operation in the place of +LDAPS. In either case, you are strongly discouraged to disable this security +(<command>ldap ssl = off</command>). +</para> + +<para> +Note that the LDAPS protocol is deprecated in favor of the LDAPv3 StartTLS +extended operation. However, the OpenLDAP library still provides support for +the older method of securing communication between clients and servers. +</para> + +<para> +The second security precaution is to prevent non-administrative users from +harvesting password hashes from the directory. This can be done using the +following ACL in <filename>slapd.conf</filename>: +</para> + +<para><programlisting> +## allow the "ldap admin dn" access, but deny everyone else +access to attrs=lmPassword,ntPassword + by dn="cn=Samba Admin,ou=people,dc=plainjoe,dc=org" write + by * none +</programlisting></para> + + +</sect2> + + + +<sect2> +<title>LDAP specials attributes for sambaAccounts</title> + +<para> +The sambaAccount objectclass is composed of the following attributes: +</para> + +<itemizedlist> + + <listitem><para><constant>lmPassword</constant>: the LANMAN password 16-byte hash stored as a character + representation of a hexidecimal string.</para></listitem> + + <listitem><para><constant>ntPassword</constant>: the NT password hash 16-byte stored as a character + representation of a hexidecimal string.</para></listitem> + + <listitem><para><constant>pwdLastSet</constant>: The integer time in seconds since 1970 when the + <constant>lmPassword</constant> and <constant>ntPassword</constant> attributes were last set. + </para></listitem> + + <listitem><para><constant>acctFlags</constant>: string of 11 characters surrounded by square brackets [] + representing account flags such as U (user), W(workstation), X(no password expiration), and + D(disabled).</para></listitem> + + <listitem><para><constant>logonTime</constant>: Integer value currently unused</para></listitem> + + <listitem><para><constant>logoffTime</constant>: Integer value currently unused</para></listitem> + + <listitem><para><constant>kickoffTime</constant>: Integer value currently unused</para></listitem> + + <listitem><para><constant>pwdCanChange</constant>: Integer value currently unused</para></listitem> + + <listitem><para><constant>pwdMustChange</constant>: Integer value currently unused</para></listitem> + + <listitem><para><constant>homeDrive</constant>: specifies the drive letter to which to map the + UNC path specified by homeDirectory. The drive letter must be specified in the form "X:" + where X is the letter of the drive to map. Refer to the "logon drive" parameter in the + smb.conf(5) man page for more information.</para></listitem> + + <listitem><para><constant>scriptPath</constant>: The scriptPath property specifies the path of + the user's logon script, .CMD, .EXE, or .BAT file. The string can be null. The path + is relative to the netlogon share. Refer to the "logon script" parameter in the + smb.conf(5) man page for more information.</para></listitem> + + <listitem><para><constant>profilePath</constant>: specifies a path to the user's profile. + This value can be a null string, a local absolute path, or a UNC path. Refer to the + "logon path" parameter in the smb.conf(5) man page for more information.</para></listitem> + + <listitem><para><constant>smbHome</constant>: The homeDirectory property specifies the path of + the home directory for the user. The string can be null. If homeDrive is set and specifies + a drive letter, homeDirectory should be a UNC path. The path must be a network + UNC path of the form \\server\share\directory. This value can be a null string. + Refer to the "logon home" parameter in the smb.conf(5) man page for more information. + </para></listitem> + + <listitem><para><constant>userWorkstation</constant>: character string value currently unused. + </para></listitem> + + <listitem><para><constant>rid</constant>: the integer representation of the user's relative identifier + (RID).</para></listitem> + + <listitem><para><constant>primaryGroupID</constant>: the relative identifier (RID) of the primary group + of the user.</para></listitem> + +</itemizedlist> + +<para> +The majority of these parameters are only used when Samba is acting as a PDC of +a domain (refer to the <ulink url="Samba-PDC-HOWTO.html">Samba-PDC-HOWTO</ulink> for details on +how to configure Samba as a Primary Domain Controller). The following four attributes +are only stored with the sambaAccount entry if the values are non-default values: +</para> + +<itemizedlist> + <listitem><para>smbHome</para></listitem> + <listitem><para>scriptPath</para></listitem> + <listitem><para>logonPath</para></listitem> + <listitem><para>homeDrive</para></listitem> +</itemizedlist> + +<para> +These attributes are only stored with the sambaAccount entry if +the values are non-default values. For example, assume TASHTEGO has now been +configured as a PDC and that <command>logon home = \\%L\%u</command> was defined in +its <filename>smb.conf</filename> file. When a user named "becky" logons to the domain, +the <parameter>logon home</parameter> string is expanded to \\TASHTEGO\becky. +If the smbHome attribute exists in the entry "uid=becky,ou=people,dc=samba,dc=org", +this value is used. However, if this attribute does not exist, then the value +of the <parameter>logon home</parameter> parameter is used in its place. Samba +will only write the attribute value to the directory entry if the value is +something other than the default (e.g. \\MOBY\becky). +</para> + + +</sect2> + + + +<sect2> +<title>Example LDIF Entries for a sambaAccount</title> + + +<para> +The following is a working LDIF with the inclusion of the posixAccount objectclass: +</para> + +<para><programlisting> +dn: uid=guest2, ou=people,dc=plainjoe,dc=org +ntPassword: 878D8014606CDA29677A44EFA1353FC7 +pwdMustChange: 2147483647 +primaryGroupID: 1201 +lmPassword: 552902031BEDE9EFAAD3B435B51404EE +pwdLastSet: 1010179124 +logonTime: 0 +objectClass: sambaAccount +uid: guest2 +kickoffTime: 2147483647 +acctFlags: [UX ] +logoffTime: 2147483647 +rid: 19006 +pwdCanChange: 0 +</programlisting></para> + +<para> +The following is an LDIF entry for using both the sambaAccount and +posixAccount objectclasses: +</para> + +<para><programlisting> +dn: uid=gcarter, ou=people,dc=plainjoe,dc=org +logonTime: 0 +displayName: Gerald Carter +lmPassword: 552902031BEDE9EFAAD3B435B51404EE +primaryGroupID: 1201 +objectClass: posixAccount +objectClass: sambaAccount +acctFlags: [UX ] +userPassword: {crypt}BpM2ej8Rkzogo +uid: gcarter +uidNumber: 9000 +cn: Gerald Carter +loginShell: /bin/bash +logoffTime: 2147483647 +gidNumber: 100 +kickoffTime: 2147483647 +pwdLastSet: 1010179230 +rid: 19000 +homeDirectory: /home/tashtego/gcarter +pwdCanChange: 0 +pwdMustChange: 2147483647 +ntPassword: 878D8014606CDA29677A44EFA1353FC7 +</programlisting></para> + +</sect2> +</sect1> + +<sect1> +<title>MySQL</title> + +<sect2> +<title>Creating the database</title> + +<para> +You either can set up your own table and specify the field names to pdb_mysql (see below +for the column names) or use the default table. The file <filename>examples/pdb/mysql/mysql.dump</filename> +contains the correct queries to create the required tables. Use the command : + +<command>mysql -u<replaceable>username</replaceable> -h<replaceable>hostname</replaceable> -p<replaceable>password</replaceable> <replaceable>databasename</replaceable> > <filename>/path/to/samba/examples/pdb/mysql/mysql.dump</filename></command> + +</para> +</sect2> + +<sect2> +<title>Configuring</title> + +<para>This plugin lacks some good documentation, but here is some short info:</para> + +<para>Add a the following to the <command>passdb backend</command> variable in your <filename>smb.conf</filename>: +<programlisting> +passdb backend = [other-plugins] mysql:identifier [other-plugins] +</programlisting> +</para> + +<para>The identifier can be any string you like, as long as it doesn't collide with +the identifiers of other plugins or other instances of pdb_mysql. If you +specify multiple pdb_mysql.so entries in 'passdb backend', you also need to +use different identifiers! +</para> + +<para> +Additional options can be given thru the smb.conf file in the [global] section. +</para> + +<para><programlisting> +identifier:mysql host - host name, defaults to 'localhost' +identifier:mysql password +identifier:mysql user - defaults to 'samba' +identifier:mysql database - defaults to 'samba' +identifier:mysql port - defaults to 3306 +identifier:table - Name of the table containing users +</programlisting></para> + +<warning> +<para> +Since the password for the mysql user is stored in the +smb.conf file, you should make the the smb.conf file +readable only to the user that runs samba. This is considered a security +bug and will be fixed soon. +</para> +</warning> + +<para>Names of the columns in this table(I've added column types those columns should have first):</para> + +<para><programlisting> +identifier:logon time column - int(9) +identifier:logoff time column - int(9) +identifier:kickoff time column - int(9) +identifier:pass last set time column - int(9) +identifier:pass can change time column - int(9) +identifier:pass must change time column - int(9) +identifier:username column - varchar(255) - unix username +identifier:domain column - varchar(255) - NT domain user is part of +identifier:nt username column - varchar(255) - NT username +identifier:fullname column - varchar(255) - Full name of user +identifier:home dir column - varchar(255) - Unix homedir path +identifier:dir drive column - varchar(2) - Directory drive path (eg: 'H:') +identifier:logon script column - varchar(255) + - Batch file to run on client side when logging on +identifier:profile path column - varchar(255) - Path of profile +identifier:acct desc column - varchar(255) - Some ASCII NT user data +identifier:workstations column - varchar(255) + - Workstations user can logon to (or NULL for all) +identifier:unknown string column - varchar(255) - unknown string +identifier:munged dial column - varchar(255) - ? +identifier:user sid column - varchar(255) - NT user SID +identifier:group sid column - varchar(255) - NT group ID +identifier:lanman pass column - varchar(255) - encrypted lanman password +identifier:nt pass column - varchar(255) - encrypted nt passwd +identifier:plain pass column - varchar(255) - plaintext password +identifier:acct control column - int(9) - nt user data +identifier:unknown 3 column - int(9) - unknown +identifier:logon divs column - int(9) - ? +identifier:hours len column - int(9) - ? +identifier:unknown 5 column - int(9) - unknown +identifier:unknown 6 column - int(9) - unknown +</programlisting></para> + +<para> +Eventually, you can put a colon (:) after the name of each column, which +should specify the column to update when updating the table. You can also +specify nothing behind the colon - then the data from the field will not be +updated. +</para> + +</sect2> + +<sect2> +<title>Using plaintext passwords or encrypted password</title> + +<para> +I strongly discourage the use of plaintext passwords, however, you can use them: +</para> + +<para> +If you would like to use plaintext passwords, set +'identifier:lanman pass column' and 'identifier:nt pass column' to +'NULL' (without the quotes) and 'identifier:plain pass column' to the +name of the column containing the plaintext passwords. +</para> + +<para> +If you use encrypted passwords, set the 'identifier:plain pass +column' to 'NULL' (without the quotes). This is the default. +</para> + +</sect2> + +<sect2> +<title>Getting non-column data from the table</title> + +<para> +It is possible to have not all data in the database and making some 'constant'. +</para> + +<para> +For example, you can set 'identifier:fullname column' to : +<command>CONCAT(First_name,' ',Sur_name)</command> +</para> + +<para> +Or, set 'identifier:workstations column' to : +<command>NULL</command></para> + +<para>See the MySQL documentation for more language constructs.</para> + +</sect2> +</sect1> + +<sect1> +<title>XML</title> + +<para>This module requires libxml2 to be installed.</para> + +<para>The usage of pdb_xml is pretty straightforward. To export data, use: +</para> + +<para> + <userinput>pdbedit -e xml:filename</userinput> +</para> + +<para> +(where filename is the name of the file to put the data in) +</para> + +<para> +To import data, use: +<userinput>pdbedit -i xml:filename -e current-pdb</userinput> +</para> +<para> +Where filename is the name to read the data from and current-pdb to put it in. +</para> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/printer_driver2.xml b/docs/docbook/projdoc/printer_driver2.xml new file mode 100644 index 0000000000..da3eb838f2 --- /dev/null +++ b/docs/docbook/projdoc/printer_driver2.xml @@ -0,0 +1,1038 @@ +<chapter id="printing"> + +<chapterinfo> + &author.jerry; + <author> + <firstname>Patrick</firstname><surname>Powell</surname> + <affiliation> + <address><email>papowell@lprng.org</email></address> + </affiliation> + </author> + <pubdate> (3 May 2001) </pubdate> +</chapterinfo> + +<title>Printing Support</title> + +<sect1> +<title>Introduction</title> + +<para>Beginning with the 2.2.0 release, Samba supports +the native Windows NT printing mechanisms implemented via +MS-RPC (i.e. the SPOOLSS named pipe). Previous versions of +Samba only supported LanMan printing calls.</para> + +<para>The additional functionality provided by the new +SPOOLSS support includes:</para> + +<itemizedlist> + <listitem><para>Support for downloading printer driver + files to Windows 95/98/NT/2000 clients upon demand. + </para></listitem> + + <listitem><para>Uploading of printer drivers via the + Windows NT Add Printer Wizard (APW) or the + Imprints tool set (refer to <ulink + url="http://imprints.sourceforge.net">http://imprints.sourceforge.net</ulink>). + </para></listitem> + + <listitem><para>Support for the native MS-RPC printing + calls such as StartDocPrinter, EnumJobs(), etc... (See + the MSDN documentation at <ulink + url="http://msdn.microsoft.com/">http://msdn.microsoft.com/</ulink> + for more information on the Win32 printing API) + </para></listitem> + + <listitem><para>Support for NT Access Control Lists (ACL) + on printer objects</para></listitem> + + <listitem><para>Improved support for printer queue manipulation + through the use of an internal databases for spooled job + information</para></listitem> +</itemizedlist> + +<para> +There has been some initial confusion about what all this means +and whether or not it is a requirement for printer drivers to be +installed on a Samba host in order to support printing from Windows +clients. As a side note, Samba does not use these drivers in any way to process +spooled files. They are utilized entirely by the clients. +</para> + +<para> +The following MS KB article, may be of some help if you are dealing with +Windows 2000 clients: <emphasis>How to Add Printers with No User +Interaction in Windows 2000</emphasis> +</para> + +<para> +<ulink url="http://support.microsoft.com/support/kb/articles/Q189/1/05.ASP">http://support.microsoft.com/support/kb/articles/Q189/1/05.ASP</ulink> +</para> + +</sect1> + + +<sect1> +<title>Configuration</title> + +<warning> +<title>[print$] vs. [printer$]</title> + +<para> +Previous versions of Samba recommended using a share named [printer$]. +This name was taken from the printer$ service created by Windows 9x +clients when a printer was shared. Windows 9x printer servers always have +a printer$ service which provides read-only access via no +password in order to support printer driver downloads. +</para> + +<para> +However, the initial implementation allowed for a +parameter named <parameter>printer driver location</parameter> +to be used on a per share basis to specify the location of +the driver files associated with that printer. Another +parameter named <parameter>printer driver</parameter> provided +a means of defining the printer driver name to be sent to +the client. +</para> + +</warning> + +<sect2> +<title>Creating [print$]</title> + +<para> +In order to support the uploading of printer driver +files, you must first configure a file share named [print$]. +The name of this share is hard coded in Samba's internals so +the name is very important (print$ is the service used by +Windows NT print servers to provide support for printer driver +download). +</para> + +<para>You should modify the server's smb.conf file to add the global +parameters and to create the +following file share (of course, some of the parameter values, +such as 'path' are arbitrary and should be replaced with +appropriate values for your site):</para> + +<para><programlisting> +[global] + ; members of the ntadmin group should be able + ; to add drivers and set printer properties + ; root is implicitly a 'printer admin' + printer admin = @ntadmin + +[print$] + path = /usr/local/samba/printers + guest ok = yes + browseable = yes + read only = yes + ; since this share is configured as read only, then we need + ; a 'write list'. Check the file system permissions to make + ; sure this account can copy files to the share. If this + ; is setup to a non-root account, then it should also exist + ; as a 'printer admin' + write list = @ntadmin,root +</programlisting></para> + +<para>The <ulink url="smb.conf.5.html#WRITELIST"><parameter> +write list</parameter></ulink> is used to allow administrative +level user accounts to have write access in order to update files +on the share. See the <ulink url="smb.conf.5.html">smb.conf(5) +man page</ulink> for more information on configuring file shares.</para> + +<para>The requirement for <ulink url="smb.conf.5.html#GUESTOK"><command>guest +ok = yes</command></ulink> depends upon how your +site is configured. If users will be guaranteed to have +an account on the Samba host, then this is a non-issue.</para> + +<note> +<title>Author's Note</title> + +<para> +The non-issue is that if all your Windows NT users are guaranteed to be +authenticated by the Samba server (such as a domain member server and the NT +user has already been validated by the Domain Controller in +order to logon to the Windows NT console), then guest access +is not necessary. Of course, in a workgroup environment where +you just want to be able to print without worrying about +silly accounts and security, then configure the share for +guest access. You'll probably want to add <ulink +url="smb.conf.5.html#MAPTOGUEST"><command>map to guest = Bad User +</command></ulink> in the [global] section as well. Make sure +you understand what this parameter does before using it +though. --jerry +</para> +</note> + +<para>In order for a Windows NT print server to support +the downloading of driver files by multiple client architectures, +it must create subdirectories within the [print$] service +which correspond to each of the supported client architectures. +Samba follows this model as well.</para> + +<para>Next create the directory tree below the [print$] share +for each architecture you wish to support.</para> + +<para><computeroutput> +[print$]----- + |-W32X86 ; "Windows NT x86" + |-WIN40 ; "Windows 95/98" + |-W32ALPHA ; "Windows NT Alpha_AXP" + |-W32MIPS ; "Windows NT R4000" + |-W32PPC ; "Windows NT PowerPC" +</computeroutput></para> + +<warning> +<title>ATTENTION! REQUIRED PERMISSIONS</title> + +<para> +In order to currently add a new driver to you Samba host, +one of two conditions must hold true: +</para> + +<itemizedlist> + <listitem><para>The account used to connect to the Samba host + must have a uid of 0 (i.e. a root account)</para></listitem> + + <listitem><para>The account used to connect to the Samba host + must be a member of the <ulink + url="smb.conf.5.html#PRINTERADMIN"><parameter>printer + admin</parameter></ulink> list.</para></listitem> +</itemizedlist> + +<para> +Of course, the connected account must still possess access +to add files to the subdirectories beneath [print$]. Remember +that all file shares are set to 'read only' by default. +</para> +</warning> + + +<para> +Once you have created the required [print$] service and +associated subdirectories, simply log onto the Samba server using +a root (or <parameter>printer admin</parameter>) account +from a Windows NT 4.0/2k client. Open "Network Neighbourhood" or +"My Network Places" and browse for the Samba host. Once you have located +the server, navigate to the "Printers..." folder. +You should see an initial listing of printers +that matches the printer shares defined on your Samba host. +</para> +</sect2> + +<sect2> +<title>Setting Drivers for Existing Printers</title> + +<para>The initial listing of printers in the Samba host's +Printers folder will have no real printer driver assigned +to them. This defaults to a NULL string to allow the use +of the local Add Printer Wizard on NT/2000 clients. +Attempting to view the printer properties for a printer +which has this default driver assigned will result in +the error message:</para> + +<para> +<emphasis>Device settings cannot be displayed. The driver +for the specified printer is not installed, only spooler +properties will be displayed. Do you want to install the +driver now?</emphasis> +</para> + +<para> +Click "No" in the error dialog and you will be presented with +the printer properties window. The way to assign a driver to a +printer is to either +</para> + +<itemizedlist> + <listitem><para>Use the "New Driver..." button to install + a new printer driver, or</para></listitem> + + <listitem><para>Select a driver from the popup list of + installed drivers. Initially this list will be empty.</para> + </listitem> +</itemizedlist> + +<para>If you wish to install printer drivers for client +operating systems other than "Windows NT x86", you will need +to use the "Sharing" tab of the printer properties dialog.</para> + +<para>Assuming you have connected with a root account, you +will also be able modify other printer properties such as +ACLs and device settings using this dialog box.</para> + +<para>A few closing comments for this section, it is possible +on a Windows NT print server to have printers +listed in the Printers folder which are not shared. Samba does +not make this distinction. By definition, the only printers of +which Samba is aware are those which are specified as shares in +<filename>smb.conf</filename>.</para> + +<para>Another interesting side note is that Windows NT clients do +not use the SMB printer share, but rather can print directly +to any printer on another Windows NT host using MS-RPC. This +of course assumes that the printing client has the necessary +privileges on the remote host serving the printer. The default +permissions assigned by Windows NT to a printer gives the "Print" +permissions to the "Everyone" well-known group. +</para> + +</sect2> + + +<sect2> +<title>Support a large number of printers</title> + +<para>One issue that has arisen during the development +phase of Samba 2.2 is the need to support driver downloads for +100's of printers. Using the Windows NT APW is somewhat +awkward to say the list. If more than one printer are using the +same driver, the <ulink url="rpcclient.1.html"><command>rpcclient's +setdriver command</command></ulink> can be used to set the driver +associated with an installed driver. The following is example +of how this could be accomplished:</para> + +<para> +<prompt>$ </prompt><userinput>rpcclient pogo -U root%secret -c "enumdrivers"</userinput> +<programlisting> +Domain=[NARNIA] OS=[Unix] Server=[Samba 2.2.0-alpha3] + +[Windows NT x86] +Printer Driver Info 1: + Driver Name: [HP LaserJet 4000 Series PS] + +Printer Driver Info 1: + Driver Name: [HP LaserJet 2100 Series PS] + +Printer Driver Info 1: + Driver Name: [HP LaserJet 4Si/4SiMX PS] +</programlisting> +<prompt>$ </prompt><userinput>rpcclient pogo -U root%secret -c "enumprinters"</userinput> +<programlisting> +Domain=[NARNIA] OS=[Unix] Server=[Samba 2.2.0-alpha3] + flags:[0x800000] + name:[\\POGO\hp-print] + description:[POGO\\POGO\hp-print,NO DRIVER AVAILABLE FOR THIS PRINTER,] + comment:[] + +</programlisting> +<prompt>$ </prompt><userinput>rpcclient pogo -U root%secret -c "setdriver hp-print \"HP LaserJet 4000 Series PS\""</userinput> +<programlisting> +Domain=[NARNIA] OS=[Unix] Server=[Samba 2.2.0-alpha3] +Successfully set hp-print to driver HP LaserJet 4000 Series PS. +</programlisting></para> +</sect2> + + + +<sect2> +<title>Adding New Printers via the Windows NT APW</title> + +<para> +By default, Samba offers all printer shares defined in <filename>smb.conf</filename> +in the "Printers..." folder. Also existing in this folder is the Windows NT +Add Printer Wizard icon. The APW will be show only if +</para> + +<itemizedlist> + <listitem><para>The connected user is able to successfully + execute an OpenPrinterEx(\\server) with administrative + privileges (i.e. root or <parameter>printer admin</parameter>). + </para></listitem> + + <listitem><para><ulink url="smb.conf.5.html#SHOWADDPRINTERWIZARD"><parameter>show + add printer wizard = yes</parameter></ulink> (the default). + </para></listitem> +</itemizedlist> + +<para> +In order to be able to use the APW to successfully add a printer to a Samba +server, the <ulink url="smb.conf.5.html#ADDPRINTERCOMMAND"><parameter>add +printer command</parameter></ulink> must have a defined value. The program +hook must successfully add the printer to the system (i.e. +<filename>/etc/printcap</filename> or appropriate files) and +<filename>smb.conf</filename> if necessary. +</para> + +<para> +When using the APW from a client, if the named printer share does +not exist, <command>smbd</command> will execute the <parameter>add printer +command</parameter> and reparse to the <filename>smb.conf</filename> +to attempt to locate the new printer share. If the share is still not defined, +an error of "Access Denied" is returned to the client. Note that the +<parameter>add printer program</parameter> is executed under the context +of the connected user, not necessarily a root account. +</para> + +<para> +There is a complementary <ulink url="smb.conf.5.html#DELETEPRINTERCOMMAND"><parameter>delete +printer command</parameter></ulink> for removing entries from the "Printers..." +folder. +</para> + +<para> +The following is an example <ulink url="smb.conf.5.html#ADDPRINTERCOMMAN"><parameter>add printer command</parameter></ulink> script. It adds the appropriate entries to <filename>/etc/printcap.local</filename> (change that to what you need) and returns a line of 'Done' which is needed for the whole process to work. +</para> + +<programlisting> +#!/bin/sh + +# Script to insert a new printer entry into printcap.local +# +# $1, printer name, used as the descriptive name +# $2, share name, used as the printer name for Linux +# $3, port name +# $4, driver name +# $5, location, used for the device file of the printer +# $6, win9x location + +# +# Make sure we use the location that RedHat uses for local printer defs +PRINTCAP=/etc/printcap.local +DATE=`date +%Y%m%d-%H%M%S` +LP=lp +RESTART="service lpd restart" + +# Keep a copy +cp $PRINTCAP $PRINTCAP.$DATE +# Add the printer to $PRINTCAP +echo "" >> $PRINTCAP +echo "$2|$1:\\" >> $PRINTCAP +echo " :sd=/var/spool/lpd/$2:\\" >> $PRINTCAP +echo " :mx=0:ml=0:sh:\\" >> $PRINTCAP +echo " :lp=/usr/local/samba/var/print/$5.prn:" >> $PRINTCAP + +touch "/usr/local/samba/var/print/$5.prn" >> /tmp/printadd.$$ 2>&1 +chown $LP "/usr/local/samba/var/print/$5.prn" >> /tmp/printadd.$$ 2>&1 + +mkdir /var/spool/lpd/$2 +chmod 700 /var/spool/lpd/$2 +chown $LP /var/spool/lpd/$2 +#echo $1 >> "/usr/local/samba/var/print/$5.prn" +#echo $2 >> "/usr/local/samba/var/print/$5.prn" +#echo $3 >> "/usr/local/samba/var/print/$5.prn" +#echo $4 >> "/usr/local/samba/var/print/$5.prn" +#echo $5 >> "/usr/local/samba/var/print/$5.prn" +#echo $6 >> "/usr/local/samba/var/print/$5.prn" +$RESTART >> "/usr/local/samba/var/print/$5.prn" +# Not sure if this is needed +touch /usr/local/samba/lib/smb.conf +# +# You need to return a value, but I am not sure what it means. +# +echo "Done" +exit 0 +</programlisting> + +</sect2> + + +<sect2> +<title>Samba and Printer Ports</title> + +<para> +Windows NT/2000 print servers associate a port with each printer. These normally +take the form of LPT1:, COM1:, FILE:, etc... Samba must also support the +concept of ports associated with a printer. By default, only one printer port, +named "Samba Printer Port", exists on a system. Samba does not really a port in +order to print, rather it is a requirement of Windows clients. +</para> + +<para> +Note that Samba does not support the concept of "Printer Pooling" internally +either. This is when a logical printer is assigned to multiple ports as +a form of load balancing or fail over. +</para> + +<para> +If you require that multiple ports be defined for some reason, +<filename>smb.conf</filename> possesses a <ulink +url="smb.conf.5.html#ENUMPORTSCOMMAND"><parameter>enumports +command</parameter></ulink> which can be used to define an external program +that generates a listing of ports on a system. +</para> + +</sect2> + +</sect1> + + +<sect1> + <title>The Imprints Toolset</title> + + <para>The Imprints tool set provides a UNIX equivalent of the + Windows NT Add Printer Wizard. For complete information, please + refer to the Imprints web site at <ulink url="http://imprints.sourceforge.net/"> + http://imprints.sourceforge.net/</ulink> as well as the documentation + included with the imprints source distribution. This section will + only provide a brief introduction to the features of Imprints.</para> + + + <sect2> + <title>What is Imprints?</title> + + <para>Imprints is a collection of tools for supporting the goals + of</para> + + <itemizedlist> + <listitem><para>Providing a central repository information + regarding Windows NT and 95/98 printer driver packages</para> + </listitem> + + <listitem><para>Providing the tools necessary for creating + the Imprints printer driver packages.</para></listitem> + + <listitem><para>Providing an installation client which + will obtain and install printer drivers on remote Samba + and Windows NT 4 print servers.</para></listitem> + </itemizedlist> + + </sect2> + + + <sect2> + <title>Creating Printer Driver Packages</title> + + <para>The process of creating printer driver packages is beyond + the scope of this document (refer to Imprints.txt also included + with the Samba distribution for more information). In short, + an Imprints driver package is a gzipped tarball containing the + driver files, related INF files, and a control file needed by the + installation client.</para> + </sect2> + + + <sect2> + <title>The Imprints server</title> + + <para>The Imprints server is really a database server that + may be queried via standard HTTP mechanisms. Each printer + entry in the database has an associated URL for the actual + downloading of the package. Each package is digitally signed + via GnuPG which can be used to verify that package downloaded + is actually the one referred in the Imprints database. It is + <emphasis>not</emphasis> recommended that this security check + be disabled.</para> + </sect2> + + <sect2> + <title>The Installation Client</title> + + <para>More information regarding the Imprints installation client + is available in the <filename>Imprints-Client-HOWTO.ps</filename> + file included with the imprints source package.</para> + + <para>The Imprints installation client comes in two forms.</para> + + <itemizedlist> + <listitem><para>a set of command line Perl scripts</para> + </listitem> + + <listitem><para>a GTK+ based graphical interface to + the command line perl scripts</para></listitem> + </itemizedlist> + + <para>The installation client (in both forms) provides a means + of querying the Imprints database server for a matching + list of known printer model names as well as a means to + download and install the drivers on remote Samba and Windows + NT print servers.</para> + + <para>The basic installation process is in four steps and + perl code is wrapped around <command>smbclient</command> + and <command>rpcclient</command>.</para> + +<para><programlisting> +foreach (supported architecture for a given driver) +{ + 1. rpcclient: Get the appropriate upload directory + on the remote server + 2. smbclient: Upload the driver files + 3. rpcclient: Issues an AddPrinterDriver() MS-RPC +} + +4. rpcclient: Issue an AddPrinterEx() MS-RPC to actually + create the printer +</programlisting></para> + + <para>One of the problems encountered when implementing + the Imprints tool set was the name space issues between + various supported client architectures. For example, Windows + NT includes a driver named "Apple LaserWriter II NTX v51.8" + and Windows 95 calls its version of this driver "Apple + LaserWriter II NTX"</para> + + <para>The problem is how to know what client drivers have + been uploaded for a printer. As astute reader will remember + that the Windows NT Printer Properties dialog only includes + space for one printer driver name. A quick look in the + Windows NT 4.0 system registry at</para> + + <para><filename>HKLM\System\CurrentControlSet\Control\Print\Environment + </filename></para> + + <para>will reveal that Windows NT always uses the NT driver + name. This is ok as Windows NT always requires that at least + the Windows NT version of the printer driver is present. + However, Samba does not have the requirement internally. + Therefore, how can you use the NT driver name if is has not + already been installed?</para> + + <para>The way of sidestepping this limitation is to require + that all Imprints printer driver packages include both the Intel + Windows NT and 95/98 printer drivers and that NT driver is + installed first.</para> + </sect2> + +</sect1> + +<!-- + + This comment from rpc_server/srv_spoolss_nt.c:_spoolss_open_printer_ex() + needs to be added into a section probably. This is to remind me it needs + to be done. -jerry + + /* + * If the openprinterex rpc call contains a devmode, + * it's a per-user one. This per-user devmode is derivated + * from the global devmode. Openprinterex() contains a per-user + * devmode for when you do EMF printing and spooling. + * In the EMF case, the NT workstation is only doing half the job + * of rendering the page. The other half is done by running the printer + * driver on the server. + * The EMF file doesn't contain the page description (paper size, orientation, ...). + * The EMF file only contains what is to be printed on the page. + * So in order for the server to know how to print, the NT client sends + * a devicemode attached to the openprinterex call. + * But this devicemode is short lived, it's only valid for the current print job. + * + * If Samba would have supported EMF spooling, this devicemode would + * have been attached to the handle, to sent it to the driver to correctly + * rasterize the EMF file. + * + * As Samba only supports RAW spooling, we only receive a ready-to-print file, + * we just act as a pass-thru between windows and the printer. + * + * In order to know that Samba supports only RAW spooling, NT has to call + * getprinter() at level 2 (attribute field) or NT has to call startdoc() + * and until NT sends a RAW job, we refuse it. + * + * But to call getprinter() or startdoc(), you first need a valid handle, + * and to get an handle you have to call openprintex(). Hence why you have + * a devicemode in the openprinterex() call. + * + * + * Differences between NT4 and NT 2000. + * NT4: + * + * On NT4, you only have a global devicemode. This global devicemode can be changed + * by the administrator (or by a user with enough privs). Every time a user + * wants to print, the devicemode is reset to the default. In Word, every time + * you print, the printer's characteristics are always reset to the global devicemode. + * + * NT 2000: + * + * In W2K, there is the notion of per-user devicemode. The first time you use + * a printer, a per-user devicemode is build from the global devicemode. + * If you change your per-user devicemode, it is saved in the registry, under the + * H_KEY_CURRENT_KEY sub_tree. So that every time you print, you have your default + * printer preferences available. + * + * To change the per-user devicemode: it's the "Printing Preferences ..." button + * on the General Tab of the printer properties windows. + * + * To change the global devicemode: it's the "Printing Defaults..." button + * on the Advanced Tab of the printer properties window. +--> + +<sect1> +<title>Diagnosis</title> + +<sect2> +<title>Introduction</title> + +<para> +This is a short description of how to debug printing problems with +Samba. This describes how to debug problems with printing from a SMB +client to a Samba server, not the other way around. For the reverse +see the examples/printing directory. +</para> + +<para> +Ok, so you want to print to a Samba server from your PC. The first +thing you need to understand is that Samba does not actually do any +printing itself, it just acts as a middleman between your PC client +and your Unix printing subsystem. Samba receives the file from the PC +then passes the file to a external "print command". What print command +you use is up to you. +</para> + +<para> +The whole things is controlled using options in smb.conf. The most +relevant options (which you should look up in the smb.conf man page) +are: +</para> + +<para><programlisting> + [global] + print command - send a file to a spooler + lpq command - get spool queue status + lprm command - remove a job + [printers] + path = /var/spool/lpd/samba +</programlisting></para> + +<para> +The following are nice to know about: +</para> + +<para><programlisting> + queuepause command - stop a printer or print queue + queueresume command - start a printer or print queue +</programlisting></para> + +<para> +Example: +</para> + +<para><programlisting> + print command = /usr/bin/lpr -r -P%p %s + lpq command = /usr/bin/lpq -P%p %s + lprm command = /usr/bin/lprm -P%p %j + queuepause command = /usr/sbin/lpc -P%p stop + queuepause command = /usr/sbin/lpc -P%p start +</programlisting></para> + +<para> +Samba should set reasonable defaults for these depending on your +system type, but it isn't clairvoyant. It is not uncommon that you +have to tweak these for local conditions. The commands should +always have fully specified pathnames, as the smdb may not have +the correct PATH values. +</para> + +<para> +When you send a job to Samba to be printed, it will make a temporary +copy of it in the directory specified in the [printers] section. +and it should be periodically cleaned out. The lpr -r option +requests that the temporary copy be removed after printing; If +printing fails then you might find leftover files in this directory, +and it should be periodically cleaned out. Samba used the lpq +command to determine the "job number" assigned to your print job +by the spooler. +</para> + +<para> +The %>letter< are "macros" that get dynamically replaced with appropriate +values when they are used. The %s gets replaced with the name of the spool +file that Samba creates and the %p gets replaced with the name of the +printer. The %j gets replaced with the "job number" which comes from +the lpq output. +</para> + +</sect2> + +<sect2> +<title>Debugging printer problems</title> + +<para> +One way to debug printing problems is to start by replacing these +command with shell scripts that record the arguments and the contents +of the print file. A simple example of this kind of things might +be: +</para> + +<para><programlisting> + print command = /tmp/saveprint %p %s + + #!/bin/saveprint + # we make sure that we are the right user + /usr/bin/id -p >/tmp/tmp.print + # we run the command and save the error messages + # replace the command with the one appropriate for your system + /usr/bin/lpr -r -P$1 $2 2>>&/tmp/tmp.print +</programlisting></para> + +<para> +Then you print a file and try removing it. You may find that the +print queue needs to be stopped in order to see the queue status +and remove the job: +</para> + +<para><programlisting> + +h4: {42} % echo hi >/tmp/hi +h4: {43} % smbclient //localhost/lw4 +added interface ip=10.0.0.4 bcast=10.0.0.255 nmask=255.255.255.0 +Password: +Domain=[ASTART] OS=[Unix] Server=[Samba 2.0.7] +smb: \> print /tmp/hi +putting file /tmp/hi as hi-17534 (0.0 kb/s) (average 0.0 kb/s) +smb: \> queue +1049 3 hi-17534 +smb: \> cancel 1049 +Error cancelling job 1049 : code 0 +smb: \> cancel 1049 +Job 1049 cancelled +smb: \> queue +smb: \> exit +</programlisting></para> + +<para> +The 'code 0' indicates that the job was removed. The comment +by the smbclient is a bit misleading on this. +You can observe the command output and then and look at the +/tmp/tmp.print file to see what the results are. You can quickly +find out if the problem is with your printing system. Often people +have problems with their /etc/printcap file or permissions on +various print queues. +</para> +</sect2> + +<sect2> +<title>What printers do I have?</title> + +<para> +You can use the 'testprns' program to check to see if the printer +name you are using is recognized by Samba. For example, you can +use: +</para> + +<para><programlisting> + testprns printer /etc/printcap +</programlisting></para> + +<para> +Samba can get its printcap information from a file or from a program. +You can try the following to see the format of the extracted +information: +</para> + +<para><programlisting> + testprns -a printer /etc/printcap + + testprns -a printer '|/bin/cat printcap' +</programlisting></para> + +</sect2> + +<sect2> +<title>Setting up printcap and print servers</title> + +<para> +You may need to set up some printcaps for your Samba system to use. +It is strongly recommended that you use the facilities provided by +the print spooler to set up queues and printcap information. +</para> + +<para> +Samba requires either a printcap or program to deliver printcap +information. This printcap information has the format: +</para> + +<para><programlisting> + name|alias1|alias2...:option=value:... +</programlisting></para> + +<para> +For almost all printing systems, the printer 'name' must be composed +only of alphanumeric or underscore '_' characters. Some systems also +allow hyphens ('-') as well. An alias is an alternative name for the +printer, and an alias with a space in it is used as a 'comment' +about the printer. The printcap format optionally uses a \ at the end of lines +to extend the printcap to multiple lines. +</para> + +<para> +Here are some examples of printcap files: +</para> + +<para> +<orderedlist> +<listitem><para> +pr just printer name +</para></listitem> +<listitem><para> +pr|alias printer name and alias +</para></listitem> +<listitem><para> +pr|My Printer printer name, alias used as comment +</para></listitem> +<listitem><para> +pr:sh:\ Same as pr:sh:cm= testing + :cm= \ + testing +</para></listitem> +<listitem><para> +pr:sh Same as pr:sh:cm= testing + :cm= testing +</para></listitem> +</orderedlist> +</para> + +<para> +Samba reads the printcap information when first started. If you make +changes in the printcap information, then you must do the following: +</para> + +<orderedlist> + +<listitem><para> +make sure that the print spooler is aware of these changes. +The LPRng system uses the 'lpc reread' command to do this. +</para></listitem> + +<listitem><para> +make sure that the spool queues, etc., exist and have the +correct permissions. The LPRng system uses the 'checkpc -f' +command to do this. +</para></listitem> + +<listitem><para> +You now should send a SIGHUP signal to the smbd server to have +it reread the printcap information. +</para></listitem> +</orderedlist> + +</sect2> + +<sect2> +<title>Job sent, no output</title> + +<para> +This is the most frustrating part of printing. You may have sent the +job, verified that the job was forwarded, set up a wrapper around +the command to send the file, but there was no output from the printer. +</para> + +<para> +First, check to make sure that the job REALLY is getting to the +right print queue. If you are using a BSD or LPRng print spooler, +you can temporarily stop the printing of jobs. Jobs can still be +submitted, but they will not be printed. Use: +</para> + +<para><programlisting> + lpc -Pprinter stop +</programlisting></para> + +<para> +Now submit a print job and then use 'lpq -Pprinter' to see if the +job is in the print queue. If it is not in the print queue then +you will have to find out why it is not being accepted for printing. +</para> + +<para> +Next, you may want to check to see what the format of the job really +was. With the assistance of the system administrator you can view +the submitted jobs files. You may be surprised to find that these +are not in what you would expect to call a printable format. +You can use the UNIX 'file' utitily to determine what the job +format actually is: +</para> + +<para><programlisting> + cd /var/spool/lpd/printer # spool directory of print jobs + ls # find job files + file dfA001myhost +</programlisting></para> + +<para> +You should make sure that your printer supports this format OR that +your system administrator has installed a 'print filter' that will +convert the file to a format appropriate for your printer. +</para> + +</sect2> + +<sect2> +<title>Job sent, strange output</title> + +<para> +Once you have the job printing, you can then start worrying about +making it print nicely. +</para> + +<para> +The most common problem is extra pages of output: banner pages +OR blank pages at the end. +</para> + +<para> +If you are getting banner pages, check and make sure that the +printcap option or printer option is configured for no banners. +If you have a printcap, this is the :sh (suppress header or banner +page) option. You should have the following in your printer. +</para> + +<para><programlisting> + printer: ... :sh +</programlisting></para> + +<para> +If you have this option and are still getting banner pages, there +is a strong chance that your printer is generating them for you +automatically. You should make sure that banner printing is disabled +for the printer. This usually requires using the printer setup software +or procedures supplied by the printer manufacturer. +</para> + +<para> +If you get an extra page of output, this could be due to problems +with your job format, or if you are generating PostScript jobs, +incorrect setting on your printer driver on the MicroSoft client. +For example, under Win95 there is a option: +</para> + +<para><programlisting> + Printers|Printer Name|(Right Click)Properties|Postscript|Advanced| +</programlisting></para> + +<para> +that allows you to choose if a Ctrl-D is appended to all jobs. +This is a very bad thing to do, as most spooling systems will +automatically add a ^D to the end of the job if it is detected as +PostScript. The multiple ^D may cause an additional page of output. +</para> + +</sect2> + +<sect2> +<title>Raw PostScript printed</title> + +<para> +This is a problem that is usually caused by either the print spooling +system putting information at the start of the print job that makes +the printer think the job is a text file, or your printer simply +does not support PostScript. You may need to enable 'Automatic +Format Detection' on your printer. +</para> + +</sect2> + +<sect2> +<title>Advanced Printing</title> + +<para> +Note that you can do some pretty magic things by using your +imagination with the "print command" option and some shell scripts. +Doing print accounting is easy by passing the %U option to a print +command shell script. You could even make the print command detect +the type of output and its size and send it to an appropriate +printer. +</para> + +</sect2> + +<sect2> +<title>Real debugging</title> + +<para> +If the above debug tips don't help, then maybe you need to bring in +the bug guns, system tracing. See Tracing.txt in this directory. +</para> +</sect2> +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/samba-doc.xml b/docs/docbook/projdoc/samba-doc.xml new file mode 100644 index 0000000000..e06ce2901e --- /dev/null +++ b/docs/docbook/projdoc/samba-doc.xml @@ -0,0 +1,133 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE book SYSTEM "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; +]> + +<book id="Samba-HOWTO-Collection"> +<title>SAMBA Project Documentation</title> + +<bookinfo> + <author> + <othername>SAMBA Team</othername> + <affiliation><address><email>samba@samba.org</email></address></affiliation> + </author> + <editor>&person.jelmer;</editor> + <editor>&person.jht;</editor> + <editor>&person.jerry;</editor> + + <pubdate>Monday April 21, 2003</pubdate> + +<abstract> +<para> +This book is a collection of HOWTOs added to Samba documentation over the years. +Samba is always under development, and so is its' documentation. This release of the +documentation represents a major revision or layout as well as contents. +The most recent version of this document can be found at +<ulink url="http://www.samba.org/">http://www.samba.org/</ulink> +on the "Documentation" page. Please send updates to +<ulink url="mailto:jelmer@samba.org">Jelmer Venrooij</ulink>, +<ulink url="mailto:jht@samba.org">John Terpstra</ulink> or +<ulink url="mailto:jerry@samba.org">Gerald (Jerry) Carter</ulink>. +</para> + +<para> +The Samba-Team would like to express sincere thanks to the many people who have with +or without their knowledge contributed to this update. The size and scope of this +project would not have been possible without significant community contribution. A not +insignificant number of ideas for inclusion (if not content itself) has been obtained +from a number of Unofficial HOWTOs - to each such author a big "Thank-you" is also offered. +Please keep publishing your Unofficial HOWTO's - they are a source of inspiration and +application knowledge that is most to be desired by many Samba users and administrators. +</para> + +</abstract> +<legalnotice> +<para> +This documentation is distributed under the GNU General Public License (GPL) +version 2. A copy of the license is included with the Samba source +distribution. A copy can be found on-line at <ulink +url="http://www.fsf.org/licenses/gpl.txt">http://www.fsf.org/licenses/gpl.txt</ulink> +</para> +</legalnotice> +</bookinfo> + +<!-- Contents --> +<toc/> + +<!-- Chapters --> +<part id="introduction"> +<title>General Installation</title> +<partintro> +<title>Preparing Samba for Configuration</title> +<para>This section of the Samba-HOWTO-Collection contains general info on how to install samba +and how to configure the parts of samba you will most likely need. +PLEASE read this.</para> +</partintro> +&IntroSMB; +&UNIX-INSTALL; +</part> + +<part id="type"> +<title>Server Configuration Basics</title> +<partintro> +<title>First Steps in Server Configuration</title> +<para> +Samba can operate in various modes within SMB networks. This HOWTO section contains information on +configuring samba to function as the type of server your network requires. Please read this +section carefully. +</para> +</partintro> +&ServerType; +&SECURITY-LEVEL; +&Samba-PDC-HOWTO; +&Samba-BDC-HOWTO; +&ADS-HOWTO; +&DOMAIN-MEMBER; +</part> + +<part id="optional"> +<title>Advanced Configuration</title> +<partintro> +<title>Valuable Nuts and Bolts Information</title> +<para> +Samba has several features that you might want or might not want to use. The chapters in this part each cover specific Samba features. +</para> +</partintro> +&NetworkBrowsing; +&Passdb; +&NT-Security; +&GROUP-MAPPING-HOWTO; +&PRINTER-DRIVER2; +&CUPS; +&WINBIND; +&AdvancedNetworkAdmin; +&PolicyMgmt; +&ProfileMgmt; +&Trusts; +&Samba-PAM; +&VFS; +&MS-Dfs-Setup; +&IntegratingWithWindows; +&SecuringSamba; +&unicode; +&locking; +</part> + +<part id="troubleshooting"> +<title>Troubleshooting</title> +&Diagnosis; +&problems; +&BUGS; +</part> + +<part id="Appendixes"> +<title>Appendixes</title> +&Compiling; +&NT4Migration; +&Portability; +&Other-Clients; +&SWAT; +&SPEED; +</part> + +</book> diff --git a/docs/docbook/projdoc/securing-samba.xml b/docs/docbook/projdoc/securing-samba.xml new file mode 100644 index 0000000000..d320767a77 --- /dev/null +++ b/docs/docbook/projdoc/securing-samba.xml @@ -0,0 +1,205 @@ +<chapter id="securing-samba"> + +<chapterinfo> + &author.tridge; + &author.jht; + <pubdate>17 March 2003</pubdate> +</chapterinfo> + +<title>Securing Samba</title> + +<sect1> +<title>Introduction</title> +<para> +This note was attached to the Samba 2.2.8 release notes as it contained an +important security fix. The information contained here applies to Samba +installations in general. +</para> + +</sect1> + +<sect1> +<title>Using host based protection</title> + +<para> +In many installations of Samba the greatest threat comes for outside +your immediate network. By default Samba will accept connections from +any host, which means that if you run an insecure version of Samba on +a host that is directly connected to the Internet you can be +especially vulnerable. +</para> + +<para> +One of the simplest fixes in this case is to use the <command>hosts allow</command> and +<command>hosts deny</command> options in the Samba &smb.conf; configuration file to only +allow access to your server from a specific range of hosts. An example +might be: +</para> + +<para><programlisting> + hosts allow = 127.0.0.1 192.168.2.0/24 192.168.3.0/24 + hosts deny = 0.0.0.0/0 +</programlisting></para> + +<para> +The above will only allow SMB connections from 'localhost' (your own +computer) and from the two private networks 192.168.2 and +192.168.3. All other connections will be refused as soon +as the client sends its first packet. The refusal will be marked as a +'not listening on called name' error. +</para> + +</sect1> + +<sect1> + +<title>Using interface protection</title> + +<para> +By default Samba will accept connections on any network interface that +it finds on your system. That means if you have a ISDN line or a PPP +connection to the Internet then Samba will accept connections on those +links. This may not be what you want. +</para> + +<para> +You can change this behaviour using options like the following: +</para> + +<para><programlisting> + interfaces = eth* lo + bind interfaces only = yes +</programlisting></para> + +<para> +This tells Samba to only listen for connections on interfaces with a +name starting with 'eth' such as eth0, eth1, plus on the loopback +interface called 'lo'. The name you will need to use depends on what +OS you are using, in the above I used the common name for Ethernet +adapters on Linux. +</para> + +<para> +If you use the above and someone tries to make a SMB connection to +your host over a PPP interface called 'ppp0' then they will get a TCP +connection refused reply. In that case no Samba code is run at all as +the operating system has been told not to pass connections from that +interface to any samba process. +</para> + +</sect1> + +<sect1> +<title>Using a firewall</title> + +<para> +Many people use a firewall to deny access to services that they don't +want exposed outside their network. This can be a very good idea, +although I would recommend using it in conjunction with the above +methods so that you are protected even if your firewall is not active +for some reason. +</para> + +<para> +If you are setting up a firewall then you need to know what TCP and +UDP ports to allow and block. Samba uses the following: +</para> + +<para><programlisting> + UDP/137 - used by nmbd + UDP/138 - used by nmbd + TCP/139 - used by smbd + TCP/445 - used by smbd +</programlisting></para> + +<para> +The last one is important as many older firewall setups may not be +aware of it, given that this port was only added to the protocol in +recent years. +</para> + +</sect1> + +<sect1> +<title>Using a IPC$ share deny</title> + +<para> +If the above methods are not suitable, then you could also place a +more specific deny on the IPC$ share that is used in the recently +discovered security hole. This allows you to offer access to other +shares while denying access to IPC$ from potentially untrustworthy +hosts. +</para> + +<para> +To do that you could use: +</para> + +<para><programlisting> + [ipc$] + hosts allow = 192.168.115.0/24 127.0.0.1 + hosts deny = 0.0.0.0/0 +</programlisting></para> + +<para> +this would tell Samba that IPC$ connections are not allowed from +anywhere but the two listed places (localhost and a local +subnet). Connections to other shares would still be allowed. As the +IPC$ share is the only share that is always accessible anonymously +this provides some level of protection against attackers that do not +know a username/password for your host. +</para> + +<para> +If you use this method then clients will be given a 'access denied' +reply when they try to access the IPC$ share. That means that those +clients will not be able to browse shares, and may also be unable to +access some other resources. +</para> + +<para> +This is not recommended unless you cannot use one of the other +methods listed above for some reason. +</para> + +</sect1> + +<sect1> +<title>NTLMv2 Security</title> + +<para> +To configure NTLMv2 authentication the following registry keys are worth knowing about: +</para> + +<para> +<programlisting> + [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa] + "lmcompatibilitylevel"=dword:00000003 + + 0x3 - Send NTLMv2 response only. Clients will use NTLMv2 authentication, + use NTLMv2 session security if the server supports it. Domain + controllers accept LM, NTLM and NTLMv2 authentication. + + [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\MSV1_0] + "NtlmMinClientSec"=dword:00080000 + + 0x80000 - NTLMv2 session security. If either NtlmMinClientSec or + NtlmMinServerSec is set to 0x80000, the connection will fail if NTLMv2 + session security is not negotiated. +</programlisting> +</para> +</sect1> + +<sect1> +<title>Upgrading Samba</title> + +<para> +Please check regularly on <ulink url="http://www.samba.org/">http://www.samba.org/</ulink> for updates and +important announcements. Occasionally security releases are made and +it is highly recommended to upgrade Samba when a security vulnerability +is discovered. +</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/security_level.xml b/docs/docbook/projdoc/security_level.xml new file mode 100644 index 0000000000..528c87c52c --- /dev/null +++ b/docs/docbook/projdoc/security_level.xml @@ -0,0 +1,340 @@ +<chapter id="securitylevels"> +<chapterinfo> + &author.tridge; + &author.jelmer; +</chapterinfo> +<title>Samba as Stand-Alone Server</title> + +<para> +In this section the function and purpose of Samba's <emphasis>security</emphasis> +modes are described. +</para> + +<sect1> +<title>User and Share security level</title> + +<para> +A SMB server tells the client at startup what "security level" it is +running. There are two options "share level" and "user level". Which +of these two the client receives affects the way the client then tries +to authenticate itself. It does not directly affect (to any great +extent) the way the Samba server does security. I know this is +strange, but it fits in with the client/server approach of SMB. In SMB +everything is initiated and controlled by the client, and the server +can only tell the client what is available and whether an action is +allowed. +</para> + +<sect2> +<title>User Level Security</title> + +<para> +I'll describe user level security first, as its simpler. In user level +security the client will send a "session setup" command directly after +the protocol negotiation. This contains a username and password. The +server can either accept or reject that username/password +combination. Note that at this stage the server has no idea what +share the client will eventually try to connect to, so it can't base +the "accept/reject" on anything other than: +</para> + +<orderedlist> +<listitem><para>the username/password</para></listitem> +<listitem><para>the machine that the client is coming from</para></listitem> +</orderedlist> + +<para> +If the server accepts the username/password then the client expects to +be able to mount any share (using a "tree connection") without +specifying a password. It expects that all access rights will be as +the username/password specified in the "session setup". +</para> + +<para> +It is also possible for a client to send multiple "session setup" +requests. When the server responds it gives the client a "uid" to use +as an authentication tag for that username/password. The client can +maintain multiple authentication contexts in this way (WinDD is an +example of an application that does this) +</para> + +</sect2> + +<sect2> +<title>Share Level Security</title> + +<para> +Ok, now for share level security. In share level security the client +authenticates itself separately for each share. It will send a +password along with each "tree connection" (share mount). It does not +explicitly send a username with this operation. The client is +expecting a password to be associated with each share, independent of +the user. This means that samba has to work out what username the +client probably wants to use. It is never explicitly sent the +username. Some commercial SMB servers such as NT actually associate +passwords directly with shares in share level security, but samba +always uses the unix authentication scheme where it is a +username/password that is authenticated, not a "share/password". +</para> + +<para> +Many clients send a "session setup" even if the server is in share +level security. They normally send a valid username but no +password. Samba records this username in a list of "possible +usernames". When the client then does a "tree connection" it also adds +to this list the name of the share they try to connect to (useful for +home directories) and any users listed in the <command>user =</command> &smb.conf; +line. The password is then checked in turn against these "possible +usernames". If a match is found then the client is authenticated as +that user. +</para> + +</sect2> + +<sect2> +<title>Server Level Security</title> + +<para> +Finally "server level" security. In server level security the samba +server reports to the client that it is in user level security. The +client then does a "session setup" as described earlier. The samba +server takes the username/password that the client sends and attempts +to login to the "password server" by sending exactly the same +username/password that it got from the client. If that server is in +user level security and accepts the password then samba accepts the +clients connection. This allows the samba server to use another SMB +server as the "password server". +</para> + +<para> +You should also note that at the very start of all this, where the +server tells the client what security level it is in, it also tells +the client if it supports encryption. If it does then it supplies the +client with a random "cryptkey". The client will then send all +passwords in encrypted form. You have to compile samba with encryption +enabled to support this feature, and you have to maintain a separate +smbpasswd file with SMB style encrypted passwords. It is +cryptographically impossible to translate from unix style encryption +to SMB style encryption, although there are some fairly simple management +schemes by which the two could be kept in sync. +</para> + +<para> +"security = server" means that Samba reports to clients that +it is running in "user mode" but actually passes off all authentication +requests to another "user mode" server. This requires an additional +parameter "password server =" that points to the real authentication server. +That real authentication server can be another Samba server or can be a +Windows NT server, the later natively capable of encrypted password support. +</para> + +<note><para> +<emphasis>Server</emphasis> level security is incompatible with what is known +as <emphasis>schannel</emphasis> or "sign and seal" protocols. This means that +if you want to use <emphasis>server</emphasis> level security you must disable +the use of "sign and seal" on all machines on your network. +</para></note> + +<sect3> +<title>Configuring Samba for Seemless Windows Network Integration</title> + +<para> +MS Windows clients may use encrypted passwords as part of a challenege/response +authentication model (a.k.a. NTLMv1) or alone, or clear text strings for simple +password based authentication. It should be realized that with the SMB protocol +the password is passed over the network either in plain text or encrypted, but +not both in the same authentication request. +</para> + +<para> +When encrypted passwords are used a password that has been entered by the user +is encrypted in two ways: +</para> + +<itemizedlist> + <listitem><para>An MD4 hash of the UNICODE of the password + string. This is known as the NT hash. + </para></listitem> + + <listitem><para>The password is converted to upper case, + and then padded or trucated to 14 bytes. This string is + then appended with 5 bytes of NULL characters and split to + form two 56 bit DES keys to encrypt a "magic" 8 byte value. + The resulting 16 bytes for the LanMan hash. + </para></listitem> +</itemizedlist> + +<para> +MS Windows 95 pre-service pack 1, MS Windows NT versions 3.x and version 4.0 +pre-service pack 3 will use either mode of password authentication. All +versions of MS Windows that follow these versions no longer support plain +text passwords by default. +</para> + +<para> +MS Windows clients have a habit of dropping network mappings that have been idle +for 10 minutes or longer. When the user attempts to use the mapped drive +connection that has been dropped, the client re-establishes the connection using +a cached copy of the password. +</para> + +<para> +When Microsoft changed the default password mode, support was dropped for caching +of the plain text password. This means that when the registry parameter is changed +to re-enable use of plain text passwords it appears to work, but when a dropped +service connection mapping attempts to revalidate it will fail if the remote +authentication server does not support encrypted passwords. This means that it +is definitely not a good idea to re-enable plain text password support in such clients. +</para> + +<para> +The following parameters can be used to work around the issue of Windows 9x client +upper casing usernames and password before transmitting them to the SMB server +when using clear text authentication. +</para> + +<para><programlisting> + <ulink url="smb.conf.5.html#PASSWORDLEVEL">passsword level</ulink> = <replaceable>integer</replaceable> + <ulink url="smb.conf.5.html#USERNAMELEVEL">username level</ulink> = <replaceable>integer</replaceable> +</programlisting></para> + +<para> +By default Samba will lower case the username before attempting to lookup the user +in the database of local system accounts. Because UNIX usernames conventionally +only contain lower case character, the <parameter>username level</parameter> parameter +is rarely needed. +</para> + +<para> +However, passwords on UNIX systems often make use of mixed case characters. +This means that in order for a user on a Windows 9x client to connect to a Samba +server using clear text authentication, the <parameter>password level</parameter> +must be set to the maximum number of upper case letter which <emphasis>could</emphasis> +appear is a password. Note that the server OS uses the traditional DES version +of crypt(), a <parameter>password level</parameter> of 8 will result in case +insensitive passwords as seen from Windows users. This will also result in longer +login times as Samba has to compute the permutations of the password string and +try them one by one until a match is located (or all combinations fail). +</para> + +<para> +The best option to adopt is to enable support for encrypted passwords +where ever Samba is used. There are three configuration possibilities +for support of encrypted passwords: +</para> + +</sect3> +<sect3> +<title>Use MS Windows NT as an authentication server</title> + +<para> +This method involves the additions of the following parameters in the &smb.conf; file: +</para> + +<para><programlisting> + encrypt passwords = Yes + security = server + password server = "NetBIOS_name_of_PDC" +</programlisting></para> + + +<para> +There are two ways of identifying whether or not a username and +password pair was valid or not. One uses the reply information provided +as part of the authentication messaging process, the other uses +just an error code. +</para> + +<para> +The down-side of this mode of configuration is the fact that +for security reasons Samba will send the password server a bogus +username and a bogus password and if the remote server fails to +reject the username and password pair then an alternative mode +of identification of validation is used. Where a site uses password +lock out after a certain number of failed authentication attempts +this will result in user lockouts. +</para> + +<para> +Use of this mode of authentication does require there to be +a standard Unix account for the user, this account can be blocked +to prevent logons by other than MS Windows clients. +</para> + +</sect3> +</sect2> + +<sect2> +<title>Domain Level Security</title> + +<para> +When samba is operating in <emphasis>security = domain</emphasis> mode this means that +the Samba server has a domain security trust account (a machine account) and will cause +all authentication requests to be passed through to the domain controllers. +</para> + +<sect3> +<title>Samba as a member of an MS Windows NT security domain</title> + +<para> +This method involves addition of the following parameters in the &smb.conf; file: +</para> + +<para><programlisting> + encrypt passwords = Yes + security = domain + workgroup = "name of NT domain" + password server = * +</programlisting></para> + +<para> +The use of the "*" argument to <command>password server</command> will cause samba to locate the +domain controller in a way analogous to the way this is done within MS Windows NT. +This is the default behaviour. +</para> + +<para> +In order for this method to work the Samba server needs to join the +MS Windows NT security domain. This is done as follows: +</para> + +<itemizedlist> + <listitem><para>On the MS Windows NT domain controller using + the Server Manager add a machine account for the Samba server. + </para></listitem> + + <listitem><para>Next, on the Linux system execute: + <command>smbpasswd -r PDC_NAME -j DOMAIN_NAME</command> (samba 2.x) + + <command>net join -U administrator%password</command> (samba-3) + </para></listitem> +</itemizedlist> + +<para> +Use of this mode of authentication does require there to be a standard Unix account +for the user in order to assign a uid once the account has been authenticated by +the remote Windows DC. This account can be blocked to prevent logons by clients other than +MS Windows through things such as setting an invalid shell in the +<filename>/etc/passwd</filename> entry. +</para> + +<para> +An alternative to assigning UIDs to Windows users on a Samba member server is +presented in the <link linkend="winbind">Winbind Overview</link> chapter +in this HOWTO collection. +</para> + +</sect3> +</sect2> + +<sect2> +<title>ADS Level Security</title> + +<para> +For information about the configuration option please refer to the entire section entitled +<emphasis>Samba as an ADS Domain Member.</emphasis> +</para> + +</sect2> +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/unicode.xml b/docs/docbook/projdoc/unicode.xml new file mode 100644 index 0000000000..2351668e56 --- /dev/null +++ b/docs/docbook/projdoc/unicode.xml @@ -0,0 +1,142 @@ +<chapter id="unicode"> +<chapterinfo> + &author.jelmer; + <author> + <firstname>TAKAHASHI</firstname><surname>Motonobu</surname> + <affiliation> + <address><email>monyo@home.monyo.com</email></address> + </affiliation> + </author> + <pubdate>25 March 2003</pubdate> +</chapterinfo> + +<title>Unicode/Charsets</title> + +<sect1> +<title>What are charsets and unicode?</title> + +<para> +Computers communicate in numbers. In texts, each number will be +translated to a corresponding letter. The meaning that will be assigned +to a certain number depends on the <emphasis>character set(charset) +</emphasis> that is used. +A charset can be seen as a table that is used to translate numbers to +letters. Not all computers use the same charset (there are charsets +with German umlauts, Japanese characters, etc). Usually a charset contains +256 characters, which means that storing a character with it takes +exactly one byte. </para> + +<para> +There are also charsets that support even more characters, +but those need twice(or even more) as much storage space. These +charsets can contain <command>256 * 256 = 65536</command> characters, which +is more then all possible characters one could think of. They are called +multibyte charsets (because they use more then one byte to +store one character). +</para> + +<para> +A standardised multibyte charset is unicode, info is available at +<ulink url="http://www.unicode.org/">www.unicode.org</ulink>. +A big advantage of using a multibyte charset is that you only need one; no +need to make sure two computers use the same charset when they are +communicating. +</para> + +<para>Old windows clients used to use single-byte charsets, named +'codepages' by microsoft. However, there is no support for +negotiating the charset to be used in the smb protocol. Thus, you +have to make sure you are using the same charset when talking to an old client. +Newer clients (Windows NT, 2K, XP) talk unicode over the wire. +</para> +</sect1> + +<sect1> +<title>Samba and charsets</title> + +<para> +As of samba 3.0, samba can (and will) talk unicode over the wire. Internally, +samba knows of three kinds of character sets: +</para> + +<variablelist> + <varlistentry> + <term>unix charset</term> + <listitem><para> + This is the charset used internally by your operating system. + The default is <constant>ASCII</constant>, which is fine for most + systems. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>display charset</term> + <listitem><para>This is the charset samba will use to print messages + on your screen. It should generally be the same as the <command>unix charset</command>. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>dos charset</term> + <listitem><para>This is the charset samba uses when communicating with + DOS and Windows 9x clients. It will talk unicode to all newer clients. + The default depends on the charsets you have installed on your system. + Run <command>testparm -v | grep "dos charset"</command> to see + what the default is on your system. + </para></listitem> + </varlistentry> +</variablelist> + +</sect1> + +<sect1> +<title>Conversion from old names</title> + +<para>Because previous samba versions did not do any charset conversion, +characters in filenames are usually not correct in the unix charset but only +for the local charset used by the DOS/Windows clients.</para> + +<para>The following script from Steve Langasek converts all +filenames from CP850 to the iso8859-15 charset.</para> + +<para> +<prompt>#</prompt><userinput>find <replaceable>/path/to/share</replaceable> -type f -exec bash -c 'CP="{}"; ISO=`echo -n "$CP" | iconv -f cp850 \ + -t iso8859-15`; if [ "$CP" != "$ISO" ]; then mv "$CP" "$ISO"; fi' \; +</userinput> +</para> +</sect1> + +<sect1> +<title>Japanese charsets</title> + +<para>Samba doesn't work correctly with Japanese charsets yet. Here are +points of attention when setting it up:</para> + +<itemizedlist> + +<listitem><para>You should set <command>mangling method = +hash</command></para></listitem> + +<listitem><para>There are various iconv() implementations around and not +all of them work equally well. glibc2's iconv() has a critical problem +in CP932. libiconv-1.8 works with CP932 but still has some problems and +does not work with EUC-JP.</para></listitem> + +<listitem><para>You should set <command>dos charset = CP932</command>, not +Shift_JIS, SJIS...</para></listitem> + +<listitem><para>Currently only <command>unix charset = CP932</command> +will work (but still has some problems...) because of iconv() issues. +<command>unix charset = EUC-JP</command> doesn't work well because of +iconv() issues.</para></listitem> + +<listitem><para>Currently Samba 3.0 does not support <command>unix charset += UTF8-MAC/CAP/HEX/JIS*</command></para></listitem> + +</itemizedlist> + +<para>More information (in Japanese) is available at: <ulink url="http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html">http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html</ulink>.</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/projdoc/upgrading-to-3.0.xml b/docs/docbook/projdoc/upgrading-to-3.0.xml new file mode 100644 index 0000000000..3dc4816664 --- /dev/null +++ b/docs/docbook/projdoc/upgrading-to-3.0.xml @@ -0,0 +1,36 @@ +<chapter id="upgrading-to-3.0"> +<chapterinfo> + &author.jelmer; + <pubdate>25 October 2002</pubdate> +</chapterinfo> + +<title>Issues when upgrading from 2.2 to 3.0</title> + +<sect1> +<title>Charsets</title> + +<para>You might experience problems with special characters +when communicating with old DOS clients. Codepage +support has changed in samba 3.0. Read the chapter +<link linkend="unicode">Unicode support</link> for details. +</para> + +</sect1> + +<sect1> +<title>Obsolete configuration options</title> + +<para> +In 3.0, the following configuration options have been removed. +</para> + +<simplelist> +<member>printer driver (replaced by new driver procedures) </member> +<member>printer driver file (replaced by new driver procedures)</member> +<member>printer driver location (replaced by new driver procedures)</member> +<member>use rhosts</member> +<member>postscript</member> +<member>client code page (replaced by dos charset)</member> +</simplelist> +</sect1> +</chapter> diff --git a/docs/docbook/projdoc/winbind.xml b/docs/docbook/projdoc/winbind.xml new file mode 100644 index 0000000000..cb6a56687d --- /dev/null +++ b/docs/docbook/projdoc/winbind.xml @@ -0,0 +1,1169 @@ +<chapter id="winbind"> + +<chapterinfo> + <authorgroup> + <author> + <firstname>Tim</firstname><surname>Potter</surname> + <affiliation> + <orgname>Samba Team</orgname> + <address><email>tpot@linuxcare.com.au</email></address> + </affiliation> + </author> + &author.tridge; + &author.jht; + <author> + <firstname>Naag</firstname><surname>Mummaneni</surname> + <affiliation> + <address><email>getnag@rediffmail.com</email></address> + </affiliation> + </author> + &author.jelmer; + </authorgroup> + <pubdate>27 June 2002</pubdate> +</chapterinfo> + +<title>Unified Logons between Windows NT and UNIX using Winbind</title> + +<sect1> + <title>Abstract</title> + + <para>Integration of UNIX and Microsoft Windows NT through + a unified logon has been considered a "holy grail" in heterogeneous + computing environments for a long time. We present + <emphasis>winbind</emphasis>, a component of the Samba suite + of programs as a solution to the unified logon problem. Winbind + uses a UNIX implementation + of Microsoft RPC calls, Pluggable Authentication Modules, and the Name + Service Switch to allow Windows NT domain users to appear and operate + as UNIX users on a UNIX machine. This paper describes the winbind + system, explaining the functionality it provides, how it is configured, + and how it works internally.</para> +</sect1> + + +<sect1> + <title>Introduction</title> + + <para>It is well known that UNIX and Microsoft Windows NT have + different models for representing user and group information and + use different technologies for implementing them. This fact has + made it difficult to integrate the two systems in a satisfactory + manner.</para> + + <para>One common solution in use today has been to create + identically named user accounts on both the UNIX and Windows systems + and use the Samba suite of programs to provide file and print services + between the two. This solution is far from perfect however, as + adding and deleting users on both sets of machines becomes a chore + and two sets of passwords are required both of which + can lead to synchronization problems between the UNIX and Windows + systems and confusion for users.</para> + + <para>We divide the unified logon problem for UNIX machines into + three smaller problems:</para> + + <itemizedlist> + <listitem><para>Obtaining Windows NT user and group information + </para></listitem> + + <listitem><para>Authenticating Windows NT users + </para></listitem> + + <listitem><para>Password changing for Windows NT users + </para></listitem> + </itemizedlist> + + + <para>Ideally, a prospective solution to the unified logon problem + would satisfy all the above components without duplication of + information on the UNIX machines and without creating additional + tasks for the system administrator when maintaining users and + groups on either system. The winbind system provides a simple + and elegant solution to all three components of the unified logon + problem.</para> +</sect1> + + +<sect1> + <title>What Winbind Provides</title> + + <para>Winbind unifies UNIX and Windows NT account management by + allowing a UNIX box to become a full member of a NT domain. Once + this is done the UNIX box will see NT users and groups as if + they were native UNIX users and groups, allowing the NT domain + to be used in much the same manner that NIS+ is used within + UNIX-only environments.</para> + + <para>The end result is that whenever any + program on the UNIX machine asks the operating system to lookup + a user or group name, the query will be resolved by asking the + NT domain controller for the specified domain to do the lookup. + Because Winbind hooks into the operating system at a low level + (via the NSS name resolution modules in the C library) this + redirection to the NT domain controller is completely + transparent.</para> + + <para>Users on the UNIX machine can then use NT user and group + names as they would use "native" UNIX names. They can chown files + so that they are owned by NT domain users or even login to the + UNIX machine and run a UNIX X-Window session as a domain user.</para> + + <para>The only obvious indication that Winbind is being used is + that user and group names take the form DOMAIN\user and + DOMAIN\group. This is necessary as it allows Winbind to determine + that redirection to a domain controller is wanted for a particular + lookup and which trusted domain is being referenced.</para> + + <para>Additionally, Winbind provides an authentication service + that hooks into the Pluggable Authentication Modules (PAM) system + to provide authentication via a NT domain to any PAM enabled + applications. This capability solves the problem of synchronizing + passwords between systems since all passwords are stored in a single + location (on the domain controller).</para> + + <sect2> + <title>Target Uses</title> + + <para>Winbind is targeted at organizations that have an + existing NT based domain infrastructure into which they wish + to put UNIX workstations or servers. Winbind will allow these + organizations to deploy UNIX workstations without having to + maintain a separate account infrastructure. This greatly + simplifies the administrative overhead of deploying UNIX + workstations into a NT based organization.</para> + + <para>Another interesting way in which we expect Winbind to + be used is as a central part of UNIX based appliances. Appliances + that provide file and print services to Microsoft based networks + will be able to use Winbind to provide seamless integration of + the appliance into the domain.</para> + </sect2> +</sect1> + + + +<sect1> + <title>How Winbind Works</title> + + <para>The winbind system is designed around a client/server + architecture. A long running <command>winbindd</command> daemon + listens on a UNIX domain socket waiting for requests + to arrive. These requests are generated by the NSS and PAM + clients and processed sequentially.</para> + + <para>The technologies used to implement winbind are described + in detail below.</para> + + <sect2> + <title>Microsoft Remote Procedure Calls</title> + + <para>Over the last few years, efforts have been underway + by various Samba Team members to decode various aspects of + the Microsoft Remote Procedure Call (MSRPC) system. This + system is used for most network related operations between + Windows NT machines including remote management, user authentication + and print spooling. Although initially this work was done + to aid the implementation of Primary Domain Controller (PDC) + functionality in Samba, it has also yielded a body of code which + can be used for other purposes.</para> + + <para>Winbind uses various MSRPC calls to enumerate domain users + and groups and to obtain detailed information about individual + users or groups. Other MSRPC calls can be used to authenticate + NT domain users and to change user passwords. By directly querying + a Windows PDC for user and group information, winbind maps the + NT account information onto UNIX user and group names.</para> + </sect2> + + <sect2> + <title>Microsoft Active Directory Services</title> + + <para> + Since late 2001, Samba has gained the ability to + interact with Microsoft Windows 2000 using its 'Native + Mode' protocols, rather than the NT4 RPC services. + Using LDAP and Kerberos, a domain member running + winbind can enumerate users and groups in exactly the + same way as a Win2k client would, and in so doing + provide a much more efficient and + effective winbind implementation. + </para> + </sect2> + + <sect2> + <title>Name Service Switch</title> + + <para>The Name Service Switch, or NSS, is a feature that is + present in many UNIX operating systems. It allows system + information such as hostnames, mail aliases and user information + to be resolved from different sources. For example, a standalone + UNIX workstation may resolve system information from a series of + flat files stored on the local filesystem. A networked workstation + may first attempt to resolve system information from local files, + and then consult a NIS database for user information or a DNS server + for hostname information.</para> + + <para>The NSS application programming interface allows winbind + to present itself as a source of system information when + resolving UNIX usernames and groups. Winbind uses this interface, + and information obtained from a Windows NT server using MSRPC + calls to provide a new source of account enumeration. Using standard + UNIX library calls, one can enumerate the users and groups on + a UNIX machine running winbind and see all users and groups in + a NT domain plus any trusted domain as though they were local + users and groups.</para> + + <para>The primary control file for NSS is + <filename>/etc/nsswitch.conf</filename>. + When a UNIX application makes a request to do a lookup + the C library looks in <filename>/etc/nsswitch.conf</filename> + for a line which matches the service type being requested, for + example the "passwd" service type is used when user or group names + are looked up. This config line species which implementations + of that service should be tried and in what order. If the passwd + config line is:</para> + + <para><command>passwd: files example</command></para> + + <para>then the C library will first load a module called + <filename>/lib/libnss_files.so</filename> followed by + the module <filename>/lib/libnss_example.so</filename>. The + C library will dynamically load each of these modules in turn + and call resolver functions within the modules to try to resolve + the request. Once the request is resolved the C library returns the + result to the application.</para> + + <para>This NSS interface provides a very easy way for Winbind + to hook into the operating system. All that needs to be done + is to put <filename>libnss_winbind.so</filename> in <filename>/lib/</filename> + then add "winbind" into <filename>/etc/nsswitch.conf</filename> at + the appropriate place. The C library will then call Winbind to + resolve user and group names.</para> + </sect2> + + <sect2> + <title>Pluggable Authentication Modules</title> + + <para>Pluggable Authentication Modules, also known as PAM, + is a system for abstracting authentication and authorization + technologies. With a PAM module it is possible to specify different + authentication methods for different system applications without + having to recompile these applications. PAM is also useful + for implementing a particular policy for authorization. For example, + a system administrator may only allow console logins from users + stored in the local password file but only allow users resolved from + a NIS database to log in over the network.</para> + + <para>Winbind uses the authentication management and password + management PAM interface to integrate Windows NT users into a + UNIX system. This allows Windows NT users to log in to a UNIX + machine and be authenticated against a suitable Primary Domain + Controller. These users can also change their passwords and have + this change take effect directly on the Primary Domain Controller. + </para> + + <para>PAM is configured by providing control files in the directory + <filename>/etc/pam.d/</filename> for each of the services that + require authentication. When an authentication request is made + by an application the PAM code in the C library looks up this + control file to determine what modules to load to do the + authentication check and in what order. This interface makes adding + a new authentication service for Winbind very easy, all that needs + to be done is that the <filename>pam_winbind.so</filename> module + is copied to <filename>/lib/security/</filename> and the PAM + control files for relevant services are updated to allow + authentication via winbind. See the PAM documentation + for more details.</para> + </sect2> + + + <sect2> + <title>User and Group ID Allocation</title> + + <para>When a user or group is created under Windows NT + is it allocated a numerical relative identifier (RID). This is + slightly different to UNIX which has a range of numbers that are + used to identify users, and the same range in which to identify + groups. It is winbind's job to convert RIDs to UNIX id numbers and + vice versa. When winbind is configured it is given part of the UNIX + user id space and a part of the UNIX group id space in which to + store Windows NT users and groups. If a Windows NT user is + resolved for the first time, it is allocated the next UNIX id from + the range. The same process applies for Windows NT groups. Over + time, winbind will have mapped all Windows NT users and groups + to UNIX user ids and group ids.</para> + + <para>The results of this mapping are stored persistently in + an ID mapping database held in a tdb database). This ensures that + RIDs are mapped to UNIX IDs in a consistent way.</para> + </sect2> + + + <sect2> + <title>Result Caching</title> + + <para>An active system can generate a lot of user and group + name lookups. To reduce the network cost of these lookups winbind + uses a caching scheme based on the SAM sequence number supplied + by NT domain controllers. User or group information returned + by a PDC is cached by winbind along with a sequence number also + returned by the PDC. This sequence number is incremented by + Windows NT whenever any user or group information is modified. If + a cached entry has expired, the sequence number is requested from + the PDC and compared against the sequence number of the cached entry. + If the sequence numbers do not match, then the cached information + is discarded and up to date information is requested directly + from the PDC.</para> + </sect2> +</sect1> + + +<sect1> + <title>Installation and Configuration</title> + +<para> +Many thanks to John Trostel <ulink +url="mailto:jtrostel@snapserver.com">jtrostel@snapserver.com</ulink> +for providing the HOWTO for this section. +</para> + +<para> +This HOWTO describes how to get winbind services up and running +to control access and authenticate users on your Linux box using +the winbind services which come with SAMBA 3.0. +</para> + +<sect2> +<title>Introduction</title> + +<para> +This HOWTO describes the procedures used to get winbind up and +running on my RedHat 7.1 system. Winbind is capable of providing access +and authentication control for Windows Domain users through an NT +or Win2K PDC for 'regular' services, such as telnet a nd ftp, as +well for SAMBA services. +</para> + +<para> +This HOWTO has been written from a 'RedHat-centric' perspective, so if +you are using another distribution, you may have to modify the instructions +somewhat to fit the way your distribution works. +</para> + + +<itemizedlist> +<listitem> + <para> + <emphasis>Why should I to this?</emphasis> + </para> + + <para>This allows the SAMBA administrator to rely on the + authentication mechanisms on the NT/Win2K PDC for the authentication + of domain members. NT/Win2K users no longer need to have separate + accounts on the SAMBA server. + </para> +</listitem> + +<listitem> + <para> + <emphasis>Who should be reading this document?</emphasis> + </para> + + <para> + This HOWTO is designed for system administrators. If you are + implementing SAMBA on a file server and wish to (fairly easily) + integrate existing NT/Win2K users from your PDC onto the + SAMBA server, this HOWTO is for you. That said, I am no NT or PAM + expert, so you may find a better or easier way to accomplish + these tasks. + </para> +</listitem> +</itemizedlist> +</sect2> + + +<sect2> +<title>Requirements</title> + +<para> +If you have a samba configuration file that you are currently +using... <emphasis>BACK IT UP!</emphasis> If your system already uses PAM, +<emphasis>back up the <filename>/etc/pam.d</filename> directory +contents!</emphasis> If you haven't already made a boot disk, +<emphasis>MAKE ONE NOW!</emphasis> +</para> + +<para> +Messing with the pam configuration files can make it nearly impossible +to log in to yourmachine. That's why you want to be able to boot back +into your machine in single user mode and restore your +<filename>/etc/pam.d</filename> back to the original state they were in if +you get frustrated with the way things are going. ;-) +</para> + +<para> +The latest version of SAMBA (version 3.0 as of this writing), now +includes a functioning winbindd daemon. Please refer to the +<ulink url="http://samba.org/">main SAMBA web page</ulink> or, +better yet, your closest SAMBA mirror site for instructions on +downloading the source code. +</para> + +<para> +To allow Domain users the ability to access SAMBA shares and +files, as well as potentially other services provided by your +SAMBA machine, PAM (pluggable authentication modules) must +be setup properly on your machine. In order to compile the +winbind modules, you should have at least the pam libraries resident +on your system. For recent RedHat systems (7.1, for instance), that +means <filename>pam-0.74-22</filename>. For best results, it is helpful to also +install the development packages in <filename>pam-devel-0.74-22</filename>. +</para> + +</sect2> + + +<sect2> +<title>Testing Things Out</title> + +<para> +Before starting, it is probably best to kill off all the SAMBA +related daemons running on your server. Kill off all <command>smbd</command>, +<command>nmbd</command>, and <command>winbindd</command> processes that may +be running. To use PAM, you will want to make sure that you have the +standard PAM package (for RedHat) which supplies the <filename>/etc/pam.d</filename> +directory structure, including the pam modules are used by pam-aware +services, several pam libraries, and the <filename>/usr/doc</filename> +and <filename>/usr/man</filename> entries for pam. Winbind built better +in SAMBA if the pam-devel package was also installed. This package includes +the header files needed to compile pam-aware applications. For instance, +my RedHat system has both <filename>pam-0.74-22</filename> and +<filename>pam-devel-0.74-22</filename> RPMs installed. +</para> + +<sect3> +<title>Configure and compile SAMBA</title> + +<para> +The configuration and compilation of SAMBA is pretty straightforward. +The first three steps may not be necessary depending upon +whether or not you have previously built the Samba binaries. +</para> + +<para><programlisting> +<prompt>root#</prompt> <command>autoconf</command> +<prompt>root#</prompt> <command>make clean</command> +<prompt>root#</prompt> <command>rm config.cache</command> +<prompt>root#</prompt> <command>./configure</command> +<prompt>root#</prompt> <command>make</command> +<prompt>root#</prompt> <command>make install</command> +</programlisting></para> + + +<para> +This will, by default, install SAMBA in <filename>/usr/local/samba</filename>. +See the main SAMBA documentation if you want to install SAMBA somewhere else. +It will also build the winbindd executable and libraries. +</para> + +</sect3> + +<sect3> +<title>Configure <filename>nsswitch.conf</filename> and the +winbind libraries on Linux and Solaris</title> + +<para> +The libraries needed to run the <command>winbindd</command> daemon +through nsswitch need to be copied to their proper locations, so +</para> + +<para> +<prompt>root#</prompt> <command>cp ../samba/source/nsswitch/libnss_winbind.so /lib</command> +</para> + +<para> +I also found it necessary to make the following symbolic link: +</para> + +<para> +<prompt>root#</prompt> <command>ln -s /lib/libnss_winbind.so /lib/libnss_winbind.so.2</command> +</para> + +<para>And, in the case of Sun solaris:</para> +<para> +<prompt>root#</prompt> <userinput>ln -s /usr/lib/libnss_winbind.so /usr/lib/libnss_winbind.so.1</userinput> +<prompt>root#</prompt> <userinput>ln -s /usr/lib/libnss_winbind.so /usr/lib/nss_winbind.so.1</userinput> +<prompt>root#</prompt> <userinput>ln -s /usr/lib/libnss_winbind.so /usr/lib/nss_winbind.so.2</userinput> +</para> + +<para> +Now, as root you need to edit <filename>/etc/nsswitch.conf</filename> to +allow user and group entries to be visible from the <command>winbindd</command> +daemon. My <filename>/etc/nsswitch.conf</filename> file look like +this after editing: +</para> + +<para><programlisting> + passwd: files winbind + shadow: files + group: files winbind +</programlisting></para> + +<para> +The libraries needed by the winbind daemon will be automatically +entered into the <command>ldconfig</command> cache the next time +your system reboots, but it +is faster (and you don't need to reboot) if you do it manually: +</para> + +<para> +<prompt>root#</prompt> <command>/sbin/ldconfig -v | grep winbind</command> +</para> + +<para> +This makes <filename>libnss_winbind</filename> available to winbindd +and echos back a check to you. +</para> + +</sect3> + +<sect3> +<title>NSS Winbind on AIX</title> + +<para>(This section is only for those running AIX)</para> + +<para> +The winbind AIX identification module gets built as libnss_winbind.so in the +nsswitch directory of the samba source. This file can be copied to +/usr/lib/security, and the AIX naming convention would indicate that it +should be named WINBIND. A stanza like the following: +</para> + +<para><programlisting> +WINBIND: + program = /usr/lib/security/WINBIND + options = authonly +</programlisting></para> + +<para>can then be added to +<filename>/usr/lib/security/methods.cfg</filename>. This module only +supports identification, but there have been success reports using the +standard winbind pam module for authentication. Use caution configuring +loadable authentication modules as it is possible to make it impossible +to logon to the system. More information about the AIX authentication +module API can be found at "Kernel Extensions and Device Support +Programming Concepts for AIX": <ulink +url="http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixprggd/kernextc/sec_load_mod.htm"> +Chapter 18. Loadable Authentication Module Programming Interface</ulink> +and more information on administering the modules at <ulink +url="http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixbman/baseadmn/iandaadmin.htm"> +"System Management Guide: Operating System and Devices"</ulink>. +</para> +</sect3> + +<sect3> +<title>Configure smb.conf</title> + +<para> +Several parameters are needed in the smb.conf file to control +the behavior of <command>winbindd</command>. Configure +<filename>smb.conf</filename> These are described in more detail in +the <citerefentry><refentrytitle>winbindd</refentrytitle> +<manvolnum>8</manvolnum></citerefentry> man page. My +<filename>smb.conf</filename> file was modified to +include the following entries in the [global] section: +</para> + +<para><programlisting> +[global] + <...> + # separate domain and username with '+', like DOMAIN+username + <ulink url="winbindd.8.html#WINBINDSEPARATOR">winbind separator</ulink> = + + # use uids from 10000 to 20000 for domain users + <ulink url="winbindd.8.html#WINBINDUID">winbind uid</ulink> = 10000-20000 + # use gids from 10000 to 20000 for domain groups + <ulink url="winbindd.8.html#WINBINDGID">winbind gid</ulink> = 10000-20000 + # allow enumeration of winbind users and groups + <ulink url="winbindd.8.html#WINBINDENUMUSERS">winbind enum users</ulink> = yes + <ulink url="winbindd.8.html#WINBINDENUMGROUP">winbind enum groups</ulink> = yes + # give winbind users a real shell (only needed if they have telnet access) + <ulink url="winbindd.8.html#TEMPLATEHOMEDIR">template homedir</ulink> = /home/winnt/%D/%U + <ulink url="winbindd.8.html#TEMPLATESHELL">template shell</ulink> = /bin/bash +</programlisting></para> + +</sect3> + + +<sect3> +<title>Join the SAMBA server to the PDC domain</title> + +<para> +Enter the following command to make the SAMBA server join the +PDC domain, where <replaceable>DOMAIN</replaceable> is the name of +your Windows domain and <replaceable>Administrator</replaceable> is +a domain user who has administrative privileges in the domain. +</para> + + +<para> +<prompt>root#</prompt> <command>/usr/local/samba/bin/net join -S PDC -U Administrator</command> +</para> + + +<para> +The proper response to the command should be: "Joined the domain +<replaceable>DOMAIN</replaceable>" where <replaceable>DOMAIN</replaceable> +is your DOMAIN name. +</para> + +</sect3> + + +<sect3> +<title>Start up the winbindd daemon and test it!</title> + +<para> +Eventually, you will want to modify your smb startup script to +automatically invoke the winbindd daemon when the other parts of +SAMBA start, but it is possible to test out just the winbind +portion first. To start up winbind services, enter the following +command as root: +</para> + +<para> +<prompt>root#</prompt> <command>/usr/local/samba/bin/winbindd</command> +</para> + +<para> +Winbindd can now also run in 'dual daemon mode'. This will make it +run as 2 processes. The first will answer all requests from the cache, +thus making responses to clients faster. The other will +update the cache for the query that the first has just responded. +Advantage of this is that responses stay accurate and are faster. +You can enable dual daemon mode by adding '-B' to the commandline: +</para> + +<para> +<prompt>root#</prompt> <command>/usr/local/samba/bin/winbindd -B</command> +</para> + +<para> +I'm always paranoid and like to make sure the daemon +is really running... +</para> + +<para> +<prompt>root#</prompt> <command>ps -ae | grep winbindd</command> +</para> +<para> +This command should produce output like this, if the daemon is running +</para> +<para> +3025 ? 00:00:00 winbindd +</para> + +<para> +Now... for the real test, try to get some information about the +users on your PDC +</para> + +<para> +<prompt>root#</prompt> <command>/usr/local/samba/bin/wbinfo -u</command> +</para> + +<para> +This should echo back a list of users on your Windows users on +your PDC. For example, I get the following response: +</para> + +<para><programlisting> + CEO+Administrator + CEO+burdell + CEO+Guest + CEO+jt-ad + CEO+krbtgt + CEO+TsInternetUser +</programlisting></para> + +<para> +Obviously, I have named my domain 'CEO' and my <parameter>winbind +separator</parameter> is '+'. +</para> + +<para> +You can do the same sort of thing to get group information from +the PDC: +</para> + +<para><programlisting> +<prompt>root#</prompt> <command>/usr/local/samba/bin/wbinfo -g</command> + CEO+Domain Admins + CEO+Domain Users + CEO+Domain Guests + CEO+Domain Computers + CEO+Domain Controllers + CEO+Cert Publishers + CEO+Schema Admins + CEO+Enterprise Admins + CEO+Group Policy Creator Owners +</programlisting></para> + +<para> +The function 'getent' can now be used to get unified +lists of both local and PDC users and groups. +Try the following command: +</para> + +<para> +<prompt>root#</prompt> <command>getent passwd</command> +</para> + +<para> +You should get a list that looks like your <filename>/etc/passwd</filename> +list followed by the domain users with their new uids, gids, home +directories and default shells. +</para> + +<para> +The same thing can be done for groups with the command +</para> + +<para> +<prompt>root#</prompt> <command>getent group</command> +</para> + +</sect3> + + +<sect3> +<title>Fix the init.d startup scripts</title> + +<sect4> +<title>Linux</title> + +<para> +The <command>winbindd</command> daemon needs to start up after the +<command>smbd</command> and <command>nmbd</command> daemons are running. +To accomplish this task, you need to modify the startup scripts of your system. +They are located at <filename>/etc/init.d/smb</filename> in RedHat and +<filename>/etc/init.d/samba</filename> in Debian. +script to add commands to invoke this daemon in the proper sequence. My +startup script starts up <command>smbd</command>, +<command>nmbd</command>, and <command>winbindd</command> from the +<filename>/usr/local/samba/bin</filename> directory directly. The 'start' +function in the script looks like this: +</para> + +<para><programlisting> +start() { + KIND="SMB" + echo -n $"Starting $KIND services: " + daemon /usr/local/samba/bin/smbd $SMBDOPTIONS + RETVAL=$? + echo + KIND="NMB" + echo -n $"Starting $KIND services: " + daemon /usr/local/samba/bin/nmbd $NMBDOPTIONS + RETVAL2=$? + echo + KIND="Winbind" + echo -n $"Starting $KIND services: " + daemon /usr/local/samba/bin/winbindd + RETVAL3=$? + echo + [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && \ + touch /var/lock/subsys/smb || RETVAL=1 + return $RETVAL +} +</programlisting></para> + +<para>If you would like to run winbindd in dual daemon mode, replace +the line +<programlisting> + daemon /usr/local/samba/bin/winbindd +</programlisting> + +in the example above with: + +<programlisting> + daemon /usr/local/samba/bin/winbindd -B +</programlisting>. +</para> + +<para> +The 'stop' function has a corresponding entry to shut down the +services and looks like this: +</para> + +<para><programlisting> +stop() { + KIND="SMB" + echo -n $"Shutting down $KIND services: " + killproc smbd + RETVAL=$? + echo + KIND="NMB" + echo -n $"Shutting down $KIND services: " + killproc nmbd + RETVAL2=$? + echo + KIND="Winbind" + echo -n $"Shutting down $KIND services: " + killproc winbindd + RETVAL3=$? + [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && \ + rm -f /var/lock/subsys/smb + echo "" + return $RETVAL +} +</programlisting></para> +</sect4> + +<sect4> +<title>Solaris</title> + +<para>Winbind doesn't work on solaris 9, see the <link linkend="winbind-solaris9">Portability</link> chapter for details.</para> + +<para>On solaris, you need to modify the +<filename>/etc/init.d/samba.server</filename> startup script. It usually +only starts smbd and nmbd but should now start winbindd too. If you +have samba installed in <filename>/usr/local/samba/bin</filename>, +the file could contains something like this: +</para> + +<para><programlisting> + ## + ## samba.server + ## + + if [ ! -d /usr/bin ] + then # /usr not mounted + exit + fi + + killproc() { # kill the named process(es) + pid=`/usr/bin/ps -e | + /usr/bin/grep -w $1 | + /usr/bin/sed -e 's/^ *//' -e 's/ .*//'` + [ "$pid" != "" ] && kill $pid + } + + # Start/stop processes required for samba server + + case "$1" in + + 'start') + # + # Edit these lines to suit your installation (paths, workgroup, host) + # + echo Starting SMBD + /usr/local/samba/bin/smbd -D -s \ + /usr/local/samba/smb.conf + + echo Starting NMBD + /usr/local/samba/bin/nmbd -D -l \ + /usr/local/samba/var/log -s /usr/local/samba/smb.conf + + echo Starting Winbind Daemon + /usr/local/samba/bin/winbindd + ;; + + 'stop') + killproc nmbd + killproc smbd + killproc winbindd + ;; + + *) + echo "Usage: /etc/init.d/samba.server { start | stop }" + ;; + esac +</programlisting></para> + +<para> +Again, if you would like to run samba in dual daemon mode, replace +<programlisting> + /usr/local/samba/bin/winbindd +</programlisting> + +in the script above with: + +<programlisting> + /usr/local/samba/bin/winbindd -B +</programlisting> +</para> + +</sect4> + +<sect4> +<title>Restarting</title> +<para> +If you restart the <command>smbd</command>, <command>nmbd</command>, +and <command>winbindd</command> daemons at this point, you +should be able to connect to the samba server as a domain member just as +if you were a local user. +</para> +</sect4> +</sect3> + +<sect3> +<title>Configure Winbind and PAM</title> + +<para> +If you have made it this far, you know that winbindd and samba are working +together. If you want to use winbind to provide authentication for other +services, keep reading. The pam configuration files need to be altered in +this step. (Did you remember to make backups of your original +<filename>/etc/pam.d</filename> files? If not, do it now.) +</para> + +<para> +You will need a pam module to use winbindd with these other services. This +module will be compiled in the <filename>../source/nsswitch</filename> directory +by invoking the command +</para> + +<para> +<prompt>root#</prompt> <command>make nsswitch/pam_winbind.so</command> +</para> + +<para> +from the <filename>../source</filename> directory. The +<filename>pam_winbind.so</filename> file should be copied to the location of +your other pam security modules. On my RedHat system, this was the +<filename>/lib/security</filename> directory. On Solaris, the pam security +modules reside in <filename>/usr/lib/security</filename>. +</para> + +<para> +<prompt>root#</prompt> <command>cp ../samba/source/nsswitch/pam_winbind.so /lib/security</command> +</para> + +<sect4> +<title>Linux/FreeBSD-specific PAM configuration</title> + +<para> +The <filename>/etc/pam.d/samba</filename> file does not need to be changed. I +just left this fileas it was: +</para> + + +<para><programlisting> + auth required /lib/security/pam_stack.so service=system-auth + account required /lib/security/pam_stack.so service=system-auth +</programlisting></para> + +<para> +The other services that I modified to allow the use of winbind +as an authentication service were the normal login on the console (or a terminal +session), telnet logins, and ftp service. In order to enable these +services, you may first need to change the entries in +<filename>/etc/xinetd.d</filename> (or <filename>/etc/inetd.conf</filename>). +RedHat 7.1 uses the new xinetd.d structure, in this case you need +to change the lines in <filename>/etc/xinetd.d/telnet</filename> +and <filename>/etc/xinetd.d/wu-ftp</filename> from +</para> + +<para><programlisting> + enable = no +</programlisting></para> + +<para> +to +</para> + +<para><programlisting> + enable = yes +</programlisting></para> + +<para> +For ftp services to work properly, you will also need to either +have individual directories for the domain users already present on +the server, or change the home directory template to a general +directory for all domain users. These can be easily set using +the <filename>smb.conf</filename> global entry +<command>template homedir</command>. +</para> + +<para> +The <filename>/etc/pam.d/ftp</filename> file can be changed +to allow winbind ftp access in a manner similar to the +samba file. My <filename>/etc/pam.d/ftp</filename> file was +changed to look like this: +</para> + +<para><programlisting> + auth required /lib/security/pam_listfile.so item=user sense=deny \ + file=/etc/ftpusers onerr=succeed + auth sufficient /lib/security/pam_winbind.so + auth required /lib/security/pam_stack.so service=system-auth + auth required /lib/security/pam_shells.so + account sufficient /lib/security/pam_winbind.so + account required /lib/security/pam_stack.so service=system-auth + session required /lib/security/pam_stack.so service=system-auth +</programlisting></para> + +<para> +The <filename>/etc/pam.d/login</filename> file can be changed nearly the +same way. It now looks like this: +</para> + +<para><programlisting> + auth required /lib/security/pam_securetty.so + auth sufficient /lib/security/pam_winbind.so + auth sufficient /lib/security/pam_unix.so use_first_pass + auth required /lib/security/pam_stack.so service=system-auth + auth required /lib/security/pam_nologin.so + account sufficient /lib/security/pam_winbind.so + account required /lib/security/pam_stack.so service=system-auth + password required /lib/security/pam_stack.so service=system-auth + session required /lib/security/pam_stack.so service=system-auth + session optional /lib/security/pam_console.so +</programlisting></para> + +<para> +In this case, I added the <command>auth sufficient /lib/security/pam_winbind.so</command> +lines as before, but also added the <command>required pam_securetty.so</command> +above it, to disallow root logins over the network. I also added a +<command>sufficient /lib/security/pam_unix.so use_first_pass</command> +line after the <command>winbind.so</command> line to get rid of annoying +double prompts for passwords. +</para> + +</sect4> + +<sect4> +<title>Solaris-specific configuration</title> + +<para> +The /etc/pam.conf needs to be changed. I changed this file so that my Domain +users can logon both locally as well as telnet.The following are the changes +that I made.You can customize the pam.conf file as per your requirements,but +be sure of those changes because in the worst case it will leave your system +nearly impossible to boot. +</para> + +<para><programlisting> + # + #ident "@(#)pam.conf 1.14 99/09/16 SMI" + # + # Copyright (c) 1996-1999, Sun Microsystems, Inc. + # All Rights Reserved. + # + # PAM configuration + # + # Authentication management + # + login auth required /usr/lib/security/pam_winbind.so + login auth required /usr/lib/security/$ISA/pam_unix.so.1 try_first_pass + login auth required /usr/lib/security/$ISA/pam_dial_auth.so.1 try_first_pass + # + rlogin auth sufficient /usr/lib/security/pam_winbind.so + rlogin auth sufficient /usr/lib/security/$ISA/pam_rhosts_auth.so.1 + rlogin auth required /usr/lib/security/$ISA/pam_unix.so.1 try_first_pass + # + dtlogin auth sufficient /usr/lib/security/pam_winbind.so + dtlogin auth required /usr/lib/security/$ISA/pam_unix.so.1 try_first_pass + # + rsh auth required /usr/lib/security/$ISA/pam_rhosts_auth.so.1 + other auth sufficient /usr/lib/security/pam_winbind.so + other auth required /usr/lib/security/$ISA/pam_unix.so.1 try_first_pass + # + # Account management + # + login account sufficient /usr/lib/security/pam_winbind.so + login account requisite /usr/lib/security/$ISA/pam_roles.so.1 + login account required /usr/lib/security/$ISA/pam_unix.so.1 + # + dtlogin account sufficient /usr/lib/security/pam_winbind.so + dtlogin account requisite /usr/lib/security/$ISA/pam_roles.so.1 + dtlogin account required /usr/lib/security/$ISA/pam_unix.so.1 + # + other account sufficient /usr/lib/security/pam_winbind.so + other account requisite /usr/lib/security/$ISA/pam_roles.so.1 + other account required /usr/lib/security/$ISA/pam_unix.so.1 + # + # Session management + # + other session required /usr/lib/security/$ISA/pam_unix.so.1 + # + # Password management + # + #other password sufficient /usr/lib/security/pam_winbind.so + other password required /usr/lib/security/$ISA/pam_unix.so.1 + dtsession auth required /usr/lib/security/$ISA/pam_unix.so.1 + # + # Support for Kerberos V5 authentication (uncomment to use Kerberos) + # + #rlogin auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass + #login auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass + #dtlogin auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass + #other auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass + #dtlogin account optional /usr/lib/security/$ISA/pam_krb5.so.1 + #other account optional /usr/lib/security/$ISA/pam_krb5.so.1 + #other session optional /usr/lib/security/$ISA/pam_krb5.so.1 + #other password optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass +</programlisting></para> + +<para> +I also added a try_first_pass line after the winbind.so line to get rid of +annoying double prompts for passwords. +</para> + +<para> +Now restart your Samba and try connecting through your application that you +configured in the pam.conf. +</para> + +</sect4> + +</sect3> + +</sect2> + +</sect1> + +<sect1> + <title>Limitations</title> + + <para>Winbind has a number of limitations in its current + released version that we hope to overcome in future + releases:</para> + + <itemizedlist> + <listitem><para>Winbind is currently only available for + the Linux, Solaris and IRIX operating systems, although ports to other operating + systems are certainly possible. For such ports to be feasible, + we require the C library of the target operating system to + support the Name Service Switch and Pluggable Authentication + Modules systems. This is becoming more common as NSS and + PAM gain support among UNIX vendors.</para></listitem> + + <listitem><para>The mappings of Windows NT RIDs to UNIX ids + is not made algorithmically and depends on the order in which + unmapped users or groups are seen by winbind. It may be difficult + to recover the mappings of rid to UNIX id mapping if the file + containing this information is corrupted or destroyed.</para> + </listitem> + + <listitem><para>Currently the winbind PAM module does not take + into account possible workstation and logon time restrictions + that may be been set for Windows NT users, this is + instead up to the PDC to enforce.</para></listitem> + </itemizedlist> +</sect1> + + +<sect1> + <title>Conclusion</title> + + <para>The winbind system, through the use of the Name Service + Switch, Pluggable Authentication Modules, and appropriate + Microsoft RPC calls have allowed us to provide seamless + integration of Microsoft Windows NT domain users on a + UNIX system. The result is a great reduction in the administrative + cost of running a mixed UNIX and NT network.</para> + +</sect1> + +</chapter> diff --git a/docs/docbook/smbdotconf/.cvsignore b/docs/docbook/smbdotconf/.cvsignore new file mode 100644 index 0000000000..e9d3f9c05a --- /dev/null +++ b/docs/docbook/smbdotconf/.cvsignore @@ -0,0 +1,3 @@ +parameters.all.xml +parameters.global.xml +parameters.service.xml diff --git a/docs/docbook/smbdotconf/expand-smb.conf.xsl b/docs/docbook/smbdotconf/expand-smb.conf.xsl new file mode 100644 index 0000000000..62fc4a9ccf --- /dev/null +++ b/docs/docbook/smbdotconf/expand-smb.conf.xsl @@ -0,0 +1,87 @@ +<?xml version='1.0'?> +<!-- vim:set sts=2 shiftwidth=2 syntax=xml: --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:exsl="http://exslt.org/common" + xmlns:samba="http://samba.org/common" + version="1.1" + extension-element-prefixes="exsl"> + +<xsl:output method="xml"/> + +<!-- Generates one big XML file for smb.conf --> + +<xsl:param name="xmlSambaNsUri" select="'http://samba.org/common'"/> + +<xsl:template match="refentry"> +<xsl:text disable-output-escaping="yes"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities; +]> +</xsl:text> +<xsl:element name="refentry"> + <xsl:attribute name="id"><xsl:value-of select="@id"/></xsl:attribute> + <xsl:apply-templates/> +</xsl:element> +</xsl:template> + +<!-- This is needed to copy content unchanged --> +<xsl:template match="@*|node()"> + <xsl:copy> + <xsl:apply-templates select="@*|node()"/> + </xsl:copy> +</xsl:template> + + +<xsl:template match="//samba:parameter"> + <!-- reconstruct varlistentry - not all of them will go into separate files + and also we must repair the main varlistentry itself. + --> + <xsl:message> + <xsl:text>Processing samba:parameter (</xsl:text> + <xsl:value-of select="@name"/> + <xsl:text>)</xsl:text> + </xsl:message> + + <xsl:variable name="name"><xsl:value-of select="translate(translate(string(@name),' ',''), + 'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/> + </xsl:variable> + + <xsl:variable name="anchor"> + <xsl:element name="anchor"> + <xsl:attribute name="id"> + <xsl:value-of select="$name"/> + </xsl:attribute> + </xsl:element> + </xsl:variable> + + <xsl:variable name="context"> + <xsl:text> (</xsl:text> + <xsl:value-of select="@context"/> + <xsl:text>)</xsl:text> + </xsl:variable> + + <xsl:variable name="term"> + <xsl:element name="term"> + <xsl:copy-of select="$anchor"/> + <xsl:value-of select="@name"/> + <xsl:value-of select="$context"/> + </xsl:element> + </xsl:variable> + + <xsl:variable name="content"> + <xsl:apply-templates/> + </xsl:variable> + + <xsl:element name="varlistentry"> + <xsl:text> </xsl:text> + <xsl:copy-of select="$term"/> + <xsl:copy-of select="$content"/> + <xsl:text> +</xsl:text> + </xsl:element> + +</xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/smbdotconf/printing/maxreportedprintjobs.xml b/docs/docbook/smbdotconf/printing/maxreportedprintjobs.xml new file mode 100644 index 0000000000..743a5a5aed --- /dev/null +++ b/docs/docbook/smbdotconf/printing/maxreportedprintjobs.xml @@ -0,0 +1,22 @@ +<samba:parameter name="max reported print jobs" + context="S" + print="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter limits the maximum number of + jobs displayed in a port monitor for Samba printer queue at any given + moment. If this number is exceeded, the excess jobs will not be shown. + A value of zero means there is no limit on the number of print + jobs reported. + + See all <link linkend="TOTALPRINTJOBS"><parameter moreinfo="none">total + print jobs</parameter></link> and <link + linkend="MAXPRINTJOBS"><parameter moreinfo="none">max print + jobs</parameter></link> parameters. + </para> + + <para>Default: <command moreinfo="none">max reported print jobs = 0</command></para> + + <para>Example: <command moreinfo="none">max reported print jobs = 1000</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/security/restrictanonymous.xml b/docs/docbook/smbdotconf/security/restrictanonymous.xml new file mode 100644 index 0000000000..803bc06b2b --- /dev/null +++ b/docs/docbook/smbdotconf/security/restrictanonymous.xml @@ -0,0 +1,26 @@ +<samba:parameter name="restrict anonymous" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The setting of this parameter determines whether user and + group list information is returned for an anonymous connection. + and mirrors the effects of the + <constant>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\LSA\RestrictAnonymous</constant> registry key in Windows + 2000 and Windows NT. When set to 0, user and group list + information is returned to anyone who asks. When set + to 1, only an authenticated user can retrive user and + group list information. For the value 2, supported by + Windows 2000/XP and Samba, no anonymous connections are allowed at + all. This can break third party and Microsoft + applications which expect to be allowed to perform + operations anonymously. + + The security advantage of using restrict anonymous = 1 is dubious, + as user and group list information can be obtained using other + means. + </para> + + <para>Default: <command moreinfo="none">restrict anonymous = 0</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/xslt/db2latex/VERSION.xml b/docs/docbook/xslt/db2latex/VERSION.xml new file mode 100644 index 0000000000..6ac59ae4dd --- /dev/null +++ b/docs/docbook/xslt/db2latex/VERSION.xml @@ -0,0 +1,24 @@ +<?xml version='1.0'?> +<!--############################################################################# + | $Id: VERSION.xml,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: + + ############################################################################## --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version='1.0'> +<xsl:variable name="VERSION">0.7.1</xsl:variable> +<xsl:variable name="LASTRELEASE">0.7</xsl:variable> +<xsl:variable name="TAG"> + <xsl:variable name="RCSTAG" select="substring-before(substring-after('$Name: $',concat('$','Name: ')),'$')"/> + <xsl:choose> + <xsl:when test="normalize-space($RCSTAG)=''">HEAD</xsl:when> + <xsl:otherwise><xsl:value-of select="$RCSTAG" /></xsl:otherwise> + </xsl:choose> +</xsl:variable> +<xsl:variable name="CVSVERSION">$Id: VERSION.xml,v 1.1 2003/04/30 21:39:49 ab Exp $</xsl:variable> + + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/abstract.mod.xsl b/docs/docbook/xslt/db2latex/abstract.mod.xsl new file mode 100644 index 0000000000..6fd44bf9f2 --- /dev/null +++ b/docs/docbook/xslt/db2latex/abstract.mod.xsl @@ -0,0 +1,95 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: abstract.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="abstract" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: abstract.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author><firstname>Ramon</firstname> <surname>Casellas</surname></author> + <author><firstname>James</firstname> <surname>Devenish</surname></author> + </authorgroup> + <copyright> + <year>2000</year><year>2001</year><year>2002</year><year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>Abstract <filename>abstract.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para>This file <filename>abstract.mod.xsl</filename> contains a single + XSL template for <sgmltag>abstract</sgmltag>.</para> + <itemizedlist> + <listitem><para>Calls <literal>map.begin</literal>.</para></listitem> + <listitem><para>Processes children with <sgmltag>xsl:apply-templates</sgmltag>.</para></listitem> + <listitem><para>Calls <literal>map.end</literal></para></listitem> + <listitem><para>The abstract/title template is empty.</para></listitem> + </itemizedlist> + </section> + </partintro> + </doc:reference> + + + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="abstract" xmlns=""> + <refpurpose> Abstract XSL template. </refpurpose> + <refdescription> + <para>Calls template <xref linkend="map.begin"/>(<literal>map.begin</literal>), + to output the opening command (by default):</para> + <screen> + % -------------------------------------------- + % Abstract + % -------------------------------------------- + \begin{abstract} + </screen> + <para> Calls "apply-templates" for all the children, and calls template + <xref linkend="map.end"/>(<literal>map.end</literal>) to output the closing + command.</para> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + <listitem><para> The title of the abstract is lost.</para></listitem> + <listitem><para> The template for abstract/title is defined EMPTY.</para></listitem> + </itemizedlist> + </formalpara> + + <formalpara><title>Default Behaviour</title> + <screen> + Fill + </screen> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <!-- TEMPLATE --> + <xsl:template match="abstract"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + <xsl:call-template name="map.end"/> + </xsl:template> + + <xsl:template match="abstract/title"/> + +</xsl:stylesheet> + + diff --git a/docs/docbook/xslt/db2latex/admonition.mod.xsl b/docs/docbook/xslt/db2latex/admonition.mod.xsl new file mode 100644 index 0000000000..c42d926c16 --- /dev/null +++ b/docs/docbook/xslt/db2latex/admonition.mod.xsl @@ -0,0 +1,225 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: admonition.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: Admonition templates. ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference name="admonition" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: admonition.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author><firstname>Ramon</firstname> <surname>Casellas</surname></author> + <author><firstname>James</firstname> <surname>Devenish</surname></author> + </authorgroup> + <copyright><year>2000</year><year>2001</year><year>2002</year><year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Admonition XSL Variables and Templates <filename>admonition.mod.xsl</filename></title> + + <partintro> + <section><title>Introduction</title> + <para>DocBook includes admonitions, which are set off from the main text.</para> + </section> + <formalpara><title>Pertinent Variables</title> + <itemizedlist> + <listitem><simpara><xref linkend="param.latex.use.fancybox"/></simpara></listitem> + <listitem><simpara><xref linkend="param.latex.admonition.path"/></simpara></listitem> + <listitem><simpara><xref linkend="param.latex.admonition.imagesize"/></simpara></listitem> + <listitem><simpara><xref linkend="param.latex.apply.title.templates.admonitions"/></simpara></listitem> + </itemizedlist> + </formalpara> + </partintro> + </doc:reference> + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:param name="latex.admonition.environment" xmlns=""> + <refpurpose> + Declares a new environment to be used for admonitions + (warning, tip, important, caution, note). + </refpurpose> + <refdescription> + <para> + A LaTeX environment is emitted. That environment has two mandatory parameters. + Instances of the environment are customised for each admonition via those parameters. + Instances will be typeset as boxed areas in the document flow. + </para> + <para> + The first argument is the filename for graphics (e.g $latex.admonition.path/warning). + The second argument is the admonition title or the associated generic text. + </para> + <para> + It requires the LaTeX <link linkend="param.latex.use.fancybox">fancybox package</link>. + It also uses graphics, by default. + </para> + <example> + <title>Processing the <sgmltag class="element">warning</sgmltag> admonition</title> + <para> When processing the admonition, the following code is generated: </para> + <programlisting><![CDATA[ + \begin{admonition}{figures/warning}{My WARNING} + ... + \end{admonition}]]> + </programlisting> + </example> + </refdescription> + </doc:param> + +<!--############################################################################# --> +<xsl:variable name="latex.admonition.environment"> +<xsl:text>% ---------------------------------------------- </xsl:text> +<xsl:text>% Define a new LaTeX environment (adminipage) </xsl:text> +<xsl:text>% ---------------------------------------------- </xsl:text> +<xsl:text>\newenvironment{admminipage}% </xsl:text> +<xsl:text>{ % this code corresponds to the \begin{adminipage} command </xsl:text> +<xsl:text> \begin{Sbox}% </xsl:text> +<xsl:text> \begin{minipage}% </xsl:text> +<xsl:text>} %done </xsl:text> +<xsl:text>{ % this code corresponds to the \end{adminipage} command </xsl:text> +<xsl:text> \end{minipage} </xsl:text> +<xsl:text> \end{Sbox} </xsl:text> +<xsl:text> \fbox{\TheSbox} </xsl:text> +<xsl:text>} %done </xsl:text> +<xsl:text>% ---------------------------------------------- </xsl:text> +<xsl:text>% Define a new LaTeX length (admlength) </xsl:text> +<xsl:text>% ---------------------------------------------- </xsl:text> +<xsl:text>\newlength{\admlength} </xsl:text> +<xsl:text>% ---------------------------------------------- </xsl:text> +<xsl:text>% Define a new LaTeX environment (admonition) </xsl:text> +<xsl:text>% With 2 parameters: </xsl:text> +<xsl:text>% #1 The file (e.g. note.pdf) </xsl:text> +<xsl:text>% #2 The caption </xsl:text> +<xsl:text>% ---------------------------------------------- </xsl:text> +<xsl:text>\newenvironment{admonition}[2] </xsl:text> +<xsl:text>{ % this code corresponds to the \begin{admonition} command </xsl:text> +<xsl:text> \hspace{0mm}\newline\hspace*\fill\newline </xsl:text> +<xsl:text> \noindent </xsl:text> +<xsl:text> \setlength{\fboxsep}{5pt} </xsl:text> +<xsl:text> \setlength{\admlength}{\linewidth} </xsl:text> +<xsl:text> \addtolength{\admlength}{-10\fboxsep} </xsl:text> +<xsl:text> \addtolength{\admlength}{-10\fboxrule} </xsl:text> +<xsl:text> \admminipage{\admlength} </xsl:text> +<xsl:text> {\bfseries \sc\large{#2}}</xsl:text> +<xsl:text> \newline </xsl:text> +<xsl:text> \\[1mm] </xsl:text> +<xsl:text> \sffamily </xsl:text> +<!-- +If we cannot find the latex.admonition.path; +Comment out the next line (\includegraphics). +This tactic is to avoid deleting the \includegraphics +altogether, as that could confuse a person trying to +find the use of parameter #1 in the environment. +--> +<xsl:if test="$latex.admonition.path=''"> + <xsl:text>%</xsl:text> +</xsl:if> +<xsl:text> \includegraphics[</xsl:text> <xsl:value-of select="$latex.admonition.imagesize" /> <xsl:text>]{#1} </xsl:text> +<xsl:text> \addtolength{\admlength}{-1cm} </xsl:text> +<xsl:text> \addtolength{\admlength}{-20pt} </xsl:text> +<xsl:text> \begin{minipage}[lt]{\admlength} </xsl:text> +<xsl:text> \parskip=0.5\baselineskip \advance\parskip by 0pt plus 2pt </xsl:text> +<xsl:text>} %done </xsl:text> +<xsl:text>{ % this code corresponds to the \end{admonition} command </xsl:text> +<xsl:text> \vspace{5mm} </xsl:text> +<xsl:text> \end{minipage} </xsl:text> +<xsl:text> \endadmminipage </xsl:text> +<xsl:text> \vspace{.5em} </xsl:text> +<xsl:text> \par </xsl:text> +<xsl:text>} </xsl:text> +</xsl:variable> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template name="admon.graphic" xmlns=""> + <refpurpose> Choose an admonition graphic </refpurpose> + <refdescription> + <para> For each admonition element (note, warning, caution, top, important), + this template chooses the graphics filename. If the admonition element is + not known, the <sgmltag class="element">note</sgmltag> graphic is used. + </para> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template name="admon.graphic"> + <xsl:param name="node" select="."/> + <xsl:choose> + <xsl:when test="name($node)='note'">note</xsl:when> + <xsl:when test="name($node)='warning'">warning</xsl:when> + <xsl:when test="name($node)='caution'">caution</xsl:when> + <xsl:when test="name($node)='tip'">tip</xsl:when> + <xsl:when test="name($node)='important'">important</xsl:when> + <xsl:otherwise>note</xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template name="admonitions" match="note|important|warning|caution|tip" xmlns=""> + <refpurpose> XSL Template for admonitions </refpurpose> + <refdescription> + <para> Uses the <xref linkend="param.latex.admonition.environment"/>. + </para> + <note><para>An admonition will look something like this.</para></note> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + <listitem> + <para> + There can be <quote>excessive</quote> whitespace between + the bottom of the admonition area and a subsequent paragraph. + </para> + </listitem> + </itemizedlist> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="note|important|warning|caution|tip"> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword">admonition</xsl:with-param> + <xsl:with-param name="string"> + <xsl:text>{</xsl:text> + <xsl:value-of select="$latex.admonition.path"/><xsl:text>/</xsl:text> + <xsl:call-template name="admon.graphic"/> + <xsl:text>}{</xsl:text> + <xsl:choose> + <xsl:when test="title and $latex.apply.title.templates.admonitions='1'"> + <xsl:call-template name="extract.object.title"> + <xsl:with-param name="object" select="."/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="gentext.element.name"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text>}</xsl:text> + </xsl:with-param> + </xsl:call-template> + <xsl:apply-templates/> + <xsl:call-template name="map.end"> + <xsl:with-param name="keyword">admonition</xsl:with-param> + </xsl:call-template> + </xsl:template> + + <!-- Empty title template --> + <xsl:template match="note/title|important/title|warning/title|caution/title|tip/title"/> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/authorgroup.mod.xsl b/docs/docbook/xslt/db2latex/authorgroup.mod.xsl new file mode 100644 index 0000000000..6af88ff51a --- /dev/null +++ b/docs/docbook/xslt/db2latex/authorgroup.mod.xsl @@ -0,0 +1,81 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: authorgroup.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: Manage Authorgroups ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="authorgroup" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: authorgroup.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author><firstname>Ramon</firstname> <surname>Casellas</surname></author> + <author><firstname>James</firstname> <surname>Devenish</surname></author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Authorgroup <filename>authorgroup.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <formalpara><title>Pertinent Variables</title> + <itemizedlist> + <listitem><simpara><xref linkend="param.biblioentry.item.separator"/></simpara></listitem> + </itemizedlist> + </formalpara> + </section> + </partintro> + </doc:reference> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="authorgroup" xmlns=""> + <refpurpose> Authorgroup XSL template. </refpurpose> + <refdescription> + </refdescription> + </doc:template> + + <xsl:template match="authorgroup"> + <xsl:for-each select="author"> + <xsl:apply-templates select="."/> + <xsl:if test="not(position()=last())"> + <xsl:text> \and </xsl:text> + </xsl:if> + </xsl:for-each> + </xsl:template> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="authorinitials" xmlns=""> + <refpurpose> AuthorInitials XSL template. </refpurpose> + <refdescription> + </refdescription> + </doc:template> + + <xsl:template match="authorinitials"> + <xsl:apply-templates/> + <xsl:value-of select="$biblioentry.item.separator"/> + </xsl:template> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/biblio.mod.xsl b/docs/docbook/xslt/db2latex/biblio.mod.xsl new file mode 100644 index 0000000000..f26cfb7b2d --- /dev/null +++ b/docs/docbook/xslt/db2latex/biblio.mod.xsl @@ -0,0 +1,608 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: biblio.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: Manage Bibliography. ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="biblio" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: biblio.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year><year>2001</year><year>2002</year><year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Bibliography related XSL Variables and Templates <filename>biblio.mod.xsl</filename></title> + + <partintro> + <section><title>Introduction</title> + <para>This reference describes the templates and parameters relevant + to formatting DocBook bibliography markup.</para> + </section> + <section><title>All Vs. Cited mode</title> + <para> Using this option, only the biblioentries that have been + cited somewhere in the document are output. Otherwise (in All mode) + all bibentries found are output (as the HTML stylesheets do).</para> + </section> + </partintro> + </doc:reference> + <!--############################################################################# --> + + + + <!--############################################################################# + | BIBLIOGRAPHY + |- ############################################################################# + | + | + | + + ############################################################################## --> + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="bibliography" xmlns=""> + <refpurpose> bibliography XSL template </refpurpose> + <refdescription> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + </itemizedlist> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="bibliography"> + <xsl:message>DB2LaTeX: Processing BIBLIOGRAPHY</xsl:message> + <xsl:message>DB2LaTeX: Output Mode : <xsl:value-of select="$latex.biblio.output"/></xsl:message> + <xsl:text>% ------------------------------------------- </xsl:text> + <xsl:text>% </xsl:text> + <xsl:text>% Bibliography </xsl:text> + <xsl:text>% </xsl:text> + <xsl:text>% ------------------------------------------- </xsl:text> + <xsl:text>\bibliography{</xsl:text><xsl:value-of select="$latex.bibfiles"/><xsl:text>} </xsl:text> + <xsl:if test="biblioentry or bibliodiv"> + <xsl:text>\begin{thebibliography}{</xsl:text> + <xsl:value-of select="$latex.bibwidelabel"/> + <xsl:text>} </xsl:text> + <xsl:choose> + <xsl:when test="$latex.biblio.output ='cited'"> + <xsl:apply-templates select="biblioentry" mode="bibliography.cited"> + <xsl:sort select="./abbrev"/> + <xsl:sort select="./@xreflabel"/> + <xsl:sort select="./@id"/> + </xsl:apply-templates> + </xsl:when> + <xsl:when test="$latex.biblio.output ='all'"> + <xsl:apply-templates select="biblioentry" mode="bibliography.all"> + <xsl:sort select="./abbrev"/> + <xsl:sort select="./@xreflabel"/> + <xsl:sort select="./@id"/> + </xsl:apply-templates> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="biblioentry"> + <xsl:sort select="./abbrev"/> + <xsl:sort select="./@xreflabel"/> + <xsl:sort select="./@id"/> + </xsl:apply-templates> + </xsl:otherwise> + </xsl:choose> + <!-- <xsl:apply-templates select="child::*[name(.)!='biblioentry']"/> --> + <xsl:apply-templates select="bibliodiv"/> + <xsl:text> \end{thebibliography} </xsl:text> + </xsl:if> + </xsl:template> + + <xsl:template match="bibliography/title"/> + <xsl:template match="bibliography/subtitle"/> + <xsl:template match="bibliography/titleabbrev"/> + + + + <!--############################################################################# + | BIBLIODIV + |- ############################################################################# + | + | + | + + ############################################################################## --> + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="bibliodiv" xmlns=""> + <refpurpose> bibliography XSL template </refpurpose> + <refdescription> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + </itemizedlist> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="bibliodiv"> + <xsl:message>DB2LaTeX: Processing BIBLIOGRAPHY - BIBLIODIV</xsl:message> + <!-- + <xsl:call-template name="label.id"/> + <xsl:text> </xsl:text> + <xsl:text>\vspace{1cm}</xsl:text> + <xsl:text>\noindent{\Large {\sc </xsl:text><xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="title"/> </xsl:call-template> + <xsl:text>}}\\ </xsl:text> + --> + <xsl:choose> + <xsl:when test="$latex.biblio.output ='cited'"> + <xsl:apply-templates select="biblioentry" mode="bibliography.cited"> + <xsl:sort select="./abbrev"/> + <xsl:sort select="./@xreflabel"/> + <xsl:sort select="./@id"/> + </xsl:apply-templates> + </xsl:when> + <xsl:when test="$latex.biblio.output ='all'"> + <xsl:apply-templates select="biblioentry"> + <xsl:sort select="./abbrev"/> + <xsl:sort select="./@xreflabel"/> + <xsl:sort select="./@id"/> + </xsl:apply-templates> + </xsl:when> + </xsl:choose> + </xsl:template> + + <xsl:template match="bibliodiv/title"/> + + + + <!--############################################################################# + | BIBLIOENTRY + - ############################################################################# + | + | + | + + ############################################################################## --> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="biblioentry" mode="bibliography.cited" xmlns=""> + <refpurpose> bibliography XSL template </refpurpose> + <refdescription> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + </itemizedlist> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="biblioentry" mode="bibliography.cited"> + <xsl:param name="bibid" select="@id"/> + <xsl:param name="ab" select="abbrev"/> + <xsl:variable name="nx" select="//xref[@linkend=$bibid]"/> + <xsl:variable name="nc" select="//citation[text()=$ab]"/> + <xsl:if test="count($nx) > 0 or count($nc) > 0"> + <xsl:call-template name="biblioentry.output"/> + </xsl:if> + </xsl:template> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="biblioentry" mode="bibliography.all" xmlns=""> + <refpurpose> bibliography XSL template </refpurpose> + <refdescription> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + </itemizedlist> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="biblioentry" mode="bibliography.all"> + <xsl:call-template name="biblioentry.output"/> + </xsl:template> + + <xsl:template match="biblioentry"> + <xsl:call-template name="biblioentry.output"/> + </xsl:template> + + <xsl:template name="biblioentry.output"> + <xsl:variable name="biblioentry.label"> + <xsl:choose> + <xsl:when test="@xreflabel"> + <xsl:value-of select="normalize-space(@xreflabel)"/> + </xsl:when> + <xsl:when test="abbrev"> + <xsl:apply-templates select="abbrev" mode="bibliography.mode"/> + </xsl:when> + <xsl:when test="@id"> + <xsl:value-of select="normalize-space(@id)"/> + </xsl:when> + <xsl:otherwise> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="biblioentry.id"> + <xsl:choose> + <xsl:when test="abbrev"> + <xsl:apply-templates select="abbrev" mode="bibliography.mode"/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.label.id"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:text> </xsl:text> + <xsl:text>% -------------- biblioentry </xsl:text> + <xsl:choose> + <xsl:when test="$biblioentry.label=''"> + <xsl:text>\bibitem</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\bibitem[</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="$biblioentry.label"/> + </xsl:call-template> + <xsl:text>]</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:text>{</xsl:text> + <xsl:value-of select="$biblioentry.id"/> + <xsl:text>}\docbooktolatexbibaux{</xsl:text> + <xsl:call-template name="generate.label.id"/> + <xsl:text>}{</xsl:text> + <xsl:value-of select="$biblioentry.id"/> + <xsl:text>} \hypertarget{</xsl:text> + <xsl:call-template name="generate.label.id"/> + <xsl:text>}{\emph{</xsl:text> <xsl:apply-templates select="title" mode="bibliography.mode"/> <xsl:text>}}</xsl:text> + <xsl:value-of select="$biblioentry.item.separator"/> + <xsl:apply-templates select="author|authorgroup" mode="bibliography.mode"/> + <xsl:for-each select="child::copyright|child::publisher|child::pubdate|child::pagenums|child::isbn|child::editor|child::releaseinfo"> + <xsl:value-of select="$biblioentry.item.separator"/> + <xsl:apply-templates select="." mode="bibliography.mode"/> + </xsl:for-each> + <xsl:text>.</xsl:text> + <xsl:text> </xsl:text> + </xsl:template> + + <!-- EMPTY templates --> + <xsl:template match="abstract" mode="bibliography.mode"/> + <xsl:template match="authorblurb" mode="bibliography.mode"/> + + + + <xsl:template match="abbrev" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="address" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="affiliation" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="shortaffil" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="jobtitle" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="artheader" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="artpagenums" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="author" mode="bibliography.mode"> + <xsl:variable name="authorsstring"> + <xsl:call-template name="person.name"/> + </xsl:variable> + <xsl:value-of select="normalize-space($authorsstring)"/> + </xsl:template> + + + + <xsl:template match="author[position()=last()]" mode="bibliography.mode"> + <xsl:variable name="authorsstring"> + <xsl:call-template name="person.name"/> + </xsl:variable> + <xsl:value-of select="normalize-space($authorsstring)"/> + </xsl:template> + + + <!-- + Authorgroup + calls person.name.list in ../common/common.xsl in order to get a + formatted string. We need to return to "normalized-space(.) of it + --> + + <xsl:template match="authorgroup" mode="bibliography.mode"> + <xsl:variable name="authorsstring"> + <xsl:call-template name="person.name.list"/> + </xsl:variable> + <xsl:value-of select="normalize-space($authorsstring)"/> + </xsl:template> + + <xsl:template match="authorinitials" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="bibliomisc" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="bibliomset" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="bibliomixed" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + + + + + + + <xsl:template match="biblioset" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="biblioset/title|biblioset/citetitle" + mode="bibliography.mode"> + <xsl:variable name="relation" select="../@relation"/> + <xsl:choose> + <xsl:when test="$relation='article'"> + <xsl:call-template name="dingbat"> + <xsl:with-param name="dingbat">ldquo</xsl:with-param> + </xsl:call-template> + <xsl:apply-templates/> + <xsl:call-template name="dingbat"> + <xsl:with-param name="dingbat">rdquo</xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="bookbiblio" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="citetitle" mode="bibliography.mode"> + <I><xsl:apply-templates mode="bibliography.mode"/></I> + </xsl:template> + + <xsl:template match="collab" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="collabname" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="confgroup" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="confdates" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="conftitle" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="confnum" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="confsponsor" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="contractnum" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="contractsponsor" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="contrib" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="copyright" mode="bibliography.mode"> + <xsl:call-template name="gentext.element.name"/> + <xsl:call-template name="gentext.space"/> + <xsl:call-template name="dingbat"> + <xsl:with-param name="dingbat">copyright</xsl:with-param> + </xsl:call-template> + <xsl:call-template name="gentext.space"/> + <xsl:apply-templates select="year" mode="bibliography.mode"/> + <xsl:call-template name="gentext.space"/> + <xsl:apply-templates select="holder" mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="year" mode="bibliography.mode"> + <xsl:apply-templates/><xsl:text>, </xsl:text> + </xsl:template> + + <xsl:template match="year[position()=last()]" mode="bibliography.mode"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="holder" mode="bibliography.mode"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="corpauthor" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="corpname" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="date" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="edition" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="editor" mode="bibliography.mode"> + <xsl:call-template name="person.name"/> + </xsl:template> + + <xsl:template match="firstname" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="honorific" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="indexterm" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="invpartnumber" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="isbn" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="issn" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="issuenum" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="lineage" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="orgname" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="orgdiv" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="othercredit" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="othername" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="pagenums" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="printhistory" mode="bibliography.mode"> + <!-- suppressed --> + </xsl:template> + + <xsl:template match="productname" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="productnumber" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="pubdate" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="publisher" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="publishername" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="pubsnumber" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="releaseinfo" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="revhistory" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="seriesinfo" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="seriesvolnums" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="subtitle" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="surname" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="title" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="titleabbrev" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="volumenum" mode="bibliography.mode"> + <xsl:apply-templates mode="bibliography.mode"/> + </xsl:template> + + <xsl:template match="*" mode="bibliography.mode"> + <xsl:apply-templates select="."/> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/block.mod.xsl b/docs/docbook/xslt/db2latex/block.mod.xsl new file mode 100644 index 0000000000..98d689989d --- /dev/null +++ b/docs/docbook/xslt/db2latex/block.mod.xsl @@ -0,0 +1,177 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: block.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="block" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: block.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author><firstname>Ramon</firstname> <surname>Casellas</surname></author> + <author><firstname>James</firstname> <surname>Devenish</surname></author> + </authorgroup> + <copyright> + <year>2000</year><year>2001</year><year>2002</year><year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>Block Objects <filename>block.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para>Sundry block-formatted objects.</para> + </section> + </partintro> + </doc:reference> + + + + <doc:template name="block.object" xmlns=""> + <refpurpose> + Generic handler for block-formatted objects. + </refpurpose> + <refdescription> + <para> + Calls <xref linkend="template.label.id"/> and then applies templates. + </para> + </refdescription> + </doc:template> + + <xsl:template name="block.object"> + <xsl:call-template name="label.id"/> + <xsl:apply-templates/> + </xsl:template> + + <doc:template match="blockquote" xmlns=""> + <refpurpose> + A quotation set off from the main text (not inline). + </refpurpose> + <refdescription> + <para> + Uses the LaTeX <literal>quote</literal> environment. + If an attribution is present, it will be set at the end. + </para> + </refdescription> + </doc:template> + + <xsl:template match="blockquote"> + <xsl:text>\begin{quote}</xsl:text> + <xsl:apply-templates/> + <xsl:apply-templates select="attribution" mode="block.attribution"/> + <xsl:text>\end{quote} </xsl:text> + </xsl:template> + + <doc:template match="epigraph" xmlns=""> + <refpurpose> + A short inscription that occurs at the beginning of a section, chapter, or document. + </refpurpose> + <refdescription> + <para> + Uses the LaTeX <literal>quote</literal> environment. + If an attribution is present, it will be set at the end. + </para> + </refdescription> + </doc:template> + + <xsl:template match="epigraph"> + <xsl:text>\begin{quote}</xsl:text> + <xsl:apply-templates/> + <xsl:apply-templates select="attribution" mode="block.attribution"/> + <xsl:text>\end{quote} </xsl:text> + </xsl:template> + + <doc:template match="attribution" xmlns=""> + <refpurpose> + This template produces no output. + </refpurpose> + <refdescription> + <para> + The <sgmltag class="element">attribution</sgmltag> element only occurs within + <xref linkend="template.blockquote"/> and <xref linkend="template.epigraph"/>. + However, the templates for those elements use a <quote>mode</quote> mechanism. + Therefore, this template is intentionally suppressed and a replacement exists. + See <xref linkend="template.attribution-block.attribution"/> instead. + </para> + </refdescription> + </doc:template> + + <xsl:template match="attribution"/> + + <doc:template match="attribution" mode="block.attribution" xmlns=""> + <refpurpose> + The source of a block quote or epigraph. + </refpurpose> + <refdescription> + <para> + Starts a new line with right-aligned text preceded by an em dash. + </para> + </refdescription> + </doc:template> + + <xsl:template match="attribution" mode="block.attribution"> + <xsl:text> \hspace*\fill---</xsl:text> + <xsl:apply-templates/> + </xsl:template> + + <doc:template match="sidebar" xmlns=""> + <refpurpose> + A block of text that is isolated from the main flow. + </refpurpose> + <refdescription> + <para> + This is formatted as a plain block. + </para> + </refdescription> + </doc:template> + + <xsl:template match="sidebar"> + <xsl:call-template name="block.object"/> + </xsl:template> + + <doc:template match="sidebar/title|blockquote/title" xmlns=""> + <refpurpose> + Title lines for sundry block elements. + </refpurpose> + <refdescription> + <para> + This is formatted as a line on its own. + </para> + </refdescription> + </doc:template> + + <xsl:template match="sidebar/title|blockquote/title"> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + </xsl:template> + + <doc:template match="ackno" xmlns=""> + <refpurpose> + Acknowledgements in an Article. + </refpurpose> + <refdescription> + <para> + This is formatted as a plain block. + </para> + </refdescription> + </doc:template> + + <xsl:template match="ackno"> + <xsl:apply-templates/> + </xsl:template> + + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/book-article.mod.xsl b/docs/docbook/xslt/db2latex/book-article.mod.xsl new file mode 100644 index 0000000000..594e2f7f2a --- /dev/null +++ b/docs/docbook/xslt/db2latex/book-article.mod.xsl @@ -0,0 +1,545 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: book-article.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: +| This template matches a book / article ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="book-article" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: book-article.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Books and Articles <filename>book-article.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="book" xmlns=""> + <refpurpose>Book XSL Template</refpurpose> + <refdescription> + <para> Most DocBook documents are either articles or books, so the book + XSL template <xref linkend="template.book"/> is one classical entry point + when processign docbook documents.</para> + + <formalpara><title>Tasks</title> + <itemizedlist> + <listitem><para></para></listitem> + </itemizedlist> + </formalpara> + + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + </itemizedlist> + </formalpara> + </refdescription> + <refparameter> + <variablelist> + <varlistentry> + <term>colwidth</term> + <listitem> + <para>The CALS column width specification.</para> + </listitem> + </varlistentry> + </variablelist> + </refparameter> + <refreturn> + :<para>Outputs the LaTeX Code corresponding to a book.</para> + </refreturn> + </doc:template> + + + + + <!--############################################################################# --> + <!-- XSL TEMPLATE book --> + <!-- --> + <!-- Main entry point for a DocBook "book" --> + <!--############################################################################# --> + <xsl:template match="book"> + <!-- book:1: generate.latex.book.preamble --> + <xsl:call-template name="generate.latex.book.preamble"/> + <!-- book:2: output title information --> + <xsl:text>\title{</xsl:text> + <xsl:choose> + <xsl:when test="./title"> + <xsl:apply-templates select="title" mode="maketitle.mode"/> + <xsl:apply-templates select="subtitle" mode="maketitle.mode"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="bookinfo/title" mode="maketitle.mode"/> + <xsl:apply-templates select="bookinfo/subtitle" mode="maketitle.mode"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text>} </xsl:text> + <!-- book:3: output author information --> + <xsl:text>\author{</xsl:text> + <xsl:choose> + <xsl:when test="bookinfo/authorgroup"> + <xsl:apply-templates select="bookinfo/authorgroup"/> + </xsl:when> + <xsl:otherwise> + <xsl:for-each select="bookinfo/author"> + <xsl:apply-templates select="."/> + <xsl:if test="not(position()=last())"> + <xsl:text> \and </xsl:text> + </xsl:if> + </xsl:for-each> + </xsl:otherwise> + </xsl:choose> + <xsl:text>} </xsl:text> + <!-- book:4: dump any preamble after author --> + <xsl:value-of select="$latex.book.afterauthor"/> + <!-- book:5: set some counters --> + <xsl:text> \setcounter{tocdepth}{</xsl:text><xsl:value-of select="$toc.section.depth"/><xsl:text>} </xsl:text> + <xsl:text> \setcounter{secnumdepth}{</xsl:text><xsl:value-of select="$section.depth"/><xsl:text>} </xsl:text> + <!-- book:6: dump the begin document command --> + <xsl:value-of select="$latex.book.begindocument"/> + + <!-- book:7: include external Cover page if specified --> + <xsl:if test="$latex.titlepage.file != ''"> + <xsl:text> \InputIfFileExists{</xsl:text><xsl:value-of select="$latex.titlepage.file"/> + <xsl:text>}{\typeout{WARNING: Using cover page</xsl:text> + <xsl:value-of select="$latex.titlepage.file"/> + <xsl:text>}}</xsl:text> + </xsl:if> + + <!-- book:7b: maketitle and set up pagestyle --> + <xsl:value-of select="$latex.maketitle"/> + <!-- book:8: - APPLY TEMPLATES --> + <xsl:apply-templates/> + <!-- book:9: call map.end --> + <xsl:call-template name="map.end"/> + </xsl:template> + + + <!-- Titles/subtitles --> + <!-- Empty templates --> + + <xsl:template match="book/title"/> + <xsl:template match="book/subtitle"/> + <xsl:template match="book/titleabbrev"/> + <xsl:template match="book/bookinfo/title"/> + <xsl:template match="book/bookinfo/subtitle"/> + <xsl:template match="book/bookinfo/titleabbrev"/> + + <xsl:template match="book/title" mode="maketitle.mode">\bfseries <xsl:apply-templates /></xsl:template> + <xsl:template match="book/subtitle" mode="maketitle.mode">\\[12pt]\normalsize <xsl:apply-templates /></xsl:template> + <xsl:template match="book/bookinfo/title" mode="maketitle.mode">\bfseries <xsl:apply-templates /></xsl:template> + <xsl:template match="book/bookinfo/subtitle" mode="maketitle.mode">\\[12pt]\normalsize <xsl:apply-templates /></xsl:template> + + <xsl:template match="book/bookinfo"> + <xsl:apply-templates select="revhistory" /> + <xsl:apply-templates select="abstract" /> + <xsl:apply-templates select="keywordset" /> + <xsl:apply-templates select="copyright" /> + <xsl:apply-templates select="legalnotice" /> + </xsl:template> + + + + <!--############################################################################# + | Template : article + + ############################################################################# --> + + <!-- DOCUMENTATION --> + <doc:template match="article" xmlns=""> + <refpurpose>Article XSL Template</refpurpose> + <refdescription> + <para> Most DocBook documents are either articles or books, so the article + XSL template <xref linkend="template.article"/> is one classical entry point + when processign docbook documents.</para> + + <formalpara><title>Tasks</title> + <itemizedlist> + <listitem><para>Calls <literal>generate.latex.article.preamble</literal>.</para></listitem> + <listitem><para>Outputs \title, \author, \date, getting the information from its children.</para></listitem> + <listitem><para>Calls <literal>latex.article.begindocument</literal>.</para></listitem> + <listitem><para>Calls <literal>latex.article.maketitle.</literal></para></listitem> + <listitem><para>Applies templates.</para></listitem> + <listitem><para>Calls <literal>latex.article.end</literal> template.</para></listitem> + </itemizedlist> + </formalpara> + + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + <listitem><para> EMPTY templates: article/title and article/subtitle</para></listitem> + </itemizedlist> + </formalpara> + </refdescription> + <refparameter> + <variablelist> + <varlistentry> + <term>colwidth</term> + <listitem> + <para>The CALS column width specification.</para> + </listitem> + </varlistentry> + </variablelist> + </refparameter> + <refreturn> + <para>Outputs the LaTeX Code corresponding to an article.</para> + </refreturn> + </doc:template> + <!--############################################################################# --> + + + <xsl:template match="book/article"> + <xsl:text> \makeatletter\if@openright\cleardoublepage\else\clearpage\fi</xsl:text> + <xsl:call-template name="generate.latex.pagestyle"/> + <xsl:text>\makeatother </xsl:text> + <!-- Get and output article title --> + <xsl:variable name="article.title"> + <xsl:choose> + <xsl:when test="./title"> + <xsl:apply-templates select="./title"/> + </xsl:when> + <xsl:when test="./articleinfo/title"> + <xsl:apply-templates select="./articleinfo/title"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="./artheader/title"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:text>\begin{center}{</xsl:text> + <xsl:value-of select="$latex.book.article.title.style"/> + <xsl:text>{</xsl:text> + <xsl:value-of select="$article.title"/> + <xsl:text>}}\par </xsl:text> + <!-- Display author information --> + <xsl:choose> + <xsl:when test="artheader/author"> + <xsl:text>\textsf{</xsl:text> + <xsl:for-each select="artheader/author"> + <xsl:apply-templates select="."/> + <xsl:if test="not(position()=last())"> + <xsl:text> \and </xsl:text> + </xsl:if> + </xsl:for-each> + <xsl:text>}\par </xsl:text> + </xsl:when> + <xsl:when test="artheader/authorgroup"> + <xsl:text>\textsf{</xsl:text> + <xsl:apply-templates select="artheader/authorgroup"/> + <xsl:text>}\par </xsl:text> + </xsl:when> + <xsl:when test="articleinfo/author"> + <xsl:text>\textsf{</xsl:text> + <xsl:for-each select="articleinfo/author"> + <xsl:apply-templates select="."/> + <xsl:if test="not(position()=last())"> + <xsl:text> \and </xsl:text> + </xsl:if> + </xsl:for-each> + <xsl:text>}\par </xsl:text> + </xsl:when> + <xsl:when test="articleinfo/authorgroup"> + <xsl:text>\textsf{</xsl:text> + <xsl:apply-templates select="articleinfo/authorgroup"/> + <xsl:text>}\par </xsl:text> + </xsl:when> + <xsl:when test="author"> + <xsl:text>\textsf{</xsl:text> + <xsl:for-each select="author"> + <xsl:apply-templates select="."/> + <xsl:if test="not(position()=last())"> + <xsl:text> \and </xsl:text> + </xsl:if> + </xsl:for-each> + <xsl:text>}\par </xsl:text> + </xsl:when> + </xsl:choose> + <xsl:apply-templates select="artheader|articleinfo" mode="article.within.book"/> + <xsl:text>\end{center} </xsl:text> + <xsl:apply-templates select="*[not(self::title)]"/> + </xsl:template> + + <xsl:template match="artheader|articleinfo" mode="article.within.book"> + <xsl:value-of select="."/> + </xsl:template> + + + + <!-- ARTICLE TEMPLATE --> + <xsl:template match="article"> + <!-- Output LaTeX preamble --> + <xsl:call-template name="generate.latex.article.preamble"/> + <!-- Get and output article title --> + <xsl:variable name="article.title"> + <xsl:choose> + <xsl:when test="./title"> + <xsl:apply-templates select="./title"/> + </xsl:when> + <xsl:when test="./articleinfo/title"> + <xsl:apply-templates select="./articleinfo/title"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="./artheader/title"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:text>\title{</xsl:text> + <xsl:value-of select="$latex.article.title.style"/> + <xsl:text>{</xsl:text> + <xsl:value-of select="$article.title"/> + <xsl:text>}} </xsl:text> + <!-- Display date and author information --> + <xsl:variable name="article.date"> + <xsl:apply-templates select="./artheader/date|./articleinfo/date"/> + </xsl:variable> + <xsl:if test="$article.date!=''"> + <xsl:text>\date{</xsl:text> + <xsl:value-of select="$article.date"/> + <xsl:text>} </xsl:text> + </xsl:if> + <xsl:text>\author{</xsl:text> + <xsl:choose> + <xsl:when test="artheader/authorgroup"> + <xsl:apply-templates select="artheader/authorgroup"/> + </xsl:when> + <xsl:when test="articleinfo/authorgroup"> + <xsl:apply-templates select="articleinfo/authorgroup"/> + </xsl:when> + <xsl:when test="artheader/author"> + <xsl:for-each select="artheader/author"> + <xsl:apply-templates select="."/> + <xsl:if test="not(position()=last())"> + <xsl:text> \and </xsl:text> + </xsl:if> + </xsl:for-each> + </xsl:when> + <xsl:when test="articleinfo/author"> + <xsl:for-each select="articleinfo/author"> + <xsl:apply-templates select="."/> + <xsl:if test="not(position()=last())"> + <xsl:text> \and </xsl:text> + </xsl:if> + </xsl:for-each> + </xsl:when> + <xsl:otherwise> + <xsl:for-each select="author"> + <xsl:apply-templates select="."/> + <xsl:if test="not(position()=last())"> + <xsl:text> \and </xsl:text> + </xsl:if> + </xsl:for-each> + </xsl:otherwise> + </xsl:choose> + <xsl:text>} </xsl:text> + <!-- Display begindocument command --> + <xsl:value-of select="$latex.article.begindocument"/> + <xsl:value-of select="$latex.maketitle"/> + <xsl:apply-templates select="*[not(self::title)]"/> + <xsl:value-of select="$latex.article.end"/> + </xsl:template> + + + <xsl:template match="article/title|articleinfo/title|articleinfo/date|artheader/date"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="article/artheader|article/articleinfo"> + <xsl:apply-templates select="legalnotice" /> + <xsl:apply-templates select="abstract"/> + </xsl:template> + + <!-- EMPTY TEMPLATES --> + <xsl:template match="article/subtitle"/> + + + + + <!--############################################################################# + | Template: copyright + |- ############################################################################# --> + <xsl:template match="copyright"> + <xsl:call-template name="gentext.element.name"/> + <xsl:call-template name='gentext.space'/> + <xsl:call-template name="dingbat"> + <xsl:with-param name="dingbat">copyright</xsl:with-param> + </xsl:call-template> + <xsl:call-template name='gentext.space'/> + <xsl:apply-templates select="year"/> + <xsl:call-template name='gentext.space'/> + <xsl:apply-templates select="holder"/> + </xsl:template> + + <xsl:template match="copyright/holder"> + <xsl:apply-templates /> + </xsl:template> + <xsl:template match="copyright/year[position()<last()-1]"> + <xsl:apply-templates /> + <xsl:text>, </xsl:text> + </xsl:template> + + <!-- RCAS 2003/03/11 FIXME : "and" --> + <xsl:template match="copyright/year[position()=last()-1]"> + <xsl:apply-templates /> + <xsl:text>, </xsl:text> + </xsl:template> + + <xsl:template match="copyright/year[position()=last()]"> + <xsl:apply-templates /> + </xsl:template> + + + + + <!--############################################################################# + | Template: name legalnotice.caption + |- ############################################################################# --> + <xsl:template name="legalnotice.caption"> + <xsl:choose> + <xsl:when test="./title"> + <xsl:apply-templates select="./title"/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="gentext"> + <xsl:with-param name="key">legalnotice</xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + <!--############################################################################# + | Template: legalnotice + |- ############################################################################# --> +<xsl:template match="legalnotice"> + <!-- Support for legalnotice. --> + <xsl:text>\vspace{-.3em} </xsl:text> + <xsl:text>\if@twocolumn </xsl:text> + <xsl:text>\noindent\small{\itshape </xsl:text> + <xsl:call-template name="legalnotice.caption"/> + <xsl:text>}\/\bfseries---$\!$% </xsl:text> + <xsl:text>\else </xsl:text> + <xsl:text>\noindent\begin{center}\small\bfseries </xsl:text> + <xsl:call-template name="legalnotice.caption"/> + <xsl:text>\end{center}\quotation\small </xsl:text> + <xsl:text>\fi </xsl:text> + <xsl:apply-templates select="*[not(self::title)]"/> + <xsl:text>\vspace{0.6em}\par\if@twocolumn\else\endquotation\fi </xsl:text> + <xsl:text>\normalsize\rmfamily </xsl:text> +</xsl:template> + + + <xsl:template match="legalnotice/title"> + <xsl:apply-templates/> + </xsl:template> + + + + <!--############################################################################# + | $Id: book-article.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: Table of Contents, Figures, ... + + ############################################################################## --> + + <xsl:template match="toc"> + <xsl:text> </xsl:text> + <xsl:text>\tableofcontents </xsl:text> + </xsl:template> + + <xsl:template match="lot"> + <xsl:choose> + <xsl:when test="@label"> + <xsl:choose> + <xsl:when test="@label='figures'"> + <xsl:text>\listoffigures </xsl:text> + </xsl:when> + <xsl:when test="@label='tables'"> + <xsl:text>\listoftables </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\listoffigures </xsl:text> + <xsl:text>\listoftables </xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:text>\listoffigures </xsl:text> + <xsl:text>\listoftables </xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <xsl:template match="lotentry"> + </xsl:template> + + <xsl:template match="lotentry"/> + <xsl:template match="tocpart|tocchap|tocfront|tocback|tocentry"/> + <xsl:template match="toclevel1|toclevel2|toclevel3|toclevel4|toclevel5"/> + + <doc:template name="generate.latex.pagestyle" xmlns=""> + <refpurpose> Choose the preferred page style for document body </refpurpose> + <refdescription> + <para> + If no page style is preferred by the user, the defaults will be + "empty" for articles, "plain" for books, or "fancy" (if the + fancyhdr packages is permitted). + </para> + <formalpara><title>Pertinent Variables</title> + <itemizedlist> + <listitem><simpara><xref linkend="param.pagestyle"/></simpara></listitem> + <listitem><simpara><xref linkend="param.use.fancyhdr"/></simpara></listitem> + </itemizedlist> + </formalpara> + </refdescription> + </doc:template> + <xsl:template name="generate.latex.pagestyle"> + <xsl:text>\pagestyle{</xsl:text> + <xsl:choose> + <xsl:when test="$latex.pagestyle!=''"><xsl:value-of select="$latex.pagestyle"/></xsl:when> + <xsl:when test="count(//book)>0"> + <xsl:choose> + <xsl:when test="$latex.use.fancyhdr=1"><xsl:text>fancy</xsl:text></xsl:when> + <xsl:otherwise><xsl:text>plain</xsl:text></xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise><xsl:text>empty</xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:text>}</xsl:text> + </xsl:template> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/bridgehead.mod.xsl b/docs/docbook/xslt/db2latex/bridgehead.mod.xsl new file mode 100644 index 0000000000..0fb75841cd --- /dev/null +++ b/docs/docbook/xslt/db2latex/bridgehead.mod.xsl @@ -0,0 +1,74 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: bridgehead.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="bridgehead" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: bridgehead.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author><firstname>Ramon</firstname> <surname>Casellas</surname></author> + <author><firstname>James</firstname> <surname>Devenish</surname></author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>BridgeHead <filename>bridgehead.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para>Handle the <sgmltag class="element">bridgehead</sgmltag> element.</para> + </section> + </partintro> + </doc:reference> + + + <doc:template match="bridgehead" xmlns=""> + <refpurpose> + A free-floating heading. + </refpurpose> + <refdescription> + <para> + Renders un-numbered section headings. + For <literal>renderas</literal> values of sect1, sect2, and sect3, LaTeX <quote>star</quote> commands (such as <literal>\section*</literal>) are used. + Otherwise, a bold heading is put on a line of its own. + </para> + </refdescription> + </doc:template> + + <xsl:template match="bridgehead"> + <xsl:choose> + <xsl:when test="@renderas='sect1' or @renderas='sect2' or @renderas='sect3'"> + <xsl:text> \</xsl:text> + <xsl:if test="@renderas='sect2'"><xsl:text>sub</xsl:text></xsl:if> + <xsl:if test="@renderas='sect3'"><xsl:text>subsub</xsl:text></xsl:if> + <xsl:text>section*{</xsl:text> + <xsl:apply-templates/> + <xsl:text>}</xsl:text> + <xsl:call-template name="label.id"/> + <xsl:text> </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text> </xsl:text> + <xsl:text> \noindent{\bfseries </xsl:text><xsl:apply-templates/><xsl:text>} \\ </xsl:text> + <xsl:call-template name="label.id"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/callout.mod.xsl b/docs/docbook/xslt/db2latex/callout.mod.xsl new file mode 100644 index 0000000000..25ccc95882 --- /dev/null +++ b/docs/docbook/xslt/db2latex/callout.mod.xsl @@ -0,0 +1,64 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: callout.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="callout" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: callout.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Callout <filename>callout.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <xsl:template match="programlistingco|screenco"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="areaspec|areaset|area"> + </xsl:template> + + <xsl:template match="co"> + <xsl:apply-templates select="." mode="callout-bug"/> + </xsl:template> + + <xsl:template match="co" mode="callout-bug"> + <xsl:variable name="conum"> + <xsl:number count="co" format="1"/> + </xsl:variable> + + <xsl:text>(</xsl:text> + <xsl:value-of select="$conum"/> + <xsl:text>)</xsl:text> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/citation.mod.xsl b/docs/docbook/xslt/db2latex/citation.mod.xsl new file mode 100644 index 0000000000..ef3493d413 --- /dev/null +++ b/docs/docbook/xslt/db2latex/citation.mod.xsl @@ -0,0 +1,66 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: citation.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="citation" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: citation.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Citation <filename>citation.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para>This file contais a single (and simple!) XSL template, that maps the + <sgmltag>citation</sgmltag> SGML tag to the LaTeX <literal>\cite{}</literal> + command.</para> + </section> + </partintro> + </doc:reference> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="citation" xmlns=""> + <refpurpose> Citation XSL template. </refpurpose> + <refdescription> + <para> Outputs a simple <literal>\cite{ }</literal> Command, + containing the result of processing the citation's children + </para> + </refdescription> + </doc:template> + + + + <xsl:template match="citation"> + <!-- todo: biblio-citation-check --> + <xsl:text>\docbooktolatexcite{</xsl:text> + <xsl:value-of select="."/> + <xsl:text>}{}</xsl:text> + </xsl:template> + +</xsl:stylesheet> + + diff --git a/docs/docbook/xslt/db2latex/common/ca.xml b/docs/docbook/xslt/db2latex/common/ca.xml new file mode 100644 index 0000000000..fec3efff1a --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/ca.xml @@ -0,0 +1,100 @@ +<localization language="ca"> + +<gentext key="abstract" text="Resum"/> +<gentext key="appendix" text="Apèndix"/> +<gentext key="article" text="Article"/> +<gentext key="bibliography" text="Bibliografia"/> +<gentext key="book" text="Llibre"/> +<gentext key="caution" text="ATENCIÓ"/> +<gentext key="caution" text="Atenció"/> +<gentext key="chapter" text="Capítol"/> +<gentext key="copyright" text="Dret de reproducció"/> +<gentext key="dedication" text="Dedicatòria"/> +<gentext key="edition" text="Edició"/> +<gentext key="equation" text="Equació"/> +<gentext key="example" text="Exemple"/> +<gentext key="figure" text="Figura"/> +<gentext key="glosssee" text="Veure"/> +<gentext key="glossseealso" text="Veure també"/> +<gentext key="glossary" text="Glossari"/> +<gentext key="important" text="IMPORTANT"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Important"/> +<gentext key="index" text="Índex alfabètic"/> +<gentext key="legalnotice" text=""/> +<gentext key="msgaud" text="Audiència"/> +<gentext key="msglevel" text="Nivell"/> +<gentext key="msgorig" text="Origen"/> +<gentext key="note" text="NOTA"/> +<gentext key="note" text="Nota"/> +<gentext key="part" text="Part"/> +<gentext key="preface" text="Prefaci"/> +<gentext key="procedure" text="Procediment"/> +<gentext key="pubdate" text="Data de publicació"/> +<gentext key="published" text="Data de publicació"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="Referència"/> +<gentext key="refname" text="Nom"/> +<gentext key="revision" text="Revisió"/> +<gentext key="revhistory" text="Historial de revisions"/> +<gentext key="section" text="Secció"/> +<gentext key="see" text="Veure"/> +<gentext key="seealso" text="Veure tambié"/> +<gentext key="set" text="Conjunt"/> +<gentext key="setindex" text="Índex del conjunt"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="Pas"/> +<gentext key="tip" text="SUGGERIMENT"/> +<gentext key="table" text="Taula"/> +<gentext key="tip" text="Suggeriment"/> +<gentext key="warning" text="AVÍS"/> +<gentext key="warning" text="Avís"/> +<gentext key="appendix" text="apèndex"/> +<gentext key="chapter" text="capítol"/> +<gentext key="section" text="secció"/> +<gentext key="sidebar" text="glossa"/> +<gentext key="step" text="pas"/> +<gentext key="seealso" text="Veure també"/> + +<gentext key="TableofContents" text="Sumari"/> +<gentext key="in" text="a"/> +<gentext key="by" text="per"/> +<gentext key="Edited" text="Editat"/> +<gentext key="Editedby" text="Editat per"/> +<gentext key="and" text="i"/> +<gentext key="Notes" text="Notes"/> +<gentext key="TableNotes" text="Notes"/> +<gentext key="nonexistantelement" text="element inexistent"/> +<gentext key="Pgs" text="Pàgs."/> +<gentext key="unsupported" text="no reconeguda"/> +<gentext key="xrefto" text="xref a"/> +<gentext key="unexpectedelementname" text="Nom d'element no esperat"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Índex de taules"/> +<gentext key="ListofExamples" text="Índex d'exemples"/> +<gentext key="ListofFigures" text="Índex de figures"/> +<gentext key="ListofEquations" text="Índex d'equacions"/> +<gentext key="ListofUnknown" text="Índex de desconegut ?"/> + +<gentext key="nav-prev" text="Anterior"/> +<gentext key="nav-prev-sibling" text="Retrocedir"/> +<gentext key="nav-next-sibling" text="Avancar"/> +<gentext key="nav-next" text="Seguent"/> +<gentext key="nav-up" text="Pujar"/> +<gentext key="nav-home" text="Inici"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/common.xsl b/docs/docbook/xslt/db2latex/common/common.xsl new file mode 100644 index 0000000000..2f0883a7f3 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/common.xsl @@ -0,0 +1,1929 @@ +<?xml version='1.0'?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" + version='1.0'> + +<!-- ******************************************************************** + $Id: common.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + ******************************************************************** + + Derived from the official DocBook XSL Stylesheets + See http://nwalsh.com/docbook/xsl/ for copyright and other information. + + This file contains general templates common to both the HTML and FO + versions of the DocBook stylesheets. + ******************************************************************** --> + +<doc:reference xmlns=""> +<referenceinfo> +<releaseinfo role="meta"> $Id: common.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ </releaseinfo> +<author> + <surname>Ramon</surname> + <firstname>Casellas</firstname> +</author> +<copyright> + <year>1999</year><year>2000</year> + <holder>Norman Walsh</holder> +</copyright> +</referenceinfo> +<title>Common Template Reference</title> + +<partintro> +<section><title>Introduction</title> + +<para>This is technical reference documentation for the DocBook XSL +Stylesheets; it documents (some of) the parameters, templates, and +other elements of the stylesheets.</para> + +<para>This is not intended to be <quote>user</quote> documentation. +It is provided for developers writing customization layers for the +stylesheets, and for anyone who's interested in <quote>how it +works</quote>.</para> + +<para>Although I am trying to be thorough, this documentation is known +to be incomplete. Don't forget to read the source, too :-)</para> +</section> +</partintro> + +</doc:reference> + +<!-- ==================================================================== --> +<!-- Establish strip/preserve whitespace rules --> + +<xsl:preserve-space elements="*"/> + +<xsl:strip-space elements=" +abstract affiliation anchor answer appendix area areaset areaspec +artheader article audiodata audioobject author authorblurb authorgroup +beginpage bibliodiv biblioentry bibliography biblioset blockquote book +bookbiblio bookinfo callout calloutlist caption caution chapter +citerefentry cmdsynopsis co collab colophon colspec confgroup +copyright dedication docinfo editor entry entrytbl epigraph equation +example figure footnote footnoteref formalpara funcprototype +funcsynopsis glossary glossdef glossdiv glossentry glosslist graphicco +group highlights imagedata imageobject imageobjectco important index +indexdiv indexentry indexterm informalequation informalexample +informalfigure informaltable inlineequation inlinemediaobject +itemizedlist itermset keycombo keywordset legalnotice listitem lot +mediaobject mediaobjectco menuchoice msg msgentry msgexplan msginfo +msgmain msgrel msgset msgsub msgtext note objectinfo +orderedlist othercredit part partintro preface printhistory procedure +programlistingco publisher qandadiv qandaentry qandaset question +refentry reference refmeta refnamediv refsect1 refsect1info refsect2 +refsect2info refsect3 refsect3info refsynopsisdiv refsynopsisdivinfo +revhistory revision row sbr screenco screenshot sect1 sect1info sect2 +sect2info sect3 sect3info sect4 sect4info sect5 sect5info section +sectioninfo seglistitem segmentedlist seriesinfo set setindex setinfo +shortcut sidebar simplelist simplesect spanspec step subject +subjectset substeps synopfragment table tbody textobject tfoot tgroup +thead tip toc tocchap toclevel1 toclevel2 toclevel3 toclevel4 +toclevel5 tocpart varargs variablelist varlistentry videodata +videoobject void warning subjectset + +classsynopsis +constructorsynopsis +destructorsynopsis +fieldsynopsis +methodparam +methodsynopsis +ooclass +ooexception +oointerface +simplemsgentry +"/> + +<!-- ====================================================================== --> + +<doc:template name="is.component" xmlns=""> +<refpurpose>Tests if a given node is a component-level element</refpurpose> + +<refdescription> +<para>This template returns '1' if the specified node is a component +(Chapter, Appendix, etc.), and '0' otherwise.</para> +</refdescription> + +<refparameter> +<variablelist> +<varlistentry><term>node</term> +<listitem> +<para>The node which is to be tested.</para> +</listitem> +</varlistentry> +</variablelist> +</refparameter> + +<refreturn> +<para>This template returns '1' if the specified node is a component +(Chapter, Appendix, etc.), and '0' otherwise.</para> +</refreturn> +</doc:template> + +<xsl:template name="is.component"> + <xsl:param name="node" select="."/> + <xsl:choose> + <xsl:when test="local-name($node) = 'appendix' + or local-name($node) = 'article' + or local-name($node) = 'chapter' + or local-name($node) = 'preface' + or local-name($node) = 'bibliography' + or local-name($node) = 'glossary' + or local-name($node) = 'index'">1</xsl:when> + <xsl:otherwise>0</xsl:otherwise> + </xsl:choose> +</xsl:template> + +<!-- ====================================================================== --> + +<doc:template name="is.section" xmlns=""> +<refpurpose>Tests if a given node is a section-level element</refpurpose> + +<refdescription> +<para>This template returns '1' if the specified node is a section +(Section, Sect1, Sect2, etc.), and '0' otherwise.</para> +</refdescription> + +<refparameter> +<variablelist> +<varlistentry><term>node</term> +<listitem> +<para>The node which is to be tested.</para> +</listitem> +</varlistentry> +</variablelist> +</refparameter> + +<refreturn> +<para>This template returns '1' if the specified node is a section +(Section, Sect1, Sect2, etc.), and '0' otherwise.</para> +</refreturn> +</doc:template> + +<xsl:template name="is.section"> + <xsl:param name="node" select="."/> + <xsl:choose> + <xsl:when test="local-name($node) = 'section' + or local-name($node) = 'sect1' + or local-name($node) = 'sect2' + or local-name($node) = 'sect3' + or local-name($node) = 'sect4' + or local-name($node) = 'sect5' + or local-name($node) = 'refsect1' + or local-name($node) = 'refsect2' + or local-name($node) = 'refsect3' + or local-name($node) = 'simplesect'">1</xsl:when> + <xsl:otherwise>0</xsl:otherwise> + </xsl:choose> +</xsl:template> + +<!-- ====================================================================== --> + +<doc:template name="section.level" xmlns=""> +<refpurpose>Returns the hierarchical level of a section.</refpurpose> + +<refdescription> +<para>This template calculates the hierarchical level of a section. +Hierarchically, components are <quote>top level</quote>, so a +<sgmltag>sect1</sgmltag> is at level 2, <sgmltag>sect3</sgmltag> is +at level 3, etc.</para> + +<para>Recursive sections are calculated down to the sixth level.</para> +</refdescription> + +<refparameter> +<variablelist> +<varlistentry><term>node</term> +<listitem> +<para>The section node for which the level should be calculated. +Defaults to the context node.</para> +</listitem> +</varlistentry> +</variablelist> +</refparameter> + +<refreturn> +<para>The section level, <quote>2</quote>, <quote>3</quote>, etc. +</para> +</refreturn> +</doc:template> + +<xsl:template name="section.level"> + <xsl:param name="node" select="."/> + <xsl:choose> + <xsl:when test="name($node)='sect1'">2</xsl:when> + <xsl:when test="name($node)='sect2'">3</xsl:when> + <xsl:when test="name($node)='sect3'">4</xsl:when> + <xsl:when test="name($node)='sect4'">5</xsl:when> + <xsl:when test="name($node)='sect5'">6</xsl:when> + <xsl:when test="name($node)='section'"> + <xsl:choose> + <xsl:when test="$node/../../../../../section">6</xsl:when> + <xsl:when test="$node/../../../../section">5</xsl:when> + <xsl:when test="$node/../../../section">4</xsl:when> + <xsl:when test="$node/../../section">3</xsl:when> + <xsl:otherwise>2</xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:when test="name($node)='simplesect'"> + <xsl:choose> + <xsl:when test="$node/../../sect1">3</xsl:when> + <xsl:when test="$node/../../sect2">4</xsl:when> + <xsl:when test="$node/../../sect3">5</xsl:when> + <xsl:when test="$node/../../sect4">6</xsl:when> + <xsl:when test="$node/../../sect5">6</xsl:when> + <xsl:when test="$node/../../section"> + <xsl:choose> + <xsl:when test="$node/../../../../../section">6</xsl:when> + <xsl:when test="$node/../../../../section">5</xsl:when> + <xsl:when test="$node/../../../section">4</xsl:when> + <xsl:otherwise>3</xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise>2</xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise>2</xsl:otherwise> + </xsl:choose> +</xsl:template><!-- section.level --> + +<doc:template name="qanda.section.level" xmlns=""> +<refpurpose>Returns the hierarchical level of a QandASet.</refpurpose> + +<refdescription> +<para>This template calculates the hierarchical level of a QandASet. +</para> +</refdescription> + +<refreturn> +<para>The level, <quote>1</quote>, <quote>2</quote>, etc. +</para> +</refreturn> +</doc:template> + +<xsl:template name="qanda.section.level"> + <xsl:variable name="section" + select="(ancestor::section + |ancestor::simplesect + |ancestor::sect5 + |ancestor::sect4 + |ancestor::sect3 + |ancestor::sect2 + |ancestor::sect1 + |ancestor::refsect3 + |ancestor::refsect2 + |ancestor::refsect1)[last()]"/> + <xsl:choose> + <xsl:when test="count($section) = '0'">1</xsl:when> + <xsl:otherwise> + <xsl:call-template name="section.level"> + <xsl:with-param name="node" select="$section"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template name="qandadiv.section.level"> + <xsl:variable name="section.level"> + <xsl:call-template name="qanda.section.level"/> + </xsl:variable> + <xsl:variable name="anc.divs" select="ancestor::qandadiv"/> + + <xsl:value-of select="count($anc.divs) + number($section.level)"/> +</xsl:template> + +<!-- ====================================================================== --> + +<xsl:template name="object.id"> + <xsl:param name="object" select="."/> + <xsl:choose> + <xsl:when test="$object/@id"> + <xsl:value-of select="$object/@id"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="generate-id($object)"/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template name="person.name"> + <!-- Return a formatted string representation of the contents of + the specified node (by default, the current element). + Handles Honorific, FirstName, SurName, and Lineage. + If %author-othername-in-middle% is #t, also OtherName + Handles *only* the first of each. + Format is "Honorific. FirstName [OtherName] SurName, Lineage" + --> + <xsl:param name="node" select="."/> + + <xsl:choose> + <!-- handle corpauthor as a special case...--> + <xsl:when test="name($node)='corpauthor'"> + <xsl:apply-templates select="$node"/> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="h_nl" select="$node//honorific[1]"/> + <xsl:variable name="f_nl" select="$node//firstname[1]"/> + <xsl:variable name="o_nl" select="$node//othername[1]"/> + <xsl:variable name="s_nl" select="$node//surname[1]"/> + <xsl:variable name="l_nl" select="$node//lineage[1]"/> + + <xsl:variable name="has_h" select="$h_nl"/> + <xsl:variable name="has_f" select="$f_nl"/> + <xsl:variable name="has_o" + select="$o_nl and ($author.othername.in.middle != 0)"/> + <xsl:variable name="has_s" select="$s_nl"/> + <xsl:variable name="has_l" select="$l_nl"/> + + <xsl:if test="$has_h"> + <xsl:value-of select="$h_nl"/>. + </xsl:if> + + <xsl:if test="$has_f"> + <xsl:if test="$has_h"><xsl:text> </xsl:text></xsl:if> + <xsl:value-of select="$f_nl"/> + </xsl:if> + + <xsl:if test="$has_o"> + <xsl:if test="$has_h or $has_f"><xsl:text> </xsl:text></xsl:if> + <xsl:value-of select="$o_nl"/> + </xsl:if> + + <xsl:if test="$has_s"> + <xsl:if test="$has_h or $has_f or $has_o"> + <xsl:text> </xsl:text> + </xsl:if> + <xsl:value-of select="$s_nl"/> + </xsl:if> + + <xsl:if test="$has_l"> + <xsl:text>, </xsl:text> + <xsl:value-of select="$l_nl"/> + </xsl:if> + </xsl:otherwise> + </xsl:choose> +</xsl:template> <!-- person.name --> + +<xsl:template name="person.name.list"> + <!-- Return a formatted string representation of the contents of + the current element. The current element must contain one or + more AUTHORs, CORPAUTHORs, OTHERCREDITs, and/or EDITORs. + + John Doe + or + John Doe and Jane Doe + or + John Doe, Jane Doe, and A. Nonymous + --> + <xsl:param name="person.list" select="./author|./corpauthor|./othercredit|./editor"/> + <xsl:param name="person.count" select="count($person.list)"/> + <xsl:param name="count" select="1"/> + + <xsl:choose> + <xsl:when test="$count>$person.count"></xsl:when> + <xsl:otherwise> + <xsl:call-template name="person.name"> + <xsl:with-param name="node" select="$person.list[position()=$count]"/> + </xsl:call-template> + <xsl:if test="$count<$person.count"> + <xsl:if test="$person.count>2">,</xsl:if> + <xsl:text> </xsl:text> + </xsl:if> + <xsl:if test="$count+1=$person.count">and </xsl:if> + <xsl:call-template name="person.name.list"> + <xsl:with-param name="person.list" select="$person.list"/> + <xsl:with-param name="person.count" select="$person.count"/> + <xsl:with-param name="count" select="$count+1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> +</xsl:template><!-- person.name.list --> + +<!-- === synopsis ======================================================= --> +<!-- The following definitions match those given in the reference + documentation for DocBook V3.0 +--> + +<xsl:variable name="arg.choice.opt.open.str">[</xsl:variable> +<xsl:variable name="arg.choice.opt.close.str">]</xsl:variable> +<xsl:variable name="arg.choice.req.open.str">{</xsl:variable> +<xsl:variable name="arg.choice.req.close.str">}</xsl:variable> +<xsl:variable name="arg.choice.plain.open.str"><xsl:text> </xsl:text></xsl:variable> +<xsl:variable name="arg.choice.plain.close.str"><xsl:text> </xsl:text></xsl:variable> +<xsl:variable name="arg.choice.def.open.str">[</xsl:variable> +<xsl:variable name="arg.choice.def.close.str">]</xsl:variable> +<xsl:variable name="arg.rep.repeat.str">...</xsl:variable> +<xsl:variable name="arg.rep.norepeat.str"></xsl:variable> +<xsl:variable name="arg.rep.def.str"></xsl:variable> +<xsl:variable name="arg.or.sep"> | </xsl:variable> +<xsl:variable name="cmdsynopsis.hanging.indent">4pi</xsl:variable> + +<!-- ====================================================================== --> +<!-- label content --> + +<doc:mode mode="label.content" xmlns=""> +<refpurpose>Provides access to element labels</refpurpose> +<refdescription> +<para>Processing an element in the +<literal role="mode">label.content</literal> mode produces the +element label.</para> +<para>If the label is non-null, either because the +<sgmltag class="attribute">label</sgmltag> attribute was present on the +element or the stylesheet automatically generated a label, trailing +punctuation is automatically added.</para> +</refdescription> +</doc:mode> + +<xsl:template match="*" mode="label.content"> + <xsl:message> + <xsl:text>Request for label of unexpected element: </xsl:text> + <xsl:value-of select="name(.)"/> + </xsl:message> +</xsl:template> + +<xsl:template match="set|book" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:if test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:if> +</xsl:template> + +<xsl:template match="part" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$part.autolabel != 0"> + <xsl:number from="book" count="part" format="I"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="preface" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$preface.autolabel != 0"> + <xsl:number from="book" count="preface" format="1" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="chapter" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$chapter.autolabel != 0"> + <xsl:number from="book" count="chapter" format="1" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="appendix" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$chapter.autolabel != 0"> + <xsl:number from="book" count="appendix" format="A" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="article" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:if test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:if> +</xsl:template> + +<xsl:template match="dedication|colophon" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:if test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:if> +</xsl:template> + +<xsl:template match="reference" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$part.autolabel != 0"> + <xsl:number from="book" count="reference" format="I" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="refentry" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:if test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:if> +</xsl:template> + +<xsl:template match="section" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + + <!-- if this is a nested section, label the parent --> + <xsl:if test="local-name(..) = 'section'"> + <xsl:apply-templates select=".." mode="label.content"> + <xsl:with-param name="punct">.</xsl:with-param> + </xsl:apply-templates> + </xsl:if> + + <!-- if the parent is a component, maybe label that too --> + <xsl:variable name="parent.is.component"> + <xsl:call-template name="is.component"> + <xsl:with-param name="node" select=".."/> + </xsl:call-template> + </xsl:variable> + + <!-- does this section get labelled? --> + <xsl:variable name="label"> + <xsl:call-template name="label.this.section"> + <xsl:with-param name="section" select="."/> + </xsl:call-template> + </xsl:variable> + + <xsl:if test="$section.label.includes.component.label != 0 + and $parent.is.component != 0"> + <xsl:apply-templates select=".." mode="label.content"> + <xsl:with-param name="punct">.</xsl:with-param> + </xsl:apply-templates> + </xsl:if> + + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$label != 0"> + <xsl:number count="section"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="sect1" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + + <!-- if the parent is a component, maybe label that too --> + <xsl:variable name="parent.is.component"> + <xsl:call-template name="is.component"> + <xsl:with-param name="node" select=".."/> + </xsl:call-template> + </xsl:variable> + <xsl:if test="$section.label.includes.component.label != 0 + and $parent.is.component"> + <xsl:apply-templates select=".." mode="label.content"> + <xsl:with-param name="punct">.</xsl:with-param> + </xsl:apply-templates> + </xsl:if> + + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$section.autolabel != 0"> + <xsl:number count="sect1"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="sect2|sect3|sect4|sect5" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + + <!-- label the parent --> + <xsl:apply-templates select=".." mode="label.content"> + <xsl:with-param name="punct">.</xsl:with-param> + </xsl:apply-templates> + + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$section.autolabel != 0"> + <xsl:choose> + <xsl:when test="local-name(.) = 'sect2'"> + <xsl:number count="sect2"/> + </xsl:when> + <xsl:when test="local-name(.) = 'sect3'"> + <xsl:number count="sect3"/> + </xsl:when> + <xsl:when test="local-name(.) = 'sect4'"> + <xsl:number count="sect4"/> + </xsl:when> + <xsl:when test="local-name(.) = 'sect5'"> + <xsl:number count="sect5"/> + </xsl:when> + <xsl:otherwise> + <xsl:message>label.content: this can't happen!</xsl:message> + </xsl:otherwise> + </xsl:choose> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="refsect1|refsect2|refsect3" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$section.autolabel != 0"> + <xsl:number level="multiple" count="refsect1|refsect2|refsect3"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="simplesect" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$section.autolabel != 0"> + <xsl:number level="multiple" count="section + |sect1|sect2|sect3|sect4|sect5 + |refsect1|refsect2|refsect3 + |simplesect"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="qandadiv" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:variable name="prefix"> + <xsl:if test="$qanda.inherit.numeration != 0"> + <xsl:variable name="lparent" select="(ancestor::set + |ancestor::book + |ancestor::chapter + |ancestor::appendix + |ancestor::preface + |ancestor::section + |ancestor::simplesect + |ancestor::sect1 + |ancestor::sect2 + |ancestor::sect3 + |ancestor::sect4 + |ancestor::sect5 + |ancestor::refsect1 + |ancestor::refsect2 + |ancestor::refsect3)[last()]"/> + <xsl:if test="count($lparent)>0"> + <xsl:apply-templates select="$lparent" mode="label.content"/> + </xsl:if> + </xsl:if> + </xsl:variable> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="$prefix"/> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$qandadiv.autolabel != 0"> + <xsl:value-of select="$prefix"/> + <xsl:number level="multiple" count="qandadiv" format="1"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="question|answer" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:variable name="prefix"> + <xsl:if test="$qanda.inherit.numeration != 0"> + <xsl:variable name="lparent" select="(ancestor::set + |ancestor::book + |ancestor::chapter + |ancestor::appendix + |ancestor::preface + |ancestor::section + |ancestor::simplesect + |ancestor::sect1 + |ancestor::sect2 + |ancestor::sect3 + |ancestor::sect4 + |ancestor::sect5 + |ancestor::refsect1 + |ancestor::refsect2 + |ancestor::refsect3 + |ancestor::qandadiv)[last()]"/> + <xsl:if test="count($lparent)>0"> + <xsl:apply-templates select="$lparent" mode="label.content"/> + </xsl:if> + </xsl:if> + </xsl:variable> + + <xsl:variable name="inhlabel" + select="ancestor-or-self::qandaset/@defaultlabel[1]"/> + + <xsl:variable name="deflabel"> + <xsl:choose> + <xsl:when test="$inhlabel != ''"> + <xsl:value-of select="$inhlabel"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$qanda.defaultlabel"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="label" select="label"/> + + <xsl:choose> + <xsl:when test="count($label)>0"> + <xsl:value-of select="$prefix"/> + <xsl:apply-templates select="$label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + + <xsl:when test="$deflabel = 'qanda'"> + <xsl:call-template name="gentext.element.name"/> + </xsl:when> + + <xsl:when test="$deflabel = 'number'"> + <xsl:if test="name(.) = 'question'"> + <xsl:value-of select="$prefix"/> + <xsl:number level="multiple" count="qandaentry" format="1"/> + <xsl:value-of select="$punct"/> + </xsl:if> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template match="bibliography|glossary|index" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:if test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:if> +</xsl:template> + +<xsl:template match="figure|table|example|equation" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="pchap" + select="ancestor::chapter|ancestor::appendix"/> + <xsl:choose> + <xsl:when test="count($pchap)>0"> + <xsl:apply-templates select="$pchap" mode="label.content"> + <xsl:with-param name="punct">.</xsl:with-param> + </xsl:apply-templates> + <xsl:number format="1" from="chapter|appendix" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:otherwise> + <xsl:number format="1" from="book|article" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="abstract" mode="label.content"> + <xsl:param name="punct">.</xsl:param> +</xsl:template> + +<!-- ====================================================================== --> + +<xsl:template name="label.this.section"> + <xsl:param name="section" select="."/> + <xsl:value-of select="$section.autolabel"/> +</xsl:template> + +<doc:template name="label.this.section" xmlns=""> +<refpurpose>Returns true if $section should be labelled</refpurpose> +<refdescription> +<para>Returns true if the specified section should be labelled. +By default, this template simply returns $section.autolabel, but +custom stylesheets may override it to get more selective behavior.</para> +</refdescription> +</doc:template> + +<!-- ====================================================================== --> +<!-- title content --> + +<doc:mode mode="title.content" xmlns=""> +<refpurpose>Provides access to element titles</refpurpose> +<refdescription> +<para>Processing an element in the +<literal role="mode">title.content</literal> mode produces the +title of the element. This does not include the label. If +<parameter>text-only</parameter> is true, the text of the title +is returned, without inline markup, otherwise inline markup is processed +(in the default mode). By default, <parameter>text-only</parameter> +is false. +</para> +</refdescription> +</doc:mode> + +<xsl:template match="*" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:choose> + <xsl:when test="title"> + <xsl:apply-templates select="title[1]" mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> + </xsl:when> + <xsl:otherwise> + <xsl:message> + <xsl:text>Request for title of unexpected element: </xsl:text> + <xsl:value-of select="name(.)"/> + </xsl:message> + <xsl:text>???TITLE???</xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="*" mode="no.anchor.mode"> + <xsl:apply-templates select="."/> +</xsl:template> + +<xsl:template match="anchor" mode="no.anchor.mode"> + <!-- nop, suppressed --> +</xsl:template> + +<xsl:template match="title" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:choose> + <xsl:when test="$text-only != 0"> + <xsl:value-of select="."/> + </xsl:when> + <xsl:otherwise> + <xsl:choose> + <xsl:when test="$allow-anchors != 0"> + <xsl:apply-templates/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates mode="no.anchor.mode"/> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="set" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="(setinfo/title|title)[1]" + mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="book" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="(bookinfo/title|title)[1]" + mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="part" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="(partinfo/title|docinfo/title|title)[1]" + mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="preface|chapter|appendix" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:variable name="title" select="(docinfo/title + |prefaceinfo/title + |chapterinfo/title + |appendixinfo/title + |title)[1]"/> + <xsl:choose> + <xsl:when test="$title"> + <xsl:apply-templates select="$title" mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name" select="name(.)"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="dedication|colophon" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:choose> + <xsl:when test="title"> + <xsl:apply-templates select="title" mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name" select="name(.)"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="article" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:variable name="title" select="(artheader/title + |articleinfo/title + |title)[1]"/> + + <xsl:apply-templates select="$title" mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="reference" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="(referenceinfo/title|docinfo/title|title)[1]" + mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="refentry" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:variable name="refmeta" select=".//refmeta"/> + <xsl:variable name="refentrytitle" select="$refmeta//refentrytitle"/> + <xsl:variable name="refnamediv" select=".//refnamediv"/> + <xsl:variable name="refname" select="$refnamediv//refname"/> + + <xsl:variable name="title"> + <xsl:choose> + <xsl:when test="$refentrytitle"> + <xsl:apply-templates select="$refentrytitle[1]" mode="title.content"/> + </xsl:when> + <xsl:when test="$refname"> + <xsl:apply-templates select="$refname[1]" mode="title.content"/> + </xsl:when> + <xsl:otherwise>REFENTRY WITHOUT TITLE???</xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$text-only != 0"> + <xsl:value-of select="$title"/> + </xsl:when> + <xsl:otherwise><xsl:copy-of select="$title"/></xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="refentrytitle|refname" mode="title.content"> + <xsl:apply-templates/> +</xsl:template> + +<xsl:template match="section + |sect1|sect2|sect3|sect4|sect5 + |refsect1|refsect2|refsect3 + |simplesect" + mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:variable name="title" select="(sectioninfo/title + |sect1info/title + |sect2info/title + |sect3info/title + |sect4info/title + |sect5info/title + |refsect1info/title + |refsect2info/title + |refsect3info/title + |title)[1]"/> + + <xsl:apply-templates select="$title" mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="bibliography|glossary|index" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:choose> + <xsl:when test="title"> + <xsl:apply-templates select="title" mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name" select="name(.)"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="figure|table|example|equation" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="title" mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="abstract" mode="title.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:choose> + <xsl:when test="title"> + <xsl:apply-templates select="title" mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name" select="name(.)"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<!-- ====================================================================== --> +<!-- subtitle content --> + +<doc:mode mode="subtitle.content" xmlns=""> +<refpurpose>Provides access to element subtitles</refpurpose> +<refdescription> +<para>Processing an element in the +<literal role="mode">subtitle.content</literal> mode produces the +subtitle of the element. If +<parameter>text-only</parameter> is true, the text of the title +is returned, without inline markup, otherwise inline markup is processed +(in the default mode). By default, <parameter>text-only</parameter> +is false. +</para> +</refdescription> +</doc:mode> + +<xsl:template match="*" mode="subtitle.content"> + <xsl:message> + <xsl:text>Request for subtitle of unexpected element: </xsl:text> + <xsl:value-of select="name(.)"/> + </xsl:message> + <xsl:text>???SUBTITLE???</xsl:text> +</xsl:template> + +<xsl:template match="subtitle" mode="subtitle.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:choose> + <xsl:when test="$text-only != 0"> + <xsl:value-of select="."/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="set" mode="subtitle.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="(setinfo/subtitle|subtitle)[1]" + mode="subtitle.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="book" mode="subtitle.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="(bookinfo/subtitle|subtitle)[1]" + mode="subtitle.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="part" mode="subtitle.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="(partinfo/subtitle + |docinfo/subtitle + |subtitle)[1]" + mode="subtitle.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="preface|chapter|appendix" mode="subtitle.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="(docinfo/subtitle + |prefaceinfo/subtitle + |chapterinfo/subtitle + |appendixinfo/subtitle + |subtitle)[1]" + mode="subtitle.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="dedication|colophon" mode="subtitle.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="subtitle" + mode="subtitle.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="reference" mode="subtitle.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="(referenceinfo/subtitle + |docinfo/subtitle + |subtitle)[1]" + mode="subtitle.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="refentry" mode="subtitle.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="(refentryinfo/subtitle + |docinfo/subtitle)[1]" + mode="subtitle.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<xsl:template match="section + |sect1|sect2|sect3|sect4|sect5 + |refsect1|refsect2|refsect3 + |simplesect" + mode="subtitle.content"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:apply-templates select="(sectioninfo/subtitle + |sect1info/subtitle + |sect2info/subtitle + |sect3info/subtitle + |sect4info/subtitle + |sect5info/subtitle + |refsect1info/subtitle + |refsect2info/subtitle + |refsect3info/subtitle + |subtitle)[1]" + mode="subtitle.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> +</xsl:template> + +<!-- ====================================================================== --> +<!-- title reference (label + title) --> + +<doc:mode mode="title.ref" xmlns=""> +<refpurpose>Provides reference text for an element</refpurpose> +<refdescription> +<para>Processing an element in the +<literal role="mode">title.ref</literal> mode produces the +label and title of the element. +</para> +</refdescription> +<refparameter> +<variablelist> +<varlistentry><term>text-only</term> +<listitem> +<para> If +<parameter>text-only</parameter> is true, the text of the title +is returned, without inline markup, otherwise inline markup is processed +(in the default mode). By default, <parameter>text-only</parameter> +is false.</para> +</listitem> +</varlistentry> +<varlistentry><term>label-wrapper</term> +<listitem> +<para>If <parameter>label-wrapper</parameter> is not the emtpy string, +it must be the name of an element. The element so named will be wrapped +around labels on output.</para> +</listitem> +</varlistentry> +<varlistentry><term>title-wrapper</term> +<listitem> +<para>If <parameter>title.wrapper</parameter> is not the emtpy string, +it must be the name of an element. The element so named will be wrapped +around titles on output.</para> +</listitem> +</varlistentry> +<varlistentry><term>label-wrapper-class</term> +<listitem> +<para>If a <parameter>label-wrapper</parameter> is provided and +<parameter>label-wrapper-class</parameter> is not the emtpy string, +it be used as the value for a <sgmltag class="attribute">class</sgmltag> +attribute on the <parameter>label-wrapper</parameter> element.</para> +<para>This is a dirty hack because it only makes sense for the HTML +stylesheet (there's no <sgmltag class="attribute">class</sgmltag> attribute +on the FO elements). What I'd really like to do is pass an attribute +set as a parameter, but I can't.</para> +</listitem> +</varlistentry> +<varlistentry><term>title-wrapper-class</term> +<listitem> +<para>If a <parameter>title-wrapper</parameter> is provided and +<parameter>title-wrapper-class</parameter> is not the emtpy string, +it be used as the value for a <sgmltag class="attribute">class</sgmltag> +attribute on the <parameter>title-wrapper</parameter> element.</para> +<para>This is a dirty hack because it only makes sense for the HTML +stylesheet (there's no <sgmltag class="attribute">class</sgmltag> attribute +on the FO elements). What I'd really like to do is pass an attribute +set as a parameter, but I can't.</para> +</listitem> +</varlistentry> +</variablelist> +</refparameter> +</doc:mode> + +<xsl:template match="*" mode="title.ref"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:param name="label-wrapper" select="''"/> + <xsl:param name="title-wrapper" select="''"/> + <!-- Dirty hack --> + <xsl:param name="label-wrapper-class" select="''"/> + <xsl:param name="title-wrapper-class" select="''"/> + + <xsl:variable name="label"> + <xsl:apply-templates select="." mode="label.content"/> + </xsl:variable> + + <xsl:if test="$label != ''"> + <xsl:choose> + <xsl:when test="$text-only = 0"> + <xsl:choose> + <xsl:when test="$label-wrapper != ''"> + <xsl:element name="{$label-wrapper}"> + <xsl:if test="$label-wrapper-class != ''"> + <xsl:attribute name="class"> + <xsl:value-of select="$label-wrapper-class"/> + </xsl:attribute> + </xsl:if> + <xsl:copy-of select="$label"/> + </xsl:element> + </xsl:when> + <xsl:otherwise> + <xsl:copy-of select="$label"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text> </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$label"/> + <xsl:text> </xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:if> + + <xsl:choose> + <xsl:when test="$text-only = 0"> + <xsl:choose> + <xsl:when test="$title-wrapper != ''"> + <xsl:element name="{$title-wrapper}"> + <xsl:if test="$title-wrapper-class != ''"> + <xsl:attribute name="class"> + <xsl:value-of select="$title-wrapper-class"/> + </xsl:attribute> + </xsl:if> + <xsl:apply-templates select="." mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> + </xsl:element> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="." mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="." mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="figure|table|example|equation + |chapter|appendix" mode="title.ref"> + <xsl:param name="text-only" select="'0'"/> + <xsl:param name="allow-anchors" select="'0'"/> + <xsl:param name="label-wrapper" select="''"/> + <xsl:param name="title-wrapper" select="''"/> + <!-- Dirty hack --> + <xsl:param name="label-wrapper-class" select="''"/> + <xsl:param name="title-wrapper-class" select="''"/> + + <xsl:variable name="label"> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name"> + <xsl:value-of select="name(.)"/> + </xsl:with-param> + </xsl:call-template> + <xsl:call-template name="gentext.space"/> + <xsl:apply-templates select="." mode="label.content"/> + </xsl:variable> + + <xsl:if test="$label != ''"> + <xsl:choose> + <xsl:when test="$text-only = 0"> + <xsl:choose> + <xsl:when test="$label-wrapper != ''"> + <xsl:element name="{$label-wrapper}"> + <xsl:if test="$label-wrapper-class != ''"> + <xsl:attribute name="class"> + <xsl:value-of select="$label-wrapper-class"/> + </xsl:attribute> + </xsl:if> + <xsl:copy-of select="$label"/> + </xsl:element> + </xsl:when> + <xsl:otherwise> + <xsl:copy-of select="$label"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text> </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$label"/> + <xsl:text> </xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:if> + + <xsl:choose> + <xsl:when test="$text-only = 0"> + <xsl:choose> + <xsl:when test="$title-wrapper != ''"> + <xsl:element name="{$title-wrapper}"> + <xsl:if test="$title-wrapper-class != ''"> + <xsl:attribute name="class"> + <xsl:value-of select="$title-wrapper-class"/> + </xsl:attribute> + </xsl:if> + <xsl:apply-templates select="." mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> + </xsl:element> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="." mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="." mode="title.content"> + <xsl:with-param name="text-only" select="$text-only"/> + <xsl:with-param name="allow-anchors" select="$allow-anchors"/> + </xsl:apply-templates> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<!-- ====================================================================== --> + +<xsl:template name="xref.g.subst"> + <xsl:param name="string"></xsl:param> + <xsl:param name="target" select="."/> + <xsl:variable name="subst">%g</xsl:variable> + + <xsl:choose> + <xsl:when test="contains($string, $subst)"> + <xsl:value-of select="substring-before($string, $subst)"/> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name" select="name($target)"/> + </xsl:call-template> + <xsl:call-template name="xref.g.subst"> + <xsl:with-param name="string" + select="substring-after($string, $subst)"/> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$string"/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template name="xref.t.subst"> + <xsl:param name="string"></xsl:param> + <xsl:param name="target" select="."/> + <xsl:variable name="subst">%t</xsl:variable> + + <xsl:choose> + <xsl:when test="contains($string, $subst)"> + <xsl:call-template name="xref.g.subst"> + <xsl:with-param name="string" + select="substring-before($string, $subst)"/> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + <xsl:call-template name="title.xref"> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + <xsl:call-template name="xref.t.subst"> + <xsl:with-param name="string" + select="substring-after($string, $subst)"/> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="xref.g.subst"> + <xsl:with-param name="string" select="$string"/> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template name="xref.n.subst"> + <xsl:param name="string"></xsl:param> + <xsl:param name="target" select="."/> + <xsl:variable name="subst">%n</xsl:variable> + + <xsl:choose> + <xsl:when test="contains($string, $subst)"> + <xsl:call-template name="xref.t.subst"> + <xsl:with-param name="string" + select="substring-before($string, $subst)"/> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + <xsl:call-template name="number.xref"> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + <xsl:call-template name="xref.t.subst"> + <xsl:with-param name="string" + select="substring-after($string, $subst)"/> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="xref.t.subst"> + <xsl:with-param name="string" select="$string"/> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template name="subst.xref.text"> + <xsl:param name="xref.text"></xsl:param> + <xsl:param name="target" select="."/> + + <xsl:call-template name="xref.n.subst"> + <xsl:with-param name="string" select="$xref.text"/> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> +</xsl:template> + +<!-- ====================================================================== --> + +<xsl:template name="filename-basename"> + <!-- We assume all filenames are really URIs and use "/" --> + <xsl:param name="filename"></xsl:param> + <xsl:param name="recurse" select="false()"/> + + <xsl:choose> + <xsl:when test="substring-after($filename, '/') != ''"> + <xsl:call-template name="filename-basename"> + <xsl:with-param name="filename" + select="substring-after($filename, '/')"/> + <xsl:with-param name="recurse" select="true()"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$filename"/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template name="filename-extension"> + <xsl:param name="filename"></xsl:param> + <xsl:param name="recurse" select="false()"/> + + <!-- Make sure we only look at the base name... --> + <xsl:variable name="basefn"> + <xsl:choose> + <xsl:when test="$recurse"> + <xsl:value-of select="$filename"/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="filename-basename"> + <xsl:with-param name="filename" select="$filename"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:choose> + <xsl:when test="substring-after($basefn, '.') != ''"> + <xsl:call-template name="filename-extension"> + <xsl:with-param name="filename" + select="substring-after($basefn, '.')"/> + <xsl:with-param name="recurse" select="true()"/> + </xsl:call-template> + </xsl:when> + <xsl:when test="$recurse"> + <xsl:value-of select="$basefn"/> + </xsl:when> + <xsl:otherwise></xsl:otherwise> + </xsl:choose> +</xsl:template> + +<!-- ====================================================================== --> + +<doc:template name="select.mediaobject" xmlns=""> +<refpurpose>Selects an appropriate media object from a list</refpurpose> + +<refdescription> +<para>This template examines a list of media objects (usually the +children of a mediaobject or inlinemediaobject) and processes +the "right" object.</para> + +<para>This template relies on a template named "is.acceptable.mediaobject" +to determine if a given object is an acceptable graphic. The semantics +of media objects is that the first acceptable graphic should be used. +</para> + +<para>If no acceptable object is located, nothing happens.</para> +</refdescription> + +<refparameter> +<variablelist> +<varlistentry><term>olist</term> +<listitem> +<para>The node list of potential objects to examine.</para> +</listitem> +</varlistentry> +</variablelist> +</refparameter> + +<refreturn> +<para>Calls <xsl:apply-templates> on the selected object.</para> +</refreturn> +</doc:template> + +<xsl:template name="select.mediaobject"> + <xsl:param name="olist" + select="imageobject|imageobjectco + |videoobject|audioobject|textobject"/> + <xsl:param name="count">1</xsl:param> + + <xsl:if test="$count <= count($olist)"> + <xsl:variable name="object" select="$olist[position()=$count]"/> + + <xsl:variable name="useobject"> + <xsl:choose> + <!-- The phrase is never used --> + <xsl:when test="name($object)='textobject' and $object/phrase"> + <xsl:text>0</xsl:text> + </xsl:when> + <!-- The first textobject is a reasonable fallback --> + <xsl:when test="name($object)='textobject'"> + <xsl:text>1</xsl:text> + </xsl:when> + <!-- If there's only one object, use it --> + <xsl:when test="$count = 1 and count($olist) = 1"> + <xsl:text>1</xsl:text> + </xsl:when> + <!-- Otherwise, see if this one is a useable graphic --> + <xsl:otherwise> + <xsl:choose> + <!-- peek inside imageobjectco to simplify the test --> + <xsl:when test="local-name($object) = 'imageobjectco'"> + <xsl:call-template name="is.acceptable.mediaobject"> + <xsl:with-param name="object" select="$object/imageobject"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="is.acceptable.mediaobject"> + <xsl:with-param name="object" select="$object"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$useobject='1'"> + <xsl:apply-templates select="$object"/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="select.mediaobject"> + <xsl:with-param name="olist" select="$olist"/> + <xsl:with-param name="count" select="$count + 1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:if> +</xsl:template> + +<doc:template name="is.acceptable.mediaobject" xmlns=""> +<refpurpose>Returns '1' if the specified media object is recognized.</refpurpose> + +<refdescription> +<para>This template examines a media object and returns '1' if the +object is recognized as a graphic.</para> +</refdescription> + +<refparameter> +<variablelist> +<varlistentry><term>object</term> +<listitem> +<para>The media object to consider.</para> +</listitem> +</varlistentry> +</variablelist> +</refparameter> + +<refreturn> +<para>0 or 1</para> +</refreturn> +</doc:template> + +<xsl:template name="is.acceptable.mediaobject"> + <xsl:param name="object"></xsl:param> + + <xsl:variable name="filename"> + <xsl:call-template name="mediaobject.filename"> + <xsl:with-param name="object" select="$object"/> + </xsl:call-template> + </xsl:variable> + + <xsl:variable name="ext"> + <xsl:call-template name="filename-extension"> + <xsl:with-param name="filename" select="$filename"/> + </xsl:call-template> + </xsl:variable> + + <!-- there will only be one --> + <xsl:variable name="data" select="$object/videodata + |$object/imagedata + |$object/audiodata"/> + + <xsl:variable name="format" select="$data/@format"/> + + <xsl:variable name="graphic.format"> + <xsl:if test="$format"> + <xsl:call-template name="is.graphic.format"> + <xsl:with-param name="format" select="$format"/> + </xsl:call-template> + </xsl:if> + </xsl:variable> + + <xsl:variable name="graphic.ext"> + <xsl:if test="$ext"> + <xsl:call-template name="is.graphic.extension"> + <xsl:with-param name="ext" select="$ext"/> + </xsl:call-template> + </xsl:if> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$graphic.format = '1'">1</xsl:when> + <xsl:when test="$graphic.ext = '1'">1</xsl:when> + <xsl:otherwise>0</xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template name="is.graphic.format"> + <xsl:param name="format"></xsl:param> + <xsl:if test="$format = 'PNG' + or $format = 'JPG' + or $format = 'JPEG' + or $format = 'linespecific' + or $format = 'GIF' + or $format = 'GIF87a' + or $format = 'GIF89a' + or $format = 'BMP'">1</xsl:if> +</xsl:template> + +<xsl:template name="is.graphic.extension"> + <xsl:param name="ext"></xsl:param> + <xsl:if test="$ext = 'png' + or $ext = 'jpeg' + or $ext = 'jpg' + or $ext = 'avi' + or $ext = 'mpg' + or $ext = 'mpeg' + or $ext = 'qt' + or $ext = 'gif' + or $ext = 'bmp'">1</xsl:if> +</xsl:template> + +<xsl:template name="mediaobject.filename"> + <xsl:param name="object"></xsl:param> + + <xsl:variable name="data" select="$object/videodata + |$object/imagedata + |$object/audiodata"/> + + <xsl:variable name="filename"> + <xsl:choose> + <xsl:when test="$data[@fileref]"> + <xsl:value-of select="$data/@fileref"/> + </xsl:when> + <xsl:when test="$data[@entityref]"> + <xsl:value-of select="unparsed-entity-uri($data/@entityref)"/> + </xsl:when> + <xsl:otherwise></xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="has.ext" select="contains($filename, '.') != ''"/> + + <xsl:variable name="ext"> + <xsl:choose> + <xsl:when test="contains($filename, '.')"> + <xsl:call-template name="filename-extension"> + <xsl:with-param name="filename" select="$filename"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$graphic.default.extension"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="graphic.ext"> + <xsl:call-template name="is.graphic.extension"> + <xsl:with-param name="ext" select="$ext"/> + </xsl:call-template> + </xsl:variable> + + <xsl:choose> + <xsl:when test="not($has.ext)"> + <xsl:choose> + <xsl:when test="$ext != ''"> + <xsl:value-of select="$filename"/> + <xsl:text>.</xsl:text> + <xsl:value-of select="$ext"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$filename"/> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:when test="not($graphic.ext)"> + <xsl:choose> + <xsl:when test="$graphic.default.extension != ''"> + <xsl:value-of select="$filename"/> + <xsl:text>.</xsl:text> + <xsl:value-of select="$graphic.default.extension"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$filename"/> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$filename"/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<!-- ====================================================================== --> + +<doc:template name="check.id.unique" xmlns=""> +<refpurpose>Warn users about references to non-unique IDs</refpurpose> +<refdescription> +<para>If passed an ID in <varname>linkend</varname>, +<function>check.id.unique</function> prints +a warning message to the user if either the ID does not exist or +the ID is not unique.</para> +</refdescription> +</doc:template> + +<xsl:template name="check.id.unique"> + <xsl:param name="linkend"></xsl:param> + <xsl:if test="$linkend != ''"> + <xsl:variable name="targets" select="id($linkend)"/> + <xsl:variable name="target" select="$targets[1]"/> + + <xsl:if test="count($targets)=0"> + <xsl:message> + <xsl:text>Error: no ID for constraint linkend: </xsl:text> + <xsl:value-of select="$linkend"/> + <xsl:text>.</xsl:text> + </xsl:message> + </xsl:if> + + <xsl:if test="count($targets)>1"> + <xsl:message> + <xsl:text>Warning: multiple "IDs" for constraint linkend: </xsl:text> + <xsl:value-of select="$linkend"/> + <xsl:text>.</xsl:text> + </xsl:message> + </xsl:if> + </xsl:if> +</xsl:template> + +<doc:template name="check.idref.targets" xmlns=""> +<refpurpose>Warn users about incorrectly typed references</refpurpose> +<refdescription> +<para>If passed an ID in <varname>linkend</varname>, +<function>check.idref.targets</function> makes sure that the element +pointed to by the link is one of the elements listed in +<varname>element-list</varname> and warns the user otherwise.</para> +</refdescription> +</doc:template> + +<xsl:template name="check.idref.targets"> + <xsl:param name="linkend"></xsl:param> + <xsl:param name="element-list"></xsl:param> + <xsl:if test="$linkend != ''"> + <xsl:variable name="targets" select="id($linkend)"/> + <xsl:variable name="target" select="$targets[1]"/> + + <xsl:if test="count($target) > 0"> + <xsl:if test="not(contains(concat(' ', $element-list, ' '), name($target)))"> + <xsl:message> + <xsl:text>Error: linkend (</xsl:text> + <xsl:value-of select="$linkend"/> + <xsl:text>) points to "</xsl:text> + <xsl:value-of select="name($target)"/> + <xsl:text>" not (one of): </xsl:text> + <xsl:value-of select="$element-list"/> + </xsl:message> + </xsl:if> + </xsl:if> + </xsl:if> +</xsl:template> + +<!-- ====================================================================== --> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/common/cs.xml b/docs/docbook/xslt/db2latex/common/cs.xml new file mode 100644 index 0000000000..81c9c5a9cb --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/cs.xml @@ -0,0 +1,110 @@ +<localization language="cs"> + +<!-- Contributors: + Martin Perina <docbk@ataco.cz> + Jirka Kosek <jirka@kosek.cz> +--> + +<gentext key="abstract" text="Abstrakt"/> +<gentext key="answer" text="Otázka:"/> +<gentext key="appendix" text="Příloha"/> +<gentext key="article" text="Článek"/> +<gentext key="bibliography" text="Bibliografie"/> +<gentext key="book" text="Kniha"/> +<gentext key="caution" text="Výstraha"/> +<gentext key="chapter" text="Kapitola"/> +<gentext key="colophon" text="Tiráž"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Věnování"/> +<gentext key="edition" text="Vydání"/> +<gentext key="equation" text="Rovnice"/> +<gentext key="example" text="Příklad"/> +<gentext key="figure" text="Obrázek"/> +<gentext key="glossary" text="Slovník"/> +<gentext key="glosssee" text="Viz"/> +<gentext key="glossseealso" text="Viz též"/> +<gentext key="important" text="Důležité"/> +<gentext key="index" text="Rejstřík"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="keywordset" text="Klíčovíslova"/> +<gentext key="keyword" text="Klíčovéslovo"/> +<gentext key="legalnotice" text="Právní poznámka"/> +<gentext key="msgaud" text="Publikum"/> +<gentext key="msglevel" text="Úroveň"/> +<gentext key="msgorig" text="Původ"/> +<gentext key="note" text="Poznámka"/> +<gentext key="part" text="Část"/> +<gentext key="preface" text="Předmluva"/> +<gentext key="procedure" text="Postup"/> +<gentext key="published" text="Vydáno"/> +<gentext key="question" text="Otázka:"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="Odkaz"/> +<gentext key="refname" text="Jméno"/> +<gentext key="refsection" text=""/> +<gentext key="refsynopsisdiv" text="Přehled"/> +<gentext key="revhistory" text="Přehled revizí"/> +<gentext key="revision" text="Revize"/> +<gentext key="section" text="Oddíl"/> +<gentext key="sect1" text="Oddíl"/> +<gentext key="sect2" text="Oddíl"/> +<gentext key="sect3" text="Oddíl"/> +<gentext key="sect4" text="Oddíl"/> +<gentext key="sect5" text="Oddíl"/> +<gentext key="see" text="Viz"/> +<gentext key="seealso" text="Viz též"/> +<gentext key="set" text="Sada"/> +<gentext key="setindex" text="Rejstřík sady"/> +<gentext key="sidebar" text="Marginálie"/> +<gentext key="step" text="Krok"/> +<gentext key="table" text="Tabulka"/> +<gentext key="tip" text="Tip"/> +<gentext key="warning" text="Varování"/> + +<gentext key="TableofContents" text="Obsah"/> +<gentext key="in" text="v"/> +<gentext key="by" text=" "/> +<gentext key="Edited" text="Vydáno"/> +<gentext key="Editedby" text="Sestavil"/> +<gentext key="and" text="a"/> +<gentext key="Notes" text="Poznámky"/> +<gentext key="TableNotes" text="Poznámky"/> +<gentext key="nonexistantelement" text="neexistující prvek"/> +<gentext key="Pgs" text="Str."/> +<gentext key="unsupported" text="nepodporovaný"/> +<gentext key="xrefto" text="xref k"/> +<gentext key="unexpectedelementname" text="Neočekávané jméno prvku"/> +<gentext key="Revisedby" text="Revidoval: "/> + +<gentext key="ListofTables" text="Seznam tabulek"/> +<gentext key="ListofExamples" text="Seznam příkladů"/> +<gentext key="ListofFigures" text="Seznam obrázků"/> +<gentext key="ListofEquations" text="Seznam rovnic"/> +<gentext key="ListofUnknown" text="Seznam neznámého"/> + +<gentext key="nav-prev" text="Předcházející"/> +<gentext key="nav-prev-sibling" text="Rychle zpět"/> +<gentext key="nav-next-sibling" text="Rychle dopředu"/> +<gentext key="nav-next" text="Další"/> +<gentext key="nav-up" text="Nahoru"/> +<gentext key="nav-home" text="Domů"/> + +<gentext key="the section called" text="oddíl nazvaný"/> + +<dingbat key="startquote" text="„"/> +<dingbat key="endquote" text="“"/> +<dingbat key="nestedstartquote" text="‚"/> +<dingbat key="nestedendquote" text="‘"/> +<dingbat key="bullet" text="•"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> +<xref element="figure" text="%n"/> +<xref element="example" text="%n"/> +<xref element="table" text="%n"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/da.xml b/docs/docbook/xslt/db2latex/common/da.xml new file mode 100644 index 0000000000..959050230f --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/da.xml @@ -0,0 +1,98 @@ +<localization language="da"> + +<gentext key="abstract" text="Abstract"/> +<gentext key="appendix" text="Appendiks"/> +<gentext key="article" text="Article"/> +<gentext key="bibliography" text="Bibliografi"/> +<gentext key="book" text="Book"/> +<gentext key="caution" text="BEMÆRK"/> +<gentext key="caution" text="Bemærk"/> +<gentext key="chapter" text="Kapitel"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Tilegnet"/> +<gentext key="edition" text="Udgave"/> +<gentext key="equation" text="Ligning"/> +<gentext key="example" text="Eksempel"/> +<gentext key="figure" text="Figur"/> +<gentext key="glosssee" text="Se"/> +<gentext key="glossseealso" text="Se også"/> +<gentext key="glossary" text="Stikordregister"/> +<gentext key="important" text="VIGTIGT"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Vigtigt"/> +<gentext key="index" text="Index"/> +<gentext key="legalnotice" text=""/> +<gentext key="msgaud" text="Målgruppe"/> +<gentext key="msglevel" text="Niveau"/> +<gentext key="msgorig" text="Grundlag"/> +<gentext key="note" text="NOTE"/> +<gentext key="note" text="Note"/> +<gentext key="part" text="Del"/> +<gentext key="preface" text="Forord"/> +<gentext key="procedure" text="Procedure"/> +<gentext key="pubdate" text="Udgivet"/> +<gentext key="published" text="Published"/> +<gentext key="refname" text="Navn"/> +<gentext key="reference" text="Reference"/> +<gentext key="revision" text="Revision"/> +<gentext key="revhistory" text="Revision historie"/> +<gentext key="section" text="Afsnit"/> +<gentext key="see" text="Se"/> +<gentext key="seealso" text="Se også"/> +<gentext key="set" text="Set"/> +<gentext key="setindex" text="Set Index"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="Skridt"/> +<gentext key="tip" text="TIP"/> +<gentext key="table" text="Tabel"/> +<gentext key="tip" text="Tip"/> +<gentext key="warning" text="ADVARSEL"/> +<gentext key="warning" text="Advarsel"/> +<gentext key="appendix" text="appendiks"/> +<gentext key="chapter" text="kapitel"/> +<gentext key="section" text="sektion"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="skridt"/> +<gentext key="seealso" text="Se også"/> + +<gentext key="TableofContents" text="Indholdsfortegnelse"/> +<gentext key="by" text="af"/> +<gentext key="Edited" text="Redigeret"/> +<gentext key="Editedby" text="Redigeret af"/> +<gentext key="and" text="og"/> +<gentext key="Notes" text="Slutbemærkning:"/> +<gentext key="TableNotes" text="Noter:"/> +<gentext key="nonexistantelement" text="non-existant element"/> +<gentext key="Pgs" text="siderne"/> +<gentext key="unsupported" text="unsupported"/> +<gentext key="xrefto" text="xref to"/> +<gentext key="unexpectedelementname" text="Unexpected element name"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Liste over alle tabeller"/> +<gentext key="ListofExamples" text="Liste over alle eksempler"/> +<gentext key="ListofFigures" text="Liste over alle figurer"/> +<gentext key="ListofEquations" text="Liste over alle ligninger"/> +<gentext key="ListofUnknown" text="Liste over alle ????"/> + +<gentext key="nav-prev" text="Forrige"/> +<gentext key="nav-prev-sibling" text="Hurtigt tilbage"/> +<gentext key="nav-next-sibling" text="Hurtigt fremad"/> +<gentext key="nav-next" text="Næste"/> +<gentext key="nav-up" text="Op"/> +<gentext key="nav-home" text="Hjem"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/de.xml b/docs/docbook/xslt/db2latex/common/de.xml new file mode 100644 index 0000000000..8c458b0f5e --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/de.xml @@ -0,0 +1,102 @@ +<localization language="de"> +<!-- + Contributions by: Michael Burschik, burschik@id-pro.de +--> + +<gentext key="abstract" text="Zusammenfassung"/> +<gentext key="appendix" text="Anhang"/> +<gentext key="article" text="Artikel"/> +<gentext key="bibliography" text="Literaturverzeichnis"/> +<gentext key="book" text="Buch"/> +<gentext key="caution" text="Achtung"/> +<gentext key="chapter" text="Kapitel"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Widmung"/> +<gentext key="edition" text="Ausgabe"/> +<gentext key="equation" text="Gleichung"/> +<gentext key="example" text="Beispiel"/> +<gentext key="figure" text="Abbildung"/> +<gentext key="glosssee" text="Siehe"/> +<gentext key="glossseealso" text="Siehe auch"/> +<gentext key="glossary" text="Glossar"/> +<gentext key="important" text="WICHTIG"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="keyword" text="Stichwort"/> +<gentext key="keywords" text="Stichwörter"/> +<gentext key="keywordset" text="Stichwörter"/> +<gentext key="important" text="Wichtig"/> +<gentext key="index" text="Stichwortverzeichnis"/> +<gentext key="legalnotice" text="Rechtlicher Hinweis"/> +<gentext key="msgaud" text="Zielgruppe"/> +<gentext key="msglevel" text="Dringlichkeit"/> +<gentext key="msgorig" text="Ursprung"/> +<gentext key="note" text="Anmerkung"/> +<gentext key="part" text="Teil"/> +<gentext key="preface" text="Vorwort"/> +<gentext key="procedure" text="Prozedur"/> +<gentext key="published" text="Veröffentlicht"/> +<gentext key="refname" text="Name"/> +<gentext key="reference" text="Verweis"/> +<gentext key="refsection" text="Abschnitt"/> +<gentext key="refsynopsisdiv" text="Synopsis"/> <!--en--> +<gentext key="revhistory" text="Versionsgeschichte"/> +<gentext key="revision" text="Version"/> +<gentext key="section" text="Abschnitt"/> +<gentext key="see" text="Siehe"/> +<gentext key="seealso" text="Siehe auch"/> +<gentext key="seealso" text="Siehe auch"/> +<gentext key="set" text="Satz"/> +<gentext key="setindex" text="Stichwortverzeichnis"/> +<gentext key="sidebar" text="Randnotiz"/> +<gentext key="step" text="Schritt"/> +<gentext key="tip" text="TIP"/> +<gentext key="table" text="Tabelle"/> +<gentext key="tip" text="Tip"/> +<gentext key="warning" text="WARNUNG"/> +<gentext key="appendix" text="Anhang"/> +<gentext key="chapter" text="Kapitel"/> +<gentext key="section" text="Abschnitt"/> +<gentext key="step" text="Schritt"/> + +<gentext key="TableofContents" text="Inhaltsverzeichnis"/> +<gentext key="in" text="in"/> +<gentext key="by" text="von"/> +<gentext key="Edited" text="Herausgegeben"/> +<gentext key="Editedby" text="Herausgegeben von"/> +<gentext key="and" text="und"/> +<gentext key="Notes" text="Fußnoten"/> +<gentext key="TableNotes" text="Bemerkungen"/> +<gentext key="nonexistantelement" text="nicht existierendes Element"/> +<gentext key="Pgs" text="Seiten"/> +<gentext key="unsupported" text="wird nicht unterstützt"/> +<gentext key="xrefto" text="xref auf"/> +<gentext key="unexpectedelementname" text="Unerwarteter Elementname"/> +<gentext key="Revisedby" text="Geändert durch: "/> + +<gentext key="ListofTables" text="Tabellenverzeichnis"/> +<gentext key="ListofExamples" text="Beispiele"/> +<gentext key="ListofFigures" text="Abbildungsverzeichnis"/> +<gentext key="ListofEquations" text="Gleichungen"/> +<gentext key="ListofUnknown" text="???-Verzeichnis"/> + +<gentext key="nav-prev" text="Zurück"/> +<gentext key="nav-prev-sibling" text="Schnell zurück"/> +<gentext key="nav-next-sibling" text="Schnell vor"/> +<gentext key="nav-next" text="Vor"/> +<gentext key="nav-up" text="Hoch"/> +<gentext key="nav-home" text="Anfang"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/el.xml b/docs/docbook/xslt/db2latex/common/el.xml new file mode 100644 index 0000000000..ad93032047 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/el.xml @@ -0,0 +1,104 @@ +<localization language="el"> + +<gentext key="abstract" text="Ðåñßëçøç"/> +<gentext key="answer" text="Á:"/> +<gentext key="appendix" text="ÐáñÜñôçìá"/> +<gentext key="article" text="¶ñèñï"/> +<gentext key="bibliography" text="Âéâëéïãñáößá"/> +<gentext key="book" text="Âéâëßï"/> +<gentext key="caution" text="ÐÑÏÓÏ×Ç"/> +<gentext key="caution" text="Ðñïóï÷Þ"/> +<gentext key="chapter" text="ÊåöÜëáéï"/> +<gentext key="colophon" text="Êïñùíßäá"/> +<gentext key="copyright" text="ÐíåõìáôéêÜ Äéêáéþìáôá"/> +<gentext key="dedication" text="ÁöéÝñùóç"/> +<gentext key="edition" text="¸êäïóç"/> +<gentext key="equation" text="Åîßóùóç"/> +<gentext key="example" text="ÐáñÜäåéãìá"/> +<gentext key="figure" text="Ó÷Þìá"/> +<gentext key="glosssee" text="Äåßôå"/> +<gentext key="glossseealso" text="Äåßôå Åðßóçò"/> +<gentext key="glossary" text="ÃëùóóÜñéï"/> +<gentext key="important" text="ÓÇÌÁÍÔÉÊÏ"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Óçìáíôéêü"/> +<gentext key="index" text="ÅõñåôÞñéï"/> +<gentext key="legalnotice" text="ÍïìéêÞ Óçìåßùóç"/> +<gentext key="msgaud" text="ÁêñïáôÞñéï"/> +<gentext key="msglevel" text="Åðßðåäï"/> +<gentext key="msgorig" text="ÐçãÞ"/> +<gentext key="note" text="ÓÇÌÅÉÙÓÇ"/> +<gentext key="note" text="Óçìåßùóç"/> +<gentext key="part" text="ÌÝñïò"/> +<gentext key="preface" text="ÅéóáãùãÞ"/> +<gentext key="procedure" text="Äéáäéêáóßá"/> +<gentext key="published" text="ÄçìïóéåõìÝíï"/> +<gentext key="question" text="Å:"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="ÁíáöïñÜ"/> +<gentext key="refname" text="¼íïìá"/> +<gentext key="refsection" text=""/> +<gentext key="refsynopsisdiv" text="Óýíïøç"/> +<gentext key="revision" text="Áíáèåþñçóç"/> +<gentext key="revhistory" text="Éóôïñéêü ÁíáèåùñÞóåùí"/> +<gentext key="section" text="ÔìÞìá"/> +<gentext key="see" text="Äåßôå"/> +<gentext key="seealso" text="Äåßôå Åðßóçò"/> +<gentext key="set" text="Óýíïëï"/> +<gentext key="setindex" text="ÅõñåôÞñéï Óõíüëùí"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="ÖÜóç"/> +<gentext key="tip" text="ÕÐÏÄÅÉÎÇ"/> +<gentext key="table" text="Ðßíáêáò"/> +<gentext key="tip" text="Õðüäåéîç"/> +<gentext key="warning" text="ÐÑÏÅÉÄÏÐÏÉÇÓÇ"/> +<gentext key="warning" text="Ðñïåéäïðïßçóç"/> +<gentext key="appendix" text="ðáñÜñôçìá"/> +<gentext key="chapter" text="êåöÜëáéï"/> +<gentext key="section" text="ôìÞìá"/> +<gentext key="sidebar" text="åðåîçãçìáôéêü ðëåõñéêü áñèñßäéï"/> +<gentext key="step" text="öÜóç"/> +<gentext key="seealso" text="Äåßôå åðßóçò"/> + +<gentext key="TableofContents" text="Ðßíáêáò Ðåñéå÷ïìÝíùí"/> +<gentext key="in" text="óå"/> +<gentext key="by" text="áðü"/> +<gentext key="Edited" text="ÅðéìÝëåéá"/> +<gentext key="Editedby" text="ÅðéìÝëåéá áðü"/> +<gentext key="and" text="êáé"/> +<gentext key="Notes" text="Óçìåéþóåéò"/> +<gentext key="TableNotes" text="Ðßíáêáò Óçìåéþóåùí"/> +<gentext key="nonexistantelement" text="ìç-õðáñêôü óôïé÷åßï"/> +<gentext key="Pgs" text="Óëäò."/> +<gentext key="unsupported" text="ìç õðïóôçñéæüìåíï"/> +<gentext key="xrefto" text="áíôéðáñáðïìðÞ óå"/> +<gentext key="unexpectedelementname" text="Ìç áíáìåíüìåíï üíïìá óôïé÷åßïõ"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="ÊáôÜëïãïò ÐéíÜêùí"/> +<gentext key="ListofExamples" text="ÊáôÜëïãïò ÐáñáäåéãìÜôùí"/> +<gentext key="ListofFigures" text="ÊáôÜëïãïò Ó÷çìÜôùí"/> +<gentext key="ListofEquations" text="ÊáôÜëïãïò Åîéóþóåùí"/> +<gentext key="ListofUnknown" text="ÊáôÜëïãïò Áãíþóôùí"/> + +<gentext key="nav-prev" text="Ðñïçã"/> +<gentext key="nav-prev-sibling" text="Ðñïò ôçí áñ÷Þ"/> +<gentext key="nav-next-sibling" text="Ðñïò ôï ôÝëïò"/> +<gentext key="nav-next" text="Åðüìåíï"/> +<gentext key="nav-up" text="ÐÜíù"/> +<gentext key="nav-home" text="Áñ÷Þ"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/en.xml b/docs/docbook/xslt/db2latex/common/en.xml new file mode 100644 index 0000000000..2e8500135f --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/en.xml @@ -0,0 +1,107 @@ +<localization language="en"> + +<gentext key="abstract" text="Abstract"/> +<gentext key="answer" text="A:"/> +<gentext key="appendix" text="Appendix"/> +<gentext key="article" text="Article"/> +<gentext key="bibliography" text="Bibliography"/> +<gentext key="book" text="Book"/> +<gentext key="caution" text="Caution"/> +<gentext key="chapter" text="Chapter"/> +<gentext key="colophon" text="Colophon"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Dedication"/> +<gentext key="edition" text="Edition"/> +<gentext key="equation" text="Equation"/> +<gentext key="example" text="Example"/> +<gentext key="figure" text="Figure"/> +<gentext key="formalpara" text="Paragraph"/> +<gentext key="glossary" text="Glossary"/> +<gentext key="glosssee" text="See"/> +<gentext key="glossseealso" text="See also"/> +<gentext key="important" text="Important"/> +<gentext key="index" text="Index"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="keyword" text="Keyword"/> +<gentext key="keywords" text="Keywords"/> +<gentext key="keywordset" text="Keywords"/> +<gentext key="legalnotice" text="Legal Notice"/> +<gentext key="msgaud" text="Audience"/> +<gentext key="msglevel" text="Level"/> +<gentext key="msgorig" text="Origin"/> +<gentext key="note" text="Note"/> +<gentext key="part" text="Part"/> +<gentext key="preface" text="Preface"/> +<gentext key="procedure" text="Procedure"/> +<gentext key="published" text="Published"/> +<gentext key="question" text="Q:"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="Reference"/> +<gentext key="refname" text="Name"/> +<gentext key="refsection" text=""/> +<gentext key="refsynopsisdiv" text="Synopsis"/> +<gentext key="revhistory" text="Revision History"/> +<gentext key="revision" text="Revision"/> +<gentext key="section" text="Section"/> +<gentext key="sect1" text="Section"/> +<gentext key="sect2" text="Section"/> +<gentext key="sect3" text="Section"/> +<gentext key="sect4" text="Section"/> +<gentext key="sect5" text="Section"/> +<gentext key="see" text="See"/> +<gentext key="seealso" text="See Also"/> +<gentext key="set" text="Set"/> +<gentext key="setindex" text="Set Index"/> +<gentext key="sidebar" text="Sidebar"/> +<gentext key="step" text="Step"/> +<gentext key="table" text="Table"/> +<gentext key="tip" text="Tip"/> +<gentext key="warning" text="Warning"/> + +<gentext key="TableofContents" text="Table of Contents"/> +<gentext key="in" text="in"/> +<gentext key="by" text="by"/> +<gentext key="Edited" text="Edited"/> +<gentext key="Editedby" text="Edited by"/> +<gentext key="and" text="and"/> +<gentext key="Notes" text="Notes"/> +<gentext key="TableNotes" text="Notes"/> +<gentext key="nonexistantelement" text="non-existant element"/> +<gentext key="Pgs" text="Pgs."/> +<gentext key="unsupported" text="unsupported"/> +<gentext key="xrefto" text="xref to"/> +<gentext key="unexpectedelementname" text="Unexpected element name"/> +<gentext key="Revisedby" text="Revised by:"/> + +<gentext key="ListofTables" text="List of Tables"/> +<gentext key="ListofExamples" text="List of Examples"/> +<gentext key="ListofFigures" text="List of Figures"/> +<gentext key="ListofEquations" text="List of Equations"/> +<gentext key="ListofUnknown" text="List of Unknown"/> + +<gentext key="nav-prev" text="Prev"/> +<gentext key="nav-prev-sibling" text="Fast Backward"/> +<gentext key="nav-next-sibling" text="Fast Forward"/> +<gentext key="nav-next" text="Next"/> +<gentext key="nav-up" text="Up"/> +<gentext key="nav-home" text="Home"/> + +<gentext key="the section called" text="the section called"/> + +<gentext key="index symbols" text="Symbols"/> + +<dingbat key="startquote" text="``"/> +<dingbat key="endquote" text="''"/> +<dingbat key="nestedstartquote" text="`"/> +<dingbat key="nestedendquote" text="'"/> +<dingbat key="bullet" text="\textbullet{}"/> + +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="preface" text="%t"/> +<xref element="bibliography" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="page.citation" text=" on page %p"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/es.xml b/docs/docbook/xslt/db2latex/common/es.xml new file mode 100644 index 0000000000..78483dfb65 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/es.xml @@ -0,0 +1,98 @@ +<localization language="es"> + +<gentext key="abstract" text="Resumen"/> +<gentext key="appendix" text="Apéndice"/> +<gentext key="article" text="Artículo"/> +<gentext key="bibliography" text="Bibliografía"/> +<gentext key="book" text="Libro"/> +<gentext key="caution" text="ATENCIÓN"/> +<gentext key="caution" text="Atención"/> +<gentext key="chapter" text="Capítulo"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Dedicado"/> +<gentext key="edition" text="Edición"/> +<gentext key="equation" text="Ecuación"/> +<gentext key="example" text="Ejemplo"/> +<gentext key="figure" text="Figura"/> +<gentext key="glosssee" text="Ver"/> +<gentext key="glossseealso" text="Ver también"/> +<gentext key="glossary" text="Glosario"/> +<gentext key="important" text="IMPORTANTE"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Importante"/> +<gentext key="index" text="Índice"/> +<gentext key="legalnotice" text="Aviso Legal"/> +<gentext key="msgaud" text="Audiencia"/> +<gentext key="msglevel" text="Nivel"/> +<gentext key="msgorig" text="Origen"/> +<gentext key="note" text="NOTA"/> +<gentext key="note" text="Nota"/> +<gentext key="part" text="Parte"/> +<gentext key="preface" text="Prefacio"/> +<gentext key="procedure" text="Procedimiento"/> +<gentext key="pubdate" text="Fecha de publicación"/> +<gentext key="published" text="Publicado"/> +<gentext key="refname" text="Nombre"/> +<gentext key="reference" text="Referencia"/> +<gentext key="revision" text="Revisión"/> +<gentext key="revhistory" text="Historial de revisiones"/> +<gentext key="section" text="Sección"/> +<gentext key="see" text="Ver"/> +<gentext key="seealso" text="Ver También"/> +<gentext key="set" text="Conjunto"/> +<gentext key="setindex" text="Índice del conjunto"/> +<gentext key="sidebar" text="Sidebar"/> +<gentext key="step" text="Paso"/> +<gentext key="tip" text="SUGERENCIA"/> +<gentext key="table" text="Tabla"/> +<gentext key="tip" text="Sugerencia"/> +<gentext key="warning" text="AVISO"/> +<gentext key="warning" text="Aviso"/> +<gentext key="appendix" text="apéndice"/> +<gentext key="chapter" text="capítulo"/> +<gentext key="section" text="sección"/> +<gentext key="step" text="paso"/> +<gentext key="seealso" text="Ver También"/> + +<gentext key="TableofContents" text="Tabla de contenidos"/> +<gentext key="in" text="en"/> +<gentext key="by" text="por"/> +<gentext key="Edited" text="Editado"/> +<gentext key="Editedby" text="Editado por"/> +<gentext key="and" text="y"/> +<gentext key="Notes" text="Notas"/> +<gentext key="TableNotes" text="Notas"/> +<gentext key="nonexistantelement" text="elemento inexistente"/> +<gentext key="Pgs" text="Pags."/> +<gentext key="unsupported" text="no soportado"/> +<gentext key="xrefto" text="referido a"/> +<gentext key="unexpectedelementname" text="Nombre de elemento inesperado"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Lista de tablas"/> +<gentext key="ListofExamples" text="Tabla de ejemplos"/> +<gentext key="ListofFigures" text="Tabla de figuras"/> +<gentext key="ListofEquations" text="Tabla de ecuaciones"/> +<gentext key="ListofUnknown" text="Lista de ???"/> + +<gentext key="nav-prev" text="Anterior"/> +<gentext key="nav-prev-sibling" text="Retroceder"/> +<gentext key="nav-next-sibling" text="Avanzar"/> +<gentext key="nav-next" text="Siguiente"/> +<gentext key="nav-up" text="Subir"/> +<gentext key="nav-home" text="Inicio"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/et.xml b/docs/docbook/xslt/db2latex/common/et.xml new file mode 100644 index 0000000000..4c63adbe7a --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/et.xml @@ -0,0 +1,104 @@ +<localization language="et"> + +<gentext key="abstract" text="Ülevaade"/> +<gentext key="answer" text="V:"/> +<gentext key="appendix" text="Lisa"/> +<gentext key="article" text="Artikkel"/> +<gentext key="bibliography" text="Bibliograafia"/> +<gentext key="book" text="Raamat"/> +<gentext key="caution" text="ETTEVAATUST"/> +<gentext key="caution" text="Ettevaatust"/> +<gentext key="chapter" text="Peatükk"/> +<gentext key="colophon" text="Lõpumärgis"/> +<gentext key="copyright" text="Autoriõigus"/> +<gentext key="dedication" text="Pühendus"/> +<gentext key="edition" text="Väljaanne"/> +<gentext key="equation" text="Valem"/> +<gentext key="example" text="Näide"/> +<gentext key="figure" text="Joonis"/> +<gentext key="glosssee" text="Vt."/> +<gentext key="glossseealso" text="Vt. ka"/> +<gentext key="glossary" text="Sõnastik"/> +<gentext key="important" text="OLULINE"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Oluline"/> +<gentext key="index" text="Aineregister"/> +<gentext key="legalnotice" text="Autoriõiguse märge"/> +<gentext key="msgaud" text="Auditoorium"/> +<gentext key="msglevel" text="Tase"/> +<gentext key="msgorig" text="Algallikas"/> +<gentext key="note" text="MÄRKUS"/> +<gentext key="note" text="Märkus"/> +<gentext key="part" text="Osa"/> +<gentext key="preface" text="Eessõna"/> +<gentext key="procedure" text="Protseduur"/> +<gentext key="published" text="Avaldatud"/> +<gentext key="question" text="K:"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="Viide"/> +<gentext key="refname" text="Nimi"/> +<gentext key="refsection" text="Lõik"/> +<gentext key="refsynopsisdiv" text="Sünopsis"/> +<gentext key="revision" text="Vigade parandus"/> +<gentext key="revhistory" text="Vigade paranduste ajalugu"/> +<gentext key="section" text="Sektsioon"/> +<gentext key="see" text="Vt."/> +<gentext key="seealso" text="Vt. ka"/> +<gentext key="set" text="Sea"/> +<gentext key="setindex" text="Sea indeks"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="Samm"/> +<gentext key="tip" text="VIHJE"/> +<gentext key="table" text="Tabel"/> +<gentext key="tip" text="Vihje"/> +<gentext key="warning" text="HOIATUS"/> +<gentext key="warning" text="Hoiatus"/> +<gentext key="appendix" text="lisa"/> +<gentext key="chapter" text="peatükk"/> +<gentext key="section" text="lõik"/> +<gentext key="sidebar" text="külgriba"/> +<gentext key="step" text="samm"/> +<gentext key="seealso" text="Vt. ka"/> + +<gentext key="TableofContents" text="Sisukord"/> +<gentext key="in" text=""/> +<gentext key="by" text=""/> +<gentext key="Edited" text="Redaktsioon"/> +<gentext key="Editedby" text="Redaktsiooni autor(id)"/> +<gentext key="and" text="ja"/> +<gentext key="Notes" text="Märkused"/> +<gentext key="TableNotes" text="Märkused"/> +<gentext key="nonexistantelement" text="mitte eksisteeriv element"/> +<gentext key="Pgs" text="Lk."/> +<gentext key="unsupported" text="toetuseta"/> +<gentext key="xrefto" text="viide"/> +<gentext key="unexpectedelementname" text="Ootamatu elemendi nimi"/> +<gentext key="Revisedby" text="Üle vaadanud: "/> + +<gentext key="ListofTables" text="Tabelite nimekiri"/> +<gentext key="ListofExamples" text="Näidete nimekiri"/> +<gentext key="ListofFigures" text="Jooniste nimekiri"/> +<gentext key="ListofEquations" text="Valemite nimekiri"/> +<gentext key="ListofUnknown" text="Tundmatute nimekiri"/> + +<gentext key="nav-prev" text="Eelmine"/> +<gentext key="nav-prev-sibling" text="Kiiresti tagasi"/> +<gentext key="nav-next-sibling" text="Kiiresti edasi"/> +<gentext key="nav-next" text="Järgmine"/> +<gentext key="nav-up" text="Üles"/> +<gentext key="nav-home" text="Koju"/> + +<dingbat key="startquote" text='“'/> +<dingbat key="endquote" text='”'/> +<dingbat key="nestedstartquote" text="`"/> +<dingbat key="nestedendquote" text="'"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/fi.xml b/docs/docbook/xslt/db2latex/common/fi.xml new file mode 100644 index 0000000000..5d25725512 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/fi.xml @@ -0,0 +1,98 @@ +<localization language="fi"> + +<gentext key="abstract" text="Lyhennelmä"/> +<gentext key="appendix" text="Liite"/> +<gentext key="article" text="Artikkeli"/> +<gentext key="bibliography" text="Lähteet"/> +<gentext key="book" text="Kirja"/> +<gentext key="caution" text="VARO"/> +<gentext key="caution" text="Varo"/> +<gentext key="chapter" text="Luku"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Omistus"/> +<gentext key="edition" text="Edition"/> +<gentext key="equation" text="Kaava"/> +<gentext key="example" text="Esimerkki"/> +<gentext key="figure" text="Kuva"/> +<gentext key="glosssee" text="Katso"/> +<gentext key="glossseealso" text="Katso myös"/> +<gentext key="glossary" text="Sanasto"/> +<gentext key="important" text="TÄRKEÄÄ"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Tärkeää"/> +<gentext key="index" text="Indeksi"/> +<gentext key="legalnotice" text=""/> +<gentext key="msgaud" text="Yleisö"/> +<gentext key="msglevel" text="Taso"/> +<gentext key="msgorig" text="Alkuperä"/> +<gentext key="note" text="HUOMAA"/> +<gentext key="note" text="Huomaa"/> +<gentext key="part" text="Osa"/> +<gentext key="preface" text="Esipuhe"/> +<gentext key="procedure" text="Aliohjelma"/> +<gentext key="published" text="Julkaistu"/> +<gentext key="refname" text="Nimi"/> +<gentext key="reference" text="Lähdeluettelo"/> +<gentext key="revision" text="Versio"/> +<gentext key="revhistory" text="Versiohistoria"/> +<gentext key="section" text="Kohta"/> +<gentext key="see" text="Katso"/> +<gentext key="seealso" text="Katso myös"/> +<gentext key="set" text="Kokoelma"/> +<gentext key="setindex" text="Kokoelman indeksi"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="Step"/> +<gentext key="tip" text="VIHJE"/> +<gentext key="table" text="Taulu"/> +<gentext key="tip" text="Vihje"/> +<gentext key="warning" text="VAROITUS"/> +<gentext key="warning" text="Varoitus"/> +<gentext key="appendix" text="liite"/> +<gentext key="chapter" text="luku"/> +<gentext key="section" text="kohta"/> +<gentext key="sidebar" text="sivupalkki"/> +<gentext key="step" text="step"/> +<gentext key="seealso" text="Katso myös"/> + +<gentext key="TableofContents" text="Sisällys"/> +<gentext key="in" text="teoksessa"/> +<gentext key="by" text=""/> +<gentext key="Edited" text="Toim."/> +<gentext key="Editedby" text="Toimittanut"/> +<gentext key="and" text="ja"/> +<gentext key="Notes" text=""/> +<gentext key="TableNotes" text=""/> +<gentext key="nonexistantelement" text="elementtiä ei ole olemassa"/> +<gentext key="Pgs" text="Sivut"/> +<gentext key="unsupported" text="ei tueta"/> +<gentext key="xrefto" text="xref johonkin"/> +<gentext key="unexpectedelementname" text="Odottamaton elementin nimi"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Luettelo tauluista"/> +<gentext key="ListofExamples" text="Luettelo esimerkeistä"/> +<gentext key="ListofFigures" text="Luettelo kuvista"/> +<gentext key="ListofEquations" text="Luettelo esimerkeistä"/> +<gentext key="ListofUnknown" text="Luettelo tuntemattomista"/> + +<gentext key="nav-prev" text="Edellinen"/> +<gentext key="nav-prev-sibling" text="Nopeasti taaksepäin"/> +<gentext key="nav-next-sibling" text="Nopeasti eteenpäin"/> +<gentext key="nav-next" text="Seuraava"/> +<gentext key="nav-up" text="Ylös"/> +<gentext key="nav-home" text="Alkuun"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/fr.xml b/docs/docbook/xslt/db2latex/common/fr.xml new file mode 100644 index 0000000000..bf53bc57d6 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/fr.xml @@ -0,0 +1,114 @@ +<localization language="fr"> + +<gentext key="abstract" text="Résumé"/> +<gentext key="answer" text="R:"/> +<gentext key="appendix" text="annexe"/> +<gentext key="article" text="article"/> +<gentext key="bibliography" text="bibliographie"/> +<gentext key="book" text="Livre"/> +<gentext key="caution" text="Attention"/> +<gentext key="chapter" text="chapitre"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Dédicace"/> +<gentext key="edition" text="Édition"/> +<gentext key="equation" text="Équation"/> +<gentext key="example" text="Exemple"/> +<gentext key="figure" text="figure"/> +<gentext key="formalpara" text="paragraphe"/> +<gentext key="glosssee" text="Voir"/> +<gentext key="glossseealso" text="Voir aussi"/> +<gentext key="glossary" text="Glossaire"/> +<gentext key="important" text="IMPORTANT"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Important"/> +<gentext key="index" text="Index"/> +<gentext key="keyword" text="Mot Clé"/> +<gentext key="keywords" text="Mots Clés"/> +<gentext key="keywordset" text="Mots Clés"/> +<gentext key="legalnotice" text="Note légale"/> +<gentext key="msgaud" text="Public visé"/> +<gentext key="msglevel" text="Niveau"/> +<gentext key="msgorig" text="Origine"/> +<gentext key="note" text="Note"/> +<gentext key="part" text="Partie"/> +<gentext key="preface" text="Préface"/> +<gentext key="procedure" text="Procédure"/> +<gentext key="published" text="Publié"/> +<gentext key="question" text="Q:"/> +<gentext key="refentry" text=""/> +<gentext key="refname" text="Nom"/> +<gentext key="refsection" text=""/> +<gentext key="reference" text="Référence"/> +<gentext key="revhistory" text="Historique des versions"/> +<gentext key="revision" text="Version"/> +<gentext key="section" text="section"/> +<gentext key="see" text="Voir"/> +<gentext key="seealso" text="Voir Aussi"/> +<gentext key="seealso" text="Voir aussi"/> +<gentext key="set" text="Ensemble"/> +<gentext key="setindex" text="Index"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="Étape"/> +<gentext key="tip" text="TUYAU"/> +<gentext key="table" text="Tableau"/> +<gentext key="tip" text="Tuyau"/> +<gentext key="warning" text="Avertissement"/> +<gentext key="appendix" text="annexe"/> +<gentext key="chapter" text="chapitre"/> +<gentext key="sidebar" text=""/> +<gentext key="section" text="section"/> +<gentext key="sect1" text="section"/> +<gentext key="sect2" text="section"/> +<gentext key="sect3" text="section"/> +<gentext key="sect4" text="section"/> +<gentext key="sect5" text="section"/> +<gentext key="step" text="étape"/> + +<gentext key="TableofContents" text="Table des matières"/> +<gentext key="in" text="dans"/> +<gentext key="by" text="par"/> +<gentext key="Edited" text="Publié"/> +<gentext key="Editedby" text="Publié par"/> +<gentext key="and" text="et"/> +<gentext key="Notes" text="Notes"/> +<gentext key="TableNotes" text="Remarques"/> +<gentext key="nonexistantelement" text="Cet élément n'existe pas"/> +<gentext key="Pgs" text="Pages"/> +<gentext key="unsupported" text="Non reconnu par le système"/> +<gentext key="xrefto" text="Référence vers"/> +<gentext key="unexpectedelementname" text="Nom d'élément non attendu"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Liste des tableaux"/> +<gentext key="ListofExamples" text="Liste des exemples"/> +<gentext key="ListofFigures" text="Liste des illustrations"/> +<gentext key="ListofEquations" text="Liste des équations"/> +<gentext key="ListofUnknown" text="Liste des inconnues"/> + +<gentext key="nav-prev" text="Précédent"/> +<gentext key="nav-prev-sibling" text="Fast Backward"/> +<gentext key="nav-next-sibling" text="Fast Forward"/> +<gentext key="nav-next" text="Suivant"/> +<gentext key="nav-up" text="Niveau supérieur"/> +<gentext key="nav-home" text="Sommaire"/> + + + +<gentext key="mathproposition" text="proposition"/> +<gentext key="mathlemma" text="lemme"/> +<gentext key="maththeorem" text="théorème"/> +<dingbat key="startquote" text="«"/> +<dingbat key="endquote" text="»"/> +<dingbat key="nestedstartquote" text="«"/> +<dingbat key="nestedendquote" text="»"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +<xref element="appendix" text="%g %n, %t"/> +</localization> diff --git a/docs/docbook/xslt/db2latex/common/hu.xml b/docs/docbook/xslt/db2latex/common/hu.xml new file mode 100644 index 0000000000..d37e06ff8a --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/hu.xml @@ -0,0 +1,94 @@ +<localization language="hu"> + +<gentext key="abstract" text="Kivonat"/> +<gentext key="answer" text="V:"/> +<gentext key="appendix" text="Fűggelék"/> +<gentext key="article" text="Cikk"/> +<gentext key="bibliography" text="Irodalomjegyzék"/> +<gentext key="book" text="Kőnyv"/> +<gentext key="caution" text="Figyelem"/> +<gentext key="chapter" text="Fejezet"/> +<gentext key="colophon" text="Végszó"/> +<gentext key="copyright" text="Vࣩdjegy"/> +<gentext key="dedication" text="Ajánlás"/> +<gentext key="edition" text="Kiadás"/> +<gentext key="equation" text="Egyenlet"/> +<gentext key="example" text="Példa"/> +<gentext key="figure" text="Ábra"/> +<gentext key="glosssee" text="Lásd"/> +<gentext key="glossseealso" text="Lásd még"/> +<gentext key="glossary" text="Szójegyzék"/> +<gentext key="important" text="FONTOS"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Fontos"/> +<gentext key="index" text="Tárgymutató"/> +<gentext key="legalnotice" text="Jogi kőzlemény"/> +<gentext key="msgaud" text="Célkőzőnség"/> +<gentext key="msglevel" text="Szint"/> +<gentext key="msgorig" text="Eredet"/> +<gentext key="note" text="Megjegyzés"/> +<gentext key="part" text="Rész"/> +<gentext key="preface" text="Előszó"/> +<gentext key="procedure" text="Eljárás"/> +<gentext key="published" text="Megjelent"/> +<gentext key="question" text="K:"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="Referencia"/> +<gentext key="refname" text="Név"/> +<gentext key="refsection" text=""/> +<gentext key="refsynopsisdiv" text="Áttekintés"/> +<gentext key="revision" text="Verzió"/> +<gentext key="revhistory" text="Verziók tőrténete"/> +<gentext key="section" text="Szakasz"/> +<gentext key="see" text="Lásd"/> +<gentext key="seealso" text="Lásd még"/> +<gentext key="set" text="Set"/> <!-- en --> +<gentext key="setindex" text="Set Index"/> <!-- en --> +<gentext key="sidebar" text=""/> +<gentext key="step" text="Lépés"/> +<gentext key="table" text="Táblázat"/> +<gentext key="tip" text="Tipp"/> +<gentext key="warning" text="Figyelem"/> + +<gentext key="TableofContents" text="Tartalom"/> +<gentext key="in" text=""/> +<gentext key="by" text=""/> +<gentext key="Edited" text="Szerk."/> +<gentext key="Editedby" text="Szerkesztette"/> +<gentext key="and" text="és"/> +<gentext key="Notes" text="Megjegyzések"/> +<gentext key="TableNotes" text="Megjegyzések"/> +<gentext key="nonexistantelement" text="nem létezo elem"/> +<gentext key="Pgs" text="Lsz."/> +<gentext key="unsupported" text="nem támogatott"/> +<gentext key="xrefto" text="keresztref:"/> +<gentext key="unexpectedelementname" text="Nem várt elemnév"/> +<gentext key="Revisedby" text="Megvizsgálva: "/> + +<gentext key="ListofTables" text="Táblázatok listája"/> +<gentext key="ListofExamples" text="Példák listája"/> +<gentext key="ListofFigures" text="Ábrák listája"/> +<gentext key="ListofEquations" text="Egyenletek listája"/> +<gentext key="ListofUnknown" text="Egyéb elemek listája"/> + +<gentext key="nav-prev" text="Vissza"/> +<gentext key="nav-prev-sibling" text="Gyors vissza"/> +<gentext key="nav-next-sibling" text="Gyors Tovább"/> +<gentext key="nav-next" text="Tovább"/> +<gentext key="nav-up" text="Fel"/> +<gentext key="nav-home" text="Tartalom"/> + +<dingbat key="startquote" text='“'/> +<dingbat key="endquote" text='”'/> +<dingbat key="nestedstartquote" text="`"/> +<dingbat key="nestedendquote" text="'"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%n %g %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/id.xml b/docs/docbook/xslt/db2latex/common/id.xml new file mode 100644 index 0000000000..f85b02154b --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/id.xml @@ -0,0 +1,104 @@ +<localization language="id"> + +<gentext key="abstract" text="Abstrak"/> +<gentext key="answer" text="Jawab:"/> +<gentext key="appendix" text="Lampiran"/> +<gentext key="article" text="Artikel"/> +<gentext key="bibliography" text="Bibliografi"/> +<gentext key="book" text="Buku"/> +<gentext key="caution" text="PERHATIAN"/> +<gentext key="caution" text="Perhatian"/> +<gentext key="chapter" text="Bab"/> +<gentext key="colophon" text="Kolofon"/> +<gentext key="copyright" text="Hak Cipta"/> +<gentext key="dedication" text="Dedikasi"/> +<gentext key="edition" text="Edisi"/> +<gentext key="equation" text="Persamaan"/> +<gentext key="example" text="Teladan"/> +<gentext key="figure" text="Gambar"/> +<gentext key="glosssee" text="Lihat"/> +<gentext key="glossseealso" text="Lihat Juga"/> +<gentext key="glossary" text="Daftar Istilah"/> +<gentext key="important" text="PENTING"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Penting"/> +<gentext key="index" text="Indeks"/> +<gentext key="legalnotice" text="Aspek Hukum"/> +<gentext key="msgaud" text="Pemirsa"/> +<gentext key="msglevel" text="Tingkatan"/> +<gentext key="msgorig" text="Asal"/> +<gentext key="note" text="CATATAN"/> +<gentext key="note" text="Catatan"/> +<gentext key="part" text="Bagian"/> +<gentext key="preface" text="Kata Pengantar"/> +<gentext key="procedure" text="Prosedur"/> +<gentext key="published" text="Diterbitkan"/> +<gentext key="question" text="Tanya:"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="Referensi"/> +<gentext key="refname" text="Nama"/> +<gentext key="refsection" text=""/> +<gentext key="refsynopsisdiv" text="Sinopsis"/> +<gentext key="revision" text="Revisi"/> +<gentext key="revhistory" text="Catatan Revisi"/> +<gentext key="section" text="Bagian"/> +<gentext key="see" text="Lihat"/> +<gentext key="seealso" text="Lihat Juga"/> +<gentext key="set" text="Set"/> +<gentext key="setindex" text="Set Index"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="Tahap"/> +<gentext key="tip" text="TIP"/> +<gentext key="table" text="Tabel"/> +<gentext key="tip" text="Tip"/> +<gentext key="warning" text="AWAS"/> +<gentext key="warning" text="Awas"/> +<gentext key="appendix" text="lampiran"/> +<gentext key="chapter" text="bab"/> +<gentext key="section" text="bagian"/> +<gentext key="sidebar" text="sidebar"/> +<gentext key="step" text="tahap"/> +<gentext key="seealso" text="Lihat juga"/> + +<gentext key="TableofContents" text="Daftar Isi"/> +<gentext key="in" text="di"/> +<gentext key="by" text="oleh"/> +<gentext key="Edited" text="disunting"/> +<gentext key="Editedby" text="disunting oleh"/> +<gentext key="and" text="dan"/> +<gentext key="Notes" text="Catatan"/> +<gentext key="TableNotes" text="Catatan"/> +<gentext key="nonexistantelement" text="elemen tak tampak"/> +<gentext key="Pgs" text="Hal."/> +<gentext key="unsupported" text="tidak didukung"/> +<gentext key="xrefto" text="xref ke"/> +<gentext key="unexpectedelementname" text="Nama Elemen seharusnya tidak ada"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Daftar Tabel"/> +<gentext key="ListofExamples" text="Daftar Teladan"/> +<gentext key="ListofFigures" text="Daftar Gambar"/> +<gentext key="ListofEquations" text="Daftar Persamaan"/> +<gentext key="ListofUnknown" text="Daftar Gaib"/> + +<gentext key="nav-prev" text="Prev"/> +<gentext key="nav-prev-sibling" text="Fast Backward"/> +<gentext key="nav-next-sibling" text="Fast Forward"/> +<gentext key="nav-next" text="Next"/> +<gentext key="nav-up" text="Up"/> +<gentext key="nav-home" text="Home"/> + +<dingbat key="startquote" text='“'/> +<dingbat key="endquote" text='”'/> +<dingbat key="nestedstartquote" text="`"/> +<dingbat key="nestedendquote" text="'"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/it.xml b/docs/docbook/xslt/db2latex/common/it.xml new file mode 100644 index 0000000000..a7e1063ef4 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/it.xml @@ -0,0 +1,103 @@ +<localization language="it"> +<!-- updates from camille@mandrakesoft.com --> + +<gentext key="abstract" text="Estratto"/> +<gentext key="appendix" text="Appendice"/> +<gentext key="article" text="Articolo"/> +<gentext key="audience" text="Pubblico"/> +<gentext key="bibliography" text="Bibliografia"/> +<gentext key="book" text="Libro"/> +<gentext key="caution" text="CAUTELA"/> +<gentext key="caution" text="Cautela"/> +<gentext key="chapter" text="Capitolo"/> +<gentext key="colophon" text="Colophon"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Dedica"/> +<gentext key="edition" text="Edizione"/> +<gentext key="equation" text="Equazione"/> +<gentext key="example" text="Esempio"/> +<gentext key="figure" text="Figura"/> +<gentext key="glossary" text="Glossario"/> +<gentext key="glosssee" text="Vedi"/> +<gentext key="glossseealso" text="Vedi anche"/> +<gentext key="important" text="IMPORTANTE"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Importante"/> +<gentext key="index" text="Indice"/> +<gentext key="legalnotice" text="Note legali"/> +<gentext key="level" text="Livello"/> +<gentext key="note" text="NOTA"/> +<gentext key="name" text="Nome"/> +<gentext key="note" text="Nota"/> +<gentext key="origin" text="Origine"/> +<gentext key="part" text="Parte"/> +<gentext key="preface" text="Prefazione"/> +<gentext key="procedure" text="Procedura"/> +<gentext key="published" text="Pubblicato"/> +<gentext key="reference" text="Riferimento"/> +<gentext key="revision" text="Revisione"/> +<gentext key="history" text="Diario"/> +<gentext key="refsynopsisdiv" text="Sinossi"/> +<gentext key="revisionhistory" text="Diario delle revisioni"/> +<gentext key="section" text="Sezione"/> +<gentext key="see" text="Vd."/> +<gentext key="seealso" text="Vd. Anche"/> +<gentext key="seealso" text="Vd. anche"/> +<gentext key="set" text="Raccolta"/> +<gentext key="setindex" text="Indice Raccolta"/> +<gentext key="sidebar" text="Nota a margine"/> +<gentext key="step" text="Passaggio"/> +<gentext key="tip" text="SUGGERIMENTO"/> +<gentext key="table" text="Tabella"/> +<gentext key="tip" text="Suggerimento"/> +<gentext key="warning" text="ATTENZIONE"/> +<gentext key="warning" text="Attenzione"/> +<gentext key="appendix" text="appendice"/> +<gentext key="chapter" text="capitolo"/> +<gentext key="section" text="sezione"/> +<gentext key="step" text="passaggio"/> + +<gentext key="TableofContents" text="Sommario"/> +<gentext key="called" text="intitolato"/> +<gentext key="in" text="in"/> +<gentext key="by" text="di"/> +<gentext key="Edited" text="A cura"/> +<gentext key="Editedby" text="A cura di"/> +<gentext key="and" text="e"/> +<gentext key="Notes" text="Note"/> +<gentext key="TableNotes" text="Note"/> +<gentext key="nonexistantelement" text="elemento non esistente"/> +<gentext key="the" text="il"/> +<gentext key="Pgs" text="pp."/> +<gentext key="unsupported" text="non supportato"/> +<gentext key="xrefto" text="riferimento a"/> +<gentext key="unexpectedelementname" text="Nome elemento inaspettato"/> +<gentext key="Revisedby" text="Modificato da:"/> + +<gentext key="ListofTables" text="Lista delle Tabelle"/> +<gentext key="ListofExamples" text="Lista degli Esempi"/> +<gentext key="ListofFigures" text="Lista delle Figure"/> +<gentext key="ListofEquations" text="Lista delle Equazioni"/> +<gentext key="ListofUnknown" text="Lista Sconosciuti"/> + +<gentext key="nav-prev" text="Indietro"/> +<gentext key="nav-prev-sibling" text="Salta indietro"/> +<gentext key="nav-next-sibling" text="Salta avanti"/> +<gentext key="nav-next" text="Avanti"/> +<gentext key="nav-up" text="Risali"/> +<gentext key="nav-home" text="Partenza"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/ja.xml b/docs/docbook/xslt/db2latex/common/ja.xml new file mode 100644 index 0000000000..9180e8e186 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/ja.xml @@ -0,0 +1,104 @@ +<localization language="ja"> + +<!-- +;; Contributors: +;; Karl Critz, kcritz@mathworks.com, contributed the original dbl1ja.ent file +;; Ralf Schleitzer, ralf.schleitzer@ixos.de +--> + +<gentext key="abstract" text="概要"/> +<gentext key="appendix" text="付録"/> +<gentext key="article" text="項目"/> +<gentext key="bibliography" text="参考文献"/> +<gentext key="book" text="ブック"/> +<gentext key="caution" text="注意"/> +<gentext key="caution" text="注意"/> +<gentext key="chapter" text="章"/> +<gentext key="copyright" text="製作著作"/> +<gentext key="dedication" text="謝辞"/> +<gentext key="edition" text="編集"/> +<gentext key="equation" text="式"/> +<gentext key="example" text="例"/> +<gentext key="figure" text="図"/> +<gentext key="glosssee" text="参考"/> +<gentext key="glossseealso" text="参考"/> +<gentext key="glossary" text="用語集"/> +<gentext key="important" text="重要項目"/> +<gentext key="isbn" text="䥓䉎"/> +<gentext key="important" text="重要項目"/> +<gentext key="index" text="目次"/> +<gentext key="legalnotice" text=""/> +<gentext key="msgaud" text="䅵摩敮捥"/> +<gentext key="msglevel" text="レベル"/> +<gentext key="msgorig" text="オリジナル"/> +<gentext key="note" text="注意"/> +<gentext key="note" text="注意"/> +<gentext key="part" text="パート"/> +<gentext key="preface" text="序文"/> +<gentext key="procedure" text="手順"/> +<gentext key="published" text="発行"/> +<gentext key="refname" text="名前"/> +<gentext key="reference" text="参考"/> +<gentext key="revision" text="改訂"/> +<gentext key="revhistory" text="改訂履歴"/> +<gentext key="section" text="節"/> +<gentext key="see" text="参考"/> +<gentext key="seealso" text="参考"/> +<gentext key="set" text="設定"/> +<gentext key="setindex" text="目次設定"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="ステップ"/> +<gentext key="tip" text="ティップ"/> +<gentext key="table" text="表"/> +<gentext key="tip" text="ティップ"/> +<gentext key="warning" text="警告"/> +<gentext key="warning" text="警告"/> +<gentext key="appendix" text="付録"/> +<gentext key="chapter" text="章"/> +<gentext key="section" text="節"/> +<gentext key="sidebar" text="サイドバー"/> +<gentext key="step" text="ステップ"/> +<gentext key="seealso" text="参考"/> + +<gentext key="TableofContents" text="目次"/> +<gentext key="in" text="日付"/> +<gentext key="by" text="："/> +<gentext key="Edited" text="作者"/> +<gentext key="Editedby" text="26䕤楴㬠♢礻"/> +<gentext key="and" text="、"/> +<gentext key="Notes" text="注意"/> +<gentext key="TableNotes" text="注意"/> +<gentext key="nonexistantelement" text="要素が存在しません"/> +<gentext key="Pgs" text="偧献"/> +<gentext key="unsupported" text="サポートしません"/> +<gentext key="xrefto" text="78牥映瑯"/> +<gentext key="unexpectedelementname" text="不明な要素名"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="表リスト"/> +<gentext key="ListofExamples" text="例題リスト"/> +<gentext key="ListofFigures" text="Figureリスト"/> +<gentext key="ListofEquations" text="式リスト"/> +<gentext key="ListofUnknown" text="不明リスト"/> + +<gentext key="nav-prev" text="前のページ"/> +<gentext key="nav-prev-sibling" text="Fast Backward"/> +<gentext key="nav-next-sibling" text="Fast Forward"/> +<gentext key="nav-next" text="次のページ"/> +<gentext key="nav-up" text="Up"/> +<gentext key="nav-home" text="Home"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/ko.xml b/docs/docbook/xslt/db2latex/common/ko.xml new file mode 100644 index 0000000000..06dd7cb217 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/ko.xml @@ -0,0 +1,96 @@ +<localization language="ko"> + +<!-- ;; by Park Yong Joo (yongjoo@kldp.org) --> + +<gentext key="abstract" text="초록"/> +<gentext key="answer" text="답변:"/> +<gentext key="appendix" text="부록"/> +<gentext key="article" text="문서"/> +<gentext key="bibliography" text="서지사항"/> +<gentext key="book" text="책"/> +<gentext key="caution" text="경고!"/> +<gentext key="chapter" text=""/> +<gentext key="colophon" text="판권"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="바치는 글"/> +<gentext key="edition" text="개정판"/> +<gentext key="equation" text="수식"/> +<gentext key="example" text="예"/> +<gentext key="figure" text="그림"/> +<gentext key="glosssee" text="살펴볼 내용"/> +<gentext key="glossseealso" text="다른 살펴볼 내용"/> +<gentext key="glossary" text="용어해설"/> +<gentext key="important" text="[중요]"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="중요"/> +<gentext key="index" text="색인"/> +<gentext key="legalnotice" text="법적 공지"/> +<gentext key="msgaud" text="듣기"/> +<gentext key="msglevel" text="레벨"/> +<gentext key="msgorig" text="원천"/> +<gentext key="note" text="참고"/> +<gentext key="part" text="부분"/> +<gentext key="preface" text="서문"/> +<gentext key="procedure" text="순서"/> +<gentext key="published" text="출판"/> +<gentext key="question" text="답변:"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="참고문헌"/> +<gentext key="refname" text="제목"/> +<gentext key="refsection" text=""/> +<gentext key="refsynopsisdiv" text="요약"/> +<gentext key="revision" text="교정"/> +<gentext key="revhistory" text="교정 과정"/> +<gentext key="section" text=""/> +<gentext key="see" text="살펴볼 내용"/> +<gentext key="seealso" text="[살펴볼 다른 내용]"/> +<gentext key="set" text="전집"/> +<gentext key="setindex" text="전집 색인"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="단계"/> +<gentext key="table" text="표"/> +<gentext key="tip" text="작은 정보"/> +<gentext key="warning" text="주의"/> + +<gentext key="TableofContents" text="차례"/> +<gentext key="in" text="-"/> +<gentext key="by" text="글쓴이 : "/> +<gentext key="Edited" text="편집"/> +<gentext key="Editedby" text="편집 : "/> +<gentext key="and" text="그리고"/> +<gentext key="Notes" text="주석"/> +<gentext key="TableNotes" text="참고"/> +<gentext key="nonexistantelement" text="존재하지 않는 기초요소입니다"/> +<gentext key="Pgs" text="Pgs."/> +<gentext key="unsupported" text="지원되지 않습니다"/> +<gentext key="xrefto" text="이 곳을 참조하세요 : "/> +<gentext key="unexpectedelementname" text="알 수 없는 기초요소 이름입니다"/> +<gentext key="Revisedby" text="교정 : "/> + +<gentext key="ListofTables" text="표 목록"/> +<gentext key="ListofExamples" text="예 목록"/> +<gentext key="ListofFigures" text="그림 목록"/> +<gentext key="ListofEquations" text="수식 목록"/> +<gentext key="ListofUnknown" text="기타 목록"/> + +<gentext key="nav-prev" text="Prev"/> +<gentext key="nav-prev-sibling" text="Fast Backward"/> +<gentext key="nav-next-sibling" text="Fast Forward"/> +<gentext key="nav-next" text="Next"/> +<gentext key="nav-up" text="Up"/> +<gentext key="nav-home" text="Home"/> + +<dingbat key="startquote" text='“'/> +<dingbat key="endquote" text='”'/> +<dingbat key="nestedstartquote" text="`"/> +<dingbat key="nestedendquote" text="'"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/l10n.dtd b/docs/docbook/xslt/db2latex/common/l10n.dtd new file mode 100644 index 0000000000..0336baf208 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/l10n.dtd @@ -0,0 +1,25 @@ +<!ELEMENT internationalization (localization+)> + +<!ELEMENT localization (gentext|dingbat|xref)*> +<!ATTLIST localization + language CDATA #REQUIRED +> + +<!ELEMENT gentext EMPTY> +<!ATTLIST gentext + key CDATA #REQUIRED + text CDATA #REQUIRED +> + +<!ELEMENT dingbat EMPTY> +<!ATTLIST dingbat + key CDATA #REQUIRED + text CDATA #REQUIRED +> + +<!ELEMENT xref EMPTY> +<!ATTLIST xref + element CDATA #REQUIRED + text CDATA #REQUIRED +> + diff --git a/docs/docbook/xslt/db2latex/common/l10n.xml b/docs/docbook/xslt/db2latex/common/l10n.xml new file mode 100644 index 0000000000..a7ef90e905 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/l10n.xml @@ -0,0 +1,59 @@ +<?xml version='1.0'?> +<!DOCTYPE internationalization SYSTEM "l10n.dtd" [ +<!ENTITY ca SYSTEM "ca.xml"> +<!ENTITY cs SYSTEM "cs.xml"> +<!ENTITY da SYSTEM "da.xml"> +<!ENTITY de SYSTEM "de.xml"> +<!ENTITY el SYSTEM "el.xml"> +<!ENTITY en SYSTEM "en.xml"> +<!ENTITY es SYSTEM "es.xml"> +<!ENTITY et SYSTEM "et.xml"> +<!ENTITY fi SYSTEM "fi.xml"> +<!ENTITY fr SYSTEM "fr.xml"> +<!ENTITY hu SYSTEM "hu.xml"> +<!ENTITY id SYSTEM "id.xml"> +<!ENTITY it SYSTEM "it.xml"> +<!ENTITY ja SYSTEM "ja.xml"> +<!ENTITY ko SYSTEM "ko.xml"> +<!ENTITY nl SYSTEM "nl.xml"> +<!ENTITY no SYSTEM "no.xml"> +<!ENTITY pl SYSTEM "pl.xml"> +<!ENTITY pt SYSTEM "pt.xml"> +<!ENTITY pt_br SYSTEM "pt_br.xml"> +<!ENTITY ro SYSTEM "ro.xml"> +<!ENTITY ru SYSTEM "ru.xml"> +<!ENTITY sk SYSTEM "sk.xml"> +<!ENTITY sl SYSTEM "sl.xml"> +<!ENTITY sv SYSTEM "sv.xml"> +<!ENTITY zh_cn SYSTEM "zh_cn.xml"> +<!ENTITY zh_tw SYSTEM "zh_tw.xml"> +]> +<internationalization> +&ca; +&cs; +&da; +&de; +⪙ +&en; +&es; +&et; +&fi; +&fr; +&hu; +&id; +⁢ +&ja; +&ko; +&nl; +&no; +&pl; +&pt; +&pt_br; +&ro; +&ru; +&sk; +&sl; +&sv; +&zh_cn; +&zh_tw; +</internationalization> diff --git a/docs/docbook/xslt/db2latex/common/l10n.xsl b/docs/docbook/xslt/db2latex/common/l10n.xsl new file mode 100644 index 0000000000..df07f4efe8 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/l10n.xsl @@ -0,0 +1,249 @@ +<?xml version='1.0'?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version='1.0'> + +<!-- ******************************************************************** + $Id: l10n.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + ******************************************************************** + + Derived from the official XSL DocBook Stylesheet distribution. + See http://nwalsh.com/docbook/xsl/ for copyright and other information. + + This file contains localization templates (for internationalization) + ******************************************************************** --> + + + + +<xsl:param name="l10n.xml" select="document('../common/l10n.xml')"/> +<xsl:param name="l10n.gentext.language" select="''"/> +<xsl:param name="l10n.gentext.default.language" select="'en'"/> +<xsl:param name="l10n.gentext.use.xref.language" select="false()"/> + + + + + +<xsl:template name="l10n.language"> + <xsl:param name="target" select="."/> + <xsl:param name="xref-context" select="false()"/> + + <xsl:variable name="language"> + <xsl:choose> + <xsl:when test="$l10n.gentext.language != ''"> + <xsl:value-of select="$l10n.gentext.language"/> + </xsl:when> + + <xsl:when test="$xref-context or $l10n.gentext.use.xref.language"> + <xsl:variable name="lang-attr" + select="($target/ancestor-or-self::*/@lang + |$target/ancestor-or-self::*/@xml:lang)[last()]"/> + <xsl:choose> + <xsl:when test="string($lang-attr) = ''"> + <xsl:value-of select="$l10n.gentext.default.language"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$lang-attr"/> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + + <xsl:otherwise> + <xsl:variable name="lang-attr" + select="(ancestor-or-self::*/@lang + |ancestor-or-self::*/@xml:lang)[last()]"/> + <xsl:choose> + <xsl:when test="string($lang-attr) = ''"> + <xsl:value-of select="$l10n.gentext.default.language"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$lang-attr"/> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:choose> + <xsl:when test="contains($language,'-')"> + <xsl:value-of select="substring-before($language,'-')"/> + <xsl:text>_</xsl:text> + <xsl:value-of select="substring-after($language,'-')"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$language"/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template name="gentext.xref.text"> + <xsl:param name="element.name" select="name(.)"/> + <xsl:param name="default"></xsl:param> + <xsl:param name="lang"> + <xsl:call-template name="l10n.language"/> + </xsl:param> + + <xsl:variable name="l10n.text"> + <xsl:value-of select="($l10n.xml/internationalization/localization[@language=$lang]/xref[@element=$element.name])[1]/@text"/> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$l10n.text=''"> + <xsl:choose> + <xsl:when test="$default=''"> + <xsl:message> + <xsl:text>No "</xsl:text> + <xsl:value-of select="$lang"/> + <xsl:text>" cross reference text for "</xsl:text> + <xsl:value-of select="$element.name"/> + <xsl:text>" exists and no default specified.</xsl:text> + </xsl:message> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$default"/> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$l10n.text"/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template name="gentext"> + <xsl:param name="key" select="local-name(.)"/> + <xsl:param name="lang"> + <xsl:call-template name="l10n.language"/> + </xsl:param> + + <xsl:variable name="l10n.gentext" + select="($l10n.xml/internationalization/localization[@language=$lang]/gentext[@key=$key])[1]"/> + + <xsl:variable name="l10n.name"> + <xsl:value-of select="$l10n.gentext/@text"/> + </xsl:variable> + + <xsl:choose> + <xsl:when test="count($l10n.gentext)=0"> + <xsl:message> + <xsl:text>No "</xsl:text> + <xsl:value-of select="$lang"/> + <xsl:text>" localization of "</xsl:text> + <xsl:value-of select="$key"/> + <xsl:text>" exists; using "en".</xsl:text> + </xsl:message> + + <xsl:value-of select="($l10n.xml/internationalization/localization[@language='en']/gentext[@key=$key])[1]/@text"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$l10n.name"/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template name="gentext.element.name"> + <xsl:param name="element.name" select="name(.)"/> + <xsl:param name="lang"> + <xsl:call-template name="l10n.language"/> + </xsl:param> + + <xsl:call-template name="gentext"> + <xsl:with-param name="key" select="$element.name"/> + <xsl:with-param name="lang" select="$lang"/> + </xsl:call-template> +</xsl:template> + +<xsl:template name="gentext.space"> + <xsl:text> </xsl:text> +</xsl:template> + +<xsl:template name="gentext.edited.by"> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name">Editedby</xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template name="gentext.by"> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name">by</xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template name="gentext.dingbat"> + <xsl:param name="dingbat">bullet</xsl:param> + <xsl:param name="lang"> + <xsl:call-template name="l10n.language"/> + </xsl:param> + + <xsl:variable name="l10n.dingbat"> + <xsl:value-of select="($l10n.xml/internationalization/localization[@language=$lang]/dingbat[@key=$dingbat])[1]/@text"/> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$l10n.dingbat=''"> + <xsl:message> + <xsl:text>No "</xsl:text> + <xsl:value-of select="$lang"/> + <xsl:text>" localization of dingbat </xsl:text> + <xsl:value-of select="$dingbat"/> + <xsl:text> exists; using "en".</xsl:text> + </xsl:message> + + <xsl:value-of select="($l10n.xml/internationalization/localization[@language='en']/dingbat[@key=$dingbat])[1]/@text"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$l10n.dingbat"/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template name="gentext.startquote"> + <xsl:call-template name="gentext.dingbat"> + <xsl:with-param name="dingbat">startquote</xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template name="gentext.endquote"> + <xsl:call-template name="gentext.dingbat"> + <xsl:with-param name="dingbat">endquote</xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template name="gentext.nestedstartquote"> + <xsl:call-template name="gentext.dingbat"> + <xsl:with-param name="dingbat">nestedstartquote</xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template name="gentext.nestedendquote"> + <xsl:call-template name="gentext.dingbat"> + <xsl:with-param name="dingbat">nestedendquote</xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template name="gentext.nav.prev"> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name">nav-prev</xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template name="gentext.nav.next"> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name">nav-next</xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template name="gentext.nav.home"> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name">nav-home</xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template name="gentext.nav.up"> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name">nav-up</xsl:with-param> + </xsl:call-template> +</xsl:template> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/common/nl.xml b/docs/docbook/xslt/db2latex/common/nl.xml new file mode 100644 index 0000000000..56ead54d30 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/nl.xml @@ -0,0 +1,105 @@ +<localization language="nl"> + +<!-- Updated by Frederik Fouvry, fouvry@essex.ac.uk --> +<!-- Vincent Partington, vincent.partington@graddelt.com --> +<!-- Updated by Erwin Bolwidt, ejb@tryllian.com, august 2000 --> + +<gentext key="abstract" text="Overzicht"/> +<gentext key="answer" text="A:"/> +<gentext key="appendix" text="Aanhangsel"/> +<gentext key="article" text="Artikel"/> +<gentext key="bibliography" text="Bibliografie"/> +<gentext key="book" text="Boek"/> +<gentext key="caution" text="Waarschuwing"/> +<gentext key="chapter" text="Hoofdstuk"/> +<gentext key="colophon" text="Colofon"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Opdracht"/> +<gentext key="edition" text="Uitgave"/> +<gentext key="equation" text="Vergelijking"/> +<gentext key="example" text="Voorbeeld"/> +<gentext key="figure" text="Figuur"/> +<gentext key="glossary" text="Woordenlijst"/> +<gentext key="glosssee" text="Zie"/> +<gentext key="glossseealso" text="Zie ook"/> +<gentext key="important" text="Belangrijk"/> +<gentext key="index" text="Index"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="legalnotice" text="Juridische mededeling"/> +<gentext key="msgaud" text="Doelgroep"/> +<gentext key="msglevel" text="Ernst"/> +<gentext key="msgorig" text="Afkomst"/> +<gentext key="note" text="N.B."/> +<gentext key="part" text="Deel"/> +<gentext key="preface" text="Inleiding"/> +<gentext key="procedure" text="Procedure"/> +<gentext key="published" text="Gepubliceerd"/> +<gentext key="pubdate" text="Gepubliceerd"/> +<gentext key="question" text="V:"/> +<gentext key="refentry" text="Referentielemma"/> +<gentext key="reference" text="Referentie"/> +<gentext key="refname" text="Referentienaam"/> +<gentext key="refsection" text="Referentieparagraaf"/> +<gentext key="refsynopsisdiv" text="Samenvatting"/> +<gentext key="revhistory" text="Revisie verloop"/> +<gentext key="revision" text="Revisie"/> +<gentext key="section" text="Sectie"/> +<gentext key="sect1" text="Sectie"/> +<gentext key="sect2" text="Sectie"/> +<gentext key="sect3" text="Sectie"/> +<gentext key="sect4" text="Sectie"/> +<gentext key="sect5" text="Sectie"/> +<gentext key="see" text="Zie"/> +<gentext key="seealso" text="Zie ook"/> +<gentext key="set" text="Verzameling"/> +<gentext key="setindex" text="Hoofdindex"/> +<gentext key="sidebar" text="Excursie"/> +<gentext key="step" text="Stap"/> +<gentext key="table" text="Tabel"/> +<gentext key="tip" text="Tip"/> +<gentext key="warning" text="Waarschuwing"/> + +<gentext key="TableofContents" text="Inhoudsopgave"/> +<gentext key="in" text="in"/> +<gentext key="by" text="door"/> +<gentext key="Edited" text="Redactie"/> +<gentext key="Editedby" text="Redactie door"/> +<gentext key="and" text="en"/> +<gentext key="Notes" text="Opmerkingen"/> +<gentext key="TableNotes" text="Opmerkingen"/> +<gentext key="nonexistantelement" text="niet-bestaand element"/> +<gentext key="Pgs" text="blz."/> +<gentext key="unsupported" text="niet ondersteund"/> +<gentext key="xrefto" text="verwijzing naar"/> +<gentext key="unexpectedelementname" text="Onverwachte naam van element"/> +<gentext key="Revisedby" text="Herzien door:"/> + +<gentext key="ListofTables" text="Lijst van Tabellen"/> +<gentext key="ListofExamples" text="Lijst van Voorbeelden"/> +<gentext key="ListofFigures" text="Lijst van Figuren"/> +<gentext key="ListofEquations" text="Lijst van Vergelijkingen"/> +<gentext key="ListofUnknown" text="Lijst van Onbekends"/> + +<gentext key="nav-prev" text="Vorige"/> +<gentext key="nav-prev-sibling" text="Snel terug"/> +<gentext key="nav-next-sibling" text="Snel vooruit"/> +<gentext key="nav-next" text="Volgende"/> +<gentext key="nav-up" text="Omhoog"/> +<gentext key="nav-home" text="Begin"/> + +<gentext key="the section called" text="de sectie genaamd"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="preface" text="%t"/> +<xref element="bibliography" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/no.xml b/docs/docbook/xslt/db2latex/common/no.xml new file mode 100644 index 0000000000..b3aba44fde --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/no.xml @@ -0,0 +1,97 @@ +<localization language="no"> + +<gentext key="abstract" text="Abstract"/> +<gentext key="appendix" text="Tillegg"/> +<gentext key="article" text=""/> +<gentext key="bibliography" text="Bibliografi"/> +<gentext key="book" text=""/> +<gentext key="caution" text="OBS"/> +<gentext key="caution" text="Obs"/> +<gentext key="chapter" text="Kapittel"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Dedikasjon"/> +<gentext key="edition" text=""/> +<gentext key="equation" text="Formel"/> +<gentext key="example" text="Eksempel"/> +<gentext key="figure" text="Figur"/> +<gentext key="glosssee" text="Se"/> +<gentext key="glossseealso" text="Se Også"/> +<gentext key="glossary" text="Ordliste"/> +<gentext key="important" text="VIKTIG"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Viktig"/> +<gentext key="index" text="Indeks"/> +<gentext key="legalnotice" text=""/> +<gentext key="msgaud" text="Publikum"/> +<gentext key="msglevel" text="Nivå"/> +<gentext key="msgorig" text="Opphav"/> +<gentext key="note" text="NOTAT"/> +<gentext key="note" text="Notat"/> +<gentext key="part" text="Del"/> +<gentext key="preface" text="Forord"/> +<gentext key="procedure" text="Prosedyre"/> +<gentext key="published" text=""/> +<gentext key="refname" text="Navn"/> +<gentext key="reference" text="Referanse"/> +<gentext key="revision" text="Revisjon"/> +<gentext key="revhistory" text="Revisjonshistorie"/> +<gentext key="section" text="Seksjon"/> +<gentext key="see" text="Se"/> +<gentext key="seealso" text="Se Også"/> +<gentext key="set" text=""/> +<gentext key="setindex" text="Indeks"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="Steg"/> +<gentext key="tip" text="TIPS"/> +<gentext key="table" text="Tabell"/> +<gentext key="tip" text="Tips"/> +<gentext key="warning" text="ADVARSEL"/> +<gentext key="warning" text="Advarsel"/> +<gentext key="appendix" text="Tillegg"/> +<gentext key="chapter" text="Kapittel"/> +<gentext key="section" text="seksjon"/> +<gentext key="step" text="steg"/> +<gentext key="seealso" text="Se også"/> + +<gentext key="TableofContents" text="Innholdsfortegnelse"/> +<gentext key="in" text="i"/> +<gentext key="by" text="av"/> +<gentext key="Edited" text="Redigert"/> +<gentext key="Editedby" text="Redigert av"/> +<gentext key="and" text="og"/> +<gentext key="Notes" text="Sluttnotater"/> +<gentext key="TableNotes" text="Notater"/> +<gentext key="nonexistantelement" text="ikke-eksisterende element"/> +<gentext key="Pgs" text="Sdr."/> +<gentext key="unsupported" text="ikke st⊘ttet"/> +<gentext key="xrefto" text="xref til"/> +<gentext key="unexpectedelementname" text="UVENTET-ELEMENTNAVN"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Tabelloversikt"/> +<gentext key="ListofExamples" text="Eksempeloversikt"/> +<gentext key="ListofFigures" text="Figuroversikt"/> +<gentext key="ListofEquations" text="Formeloversikt"/> +<gentext key="ListofUnknown" text="???-oversikt"/> + +<gentext key="nav-prev" text="Forrige"/> +<gentext key="nav-prev-sibling" text="Raskt Bakover"/> +<gentext key="nav-next-sibling" text="Raskt Fremover"/> +<gentext key="nav-next" text="Neste"/> +<gentext key="nav-up" text="Opp"/> +<gentext key="nav-home" text="Hjem"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/pl.xml b/docs/docbook/xslt/db2latex/common/pl.xml new file mode 100644 index 0000000000..8582bbebe8 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/pl.xml @@ -0,0 +1,96 @@ +<localization language="pl"> + +<gentext key="abstract" text="Abstrakt"/> +<gentext key="appendix" text="Dodatek"/> +<gentext key="article" text="Article"/> +<gentext key="bibliography" text="Bibliografia"/> +<gentext key="book" text="Book"/> +<gentext key="caution" text="PRZYPADEK"/> +<gentext key="caution" text="Przypadek"/> +<gentext key="chapter" text="Rozdzia³"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Dedykacja"/> +<gentext key="edition" text="Wydanie"/> +<gentext key="equation" text="Równanie"/> +<gentext key="example" text="Przyk³ad"/> +<gentext key="figure" text="Rysunek"/> +<gentext key="glosssee" text="Patrz"/> +<gentext key="glossseealso" text="Patrz te¿"/> +<gentext key="glossary" text="Glossary"/> +<gentext key="important" text="WA¯NE"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="WA¯NE"/> +<gentext key="index" text="Indeks"/> +<gentext key="legalnotice" text=""/> +<gentext key="msgaud" text="Odbiorcy"/> +<gentext key="msglevel" text="Poziom"/> +<gentext key="msgorig" text="Nadawca"/> +<gentext key="note" text="NOTATKA"/> +<gentext key="note" text="Notatka"/> +<gentext key="part" text="Czê¶æ"/> +<gentext key="preface" text="Przedmowa"/> +<gentext key="procedure" text="Procedura"/> +<gentext key="published" text="Data wydania"/> +<gentext key="refname" text="Nazwa"/> +<gentext key="reference" text="Materia³y ¼ród³owe"/> +<gentext key="revision" text="Zmiana"/> +<gentext key="revhistory" text="Historia zmian"/> +<gentext key="section" text="Sekcja"/> +<gentext key="see" text="Patrz"/> +<gentext key="seealso" text="Patrz Te¿"/> +<gentext key="set" text="Set"/> +<gentext key="setindex" text="Indeks"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="krok"/> +<gentext key="tip" text="Podpowied¼"/> +<gentext key="table" text="Tabela"/> +<gentext key="tip" text="Podpowied¼"/> +<gentext key="warning" text="Ostrze¿enie"/> +<gentext key="warning" text="Ostrze¿enie"/> +<gentext key="appendix" text="dodatek"/> +<gentext key="chapter" text="rozdzia³"/> +<gentext key="section" text="sekcja"/> +<gentext key="step" text="krok"/> +<gentext key="seealso" text="Patrz te¿"/> + +<gentext key="TableofContents" text="Spis tre¶ci"/> +<gentext key="in" text="w"/> +<gentext key="by" text=""/> +<gentext key="Editedby" text="Redakcja: "/> +<gentext key="and" text="i"/> +<gentext key="Notes" text="Przypisy"/> +<gentext key="TableNotes" text="Przypisy"/> +<gentext key="nonexistantelement" text="nie istniej±cy element"/> +<gentext key="Pgs" text="stron"/> +<gentext key="unsupported" text="nie wspierany"/> +<gentext key="xrefto" text="xref to"/> +<gentext key="unexpectedelementname" text="Unexpected element name"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Spis tabel"/> +<gentext key="ListofExamples" text="Spis przyk³adów"/> +<gentext key="ListofFigures" text="Spis rysunków"/> +<gentext key="ListofEquations" text="Spis równañ"/> +<gentext key="ListofUnknown" text="Spis ???"/> + +<gentext key="nav-prev" text="Poprzedni"/> +<gentext key="nav-prev-sibling" text="Poprzedni rozdzia³"/> +<gentext key="nav-next-sibling" text="Nastêpny rozdzia³"/> +<gentext key="nav-next" text="Nastêpny"/> +<gentext key="nav-up" text="Pocz±tek rozdzia³u"/> +<gentext key="nav-home" text="Spis tre¶ci"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/pt.xml b/docs/docbook/xslt/db2latex/common/pt.xml new file mode 100644 index 0000000000..af0c22f4b4 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/pt.xml @@ -0,0 +1,98 @@ +<localization language="pt"> + +<gentext key="abstract" text="Resumo"/> +<gentext key="appendix" text="Apêndice"/> +<gentext key="article" text="Article"/> +<gentext key="bibliography" text="Bibliografia"/> +<gentext key="book" text="Book"/> +<gentext key="caution" text="CAUTELA"/> +<gentext key="caution" text="Cautela"/> +<gentext key="chapter" text="Capítulo"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Dedicatória"/> +<gentext key="edition" text="Edição"/> +<gentext key="equation" text="Equação"/> +<gentext key="example" text="Exemplo"/> +<gentext key="figure" text="Figura"/> +<gentext key="glosssee" text="Ver"/> +<gentext key="glossseealso" text="Ver Também"/> +<gentext key="glossary" text="Glossario"/> +<gentext key="important" text="IMPORTANTE"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Importante"/> +<gentext key="index" text="Index"/> +<gentext key="legalnotice" text=""/> +<gentext key="msgaud" text="Audiência"/> +<gentext key="msglevel" text="Nível"/> +<gentext key="msgorig" text="Origem"/> +<gentext key="note" text="NOTA"/> +<gentext key="note" text="Nota"/> +<gentext key="part" text="Parte"/> +<gentext key="preface" text="Prefácio"/> +<gentext key="procedure" text="Procedimento"/> +<gentext key="pubdate" text="Editado"/> +<gentext key="published" text="Published"/> +<gentext key="refname" text="Nome"/> +<gentext key="reference" text="Referência"/> +<gentext key="revision" text="Revisão"/> +<gentext key="revhistory" text="Hitorial de Revisões"/> +<gentext key="section" text="Secção"/> +<gentext key="see" text="Ver"/> +<gentext key="seealso" text="Ver Também"/> +<gentext key="set" text="Set"/> +<gentext key="setindex" text="Set Index"/> +<gentext key="sidebar" text="Sidebar"/> +<gentext key="step" text="Passo"/> +<gentext key="tip" text="DICA"/> +<gentext key="table" text="Tabela"/> +<gentext key="tip" text="Dica"/> +<gentext key="warning" text="ATENÇÃO"/> +<gentext key="warning" text="Atenção"/> +<gentext key="appendix" text="apêndice"/> +<gentext key="chapter" text="capítulo"/> +<gentext key="section" text="secção"/> +<gentext key="step" text="passo"/> +<gentext key="seealso" text="ver também"/> + +<gentext key="TableofContents" text="Índice"/> +<gentext key="in" text=""/> +<gentext key="by" text="por"/> +<gentext key="Edited" text="Editado"/> +<gentext key="Editedby" text="Editado por"/> +<gentext key="and" text="e"/> +<gentext key="Notes" text="Notas"/> +<gentext key="TableNotes" text="Notas"/> +<gentext key="nonexistantelement" text="non-existant element"/> +<gentext key="Pgs" text="Páginas"/> +<gentext key="unsupported" text="unsupported"/> +<gentext key="xrefto" text="xref to"/> +<gentext key="unexpectedelementname" text="Unexpected element name"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Lista de Tabelas"/> +<gentext key="ListofExamples" text="Lista de Exemplos"/> +<gentext key="ListofFigures" text="Lista de Figuras"/> +<gentext key="ListofEquations" text="Lista de Equações"/> +<gentext key="ListofUnknown" text="List of ???"/> + +<gentext key="nav-prev" text="Prev"/> +<gentext key="nav-prev-sibling" text="Fast Backward"/> +<gentext key="nav-next-sibling" text="Fast Forward"/> +<gentext key="nav-next" text="Next"/> +<gentext key="nav-up" text="Up"/> +<gentext key="nav-home" text="Home"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/pt_br.xml b/docs/docbook/xslt/db2latex/common/pt_br.xml new file mode 100644 index 0000000000..cf63d1ebf2 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/pt_br.xml @@ -0,0 +1,98 @@ +<localization language="pt_br"> + +<gentext key="abstract" text="Resumo"/> +<gentext key="appendix" text="Apêndice"/> +<gentext key="article" text="Artigo"/> +<gentext key="bibliography" text="Bibliografia"/> +<gentext key="book" text="Livro"/> +<gentext key="caution" text="CUIDADO"/> +<gentext key="caution" text="Cuidado"/> +<gentext key="chapter" text="Capítulo"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Dedicatória"/> +<gentext key="edition" text="Edição"/> +<gentext key="equation" text="Equação"/> +<gentext key="example" text="Exemplo"/> +<gentext key="figure" text="Figura"/> +<gentext key="glosssee" text="Ver"/> +<gentext key="glossseealso" text="Ver Também"/> +<gentext key="glossary" text="Glossário"/> +<gentext key="important" text="IMPORTANTE"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Importante"/> +<gentext key="index" text="Índice Remissivo"/> +<gentext key="legalnotice" text="Nota Legal"/> +<gentext key="msgaud" text="Audiência"/> +<gentext key="msglevel" text="Nível"/> +<gentext key="msgorig" text="Origem"/> +<gentext key="note" text="NOTA"/> +<gentext key="note" text="Nota"/> +<gentext key="part" text="Parte"/> +<gentext key="preface" text="Prefácio"/> +<gentext key="procedure" text="Procedimento"/> +<gentext key="pubdate" text="Data de Publicação"/> +<gentext key="published" text="Publicado"/> +<gentext key="refname" text="Nome"/> +<gentext key="reference" text="Referência"/> +<gentext key="revision" text="Revisão"/> +<gentext key="revhistory" text="Histórico de Revisões"/> +<gentext key="section" text="Secção"/> +<gentext key="see" text="Ver"/> +<gentext key="seealso" text="Ver Também"/> +<gentext key="set" text="Conjunto"/> +<gentext key="setindex" text="Índice do Conjunto"/> +<gentext key="sidebar" text="Quadro Lateral"/> +<gentext key="step" text="Passo"/> +<gentext key="tip" text="DICA"/> +<gentext key="table" text="Tabela"/> +<gentext key="tip" text="Dica"/> +<gentext key="warning" text="ATENÇÃO"/> +<gentext key="warning" text="Atenção"/> +<gentext key="appendix" text="apêndice"/> +<gentext key="chapter" text="capítulo"/> +<gentext key="section" text="secção"/> +<gentext key="step" text="passo"/> +<gentext key="seealso" text="ver também"/> + +<gentext key="TableofContents" text="Índice"/> +<gentext key="in" text=""/> +<gentext key="by" text="por"/> +<gentext key="Edited" text="Editado"/> +<gentext key="Editedby" text="Editado por"/> +<gentext key="Revisedby" text="Revised by: "/> <!-- en --> +<gentext key="and" text="e"/> +<gentext key="Notes" text="Notas"/> +<gentext key="TableNotes" text="Notas"/> +<gentext key="nonexistantelement" text="elemento inexistente"/> +<gentext key="Pgs" text="Páginas"/> +<gentext key="unsupported" text="não suportado"/> +<gentext key="xrefto" text="referência para"/> +<gentext key="unexpectedelementname" text="Nome de elemento inesperado"/> + +<gentext key="ListofTables" text="Lista de Tabelas"/> +<gentext key="ListofExamples" text="Lista de Exemplos"/> +<gentext key="ListofFigures" text="Lista de Figuras"/> +<gentext key="ListofEquations" text="Lista de Equações"/> +<gentext key="ListofUnknown" text="Lista de ???"/> + +<gentext key="nav-prev" text="Anterior"/> +<gentext key="nav-prev-sibling" text="Início"/> +<gentext key="nav-next-sibling" text="Fim"/> +<gentext key="nav-next" text="Próxima"/> +<gentext key="nav-up" text="Acima"/> +<gentext key="nav-home" text="Principal"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/ro.xml b/docs/docbook/xslt/db2latex/common/ro.xml new file mode 100644 index 0000000000..a59ffd8217 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/ro.xml @@ -0,0 +1,104 @@ +<localization language="ro"> + +<gentext key="abstract" text="Rezumat"/> +<gentext key="appendix" text="Anexa"/> +<gentext key="article" text="Articol"/> +<gentext key="bibliography" text="Bibliografie"/> +<gentext key="book" text="Carte"/> +<gentext key="caution" text="ATENÞIE"/> +<gentext key="caution" text="Atenþie"/> +<gentext key="chapter" text="Cap."/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Dedicaþie"/> +<gentext key="edition" text="Ediþie"/> +<gentext key="equation" text="ecuaþia"/> +<gentext key="example" text="Exemplu"/> +<gentext key="figure" text="Fig."/> +<gentext key="glossary" text="Glosar"/> +<gentext key="glosssee" text="Vezi"/> +<gentext key="glossseealso" text="Vezi şi"/> +<gentext key="important" text="IMPORTANT"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Important"/> +<gentext key="index" text="Index"/> +<gentext key="legalnotice" text=""/> +<gentext key="msgaud" text=""/> +<gentext key="msglevel" text="Nivel"/> +<gentext key="msgorig" text="Origine"/> +<gentext key="note" text="NOTÃ"/> +<gentext key="note" text="Notã"/> +<gentext key="refname" text="Nume"/> +<gentext key="note" text="Notã"/> +<gentext key="part" text="Parte"/> +<gentext key="preface" text="Prefaþã"/> +<gentext key="procedure" text="Procedurã"/> +<gentext key="published" text="Publicat"/> +<gentext key="reference" text="Referinþã"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="Referinþã"/> +<gentext key="refname" text="Name"/> +<gentext key="refsection" text=""/> +<gentext key="refsynopsisdiv" text="Rezumat"/> +<gentext key="revision" text="Versiune"/> +<gentext key="revhistory" text="Istoricul versiunilor"/> +<gentext key="section" text="Secþiune"/> +<gentext key="see" text="Vezi"/> +<gentext key="seealso" text="Vezi şi"/> +<gentext key="set" text="Set"/> +<gentext key="setindex" text="Index"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="Operaþie"/> +<gentext key="tip" text="INDICAÞIE"/> +<gentext key="table" text="Tabel"/> +<gentext key="tip" text="Indicaþie"/> +<gentext key="warning" text="AVERTISMENT"/> +<gentext key="warning" text="Avertisment"/> +<gentext key="appendix" text="anexa"/> +<gentext key="sidebar" text="sidebar"/> +<gentext key="chapter" text="cap."/> +<gentext key="section" text="sec."/> +<gentext key="step" text="operaþiune"/> +<gentext key="seealso" text="Vezi şi"/> + +<gentext key="TableofContents" text="Cuprins"/> +<gentext key="in" text="în"/> +<gentext key="by" text="de"/> +<gentext key="Edited" text="Publicat"/> +<gentext key="Editedby" text="Publicat de"/> +<gentext key="and" text="şi"/> +<gentext key="Notes" text="Note"/> +<gentext key="TableNotes" text="Remarci"/> +<gentext key="nonexistantelement" text="element inexistent"/> +<gentext key="Pgs" text="Pagini"/> +<gentext key="unsupported" text="nerecunoscut de sisitem"/> +<gentext key="xrefto" text="referinþã cãtre"/> +<gentext key="unexpectedelementname" text="Nume de element neaşteptat"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Listã de tabele"/> +<gentext key="ListofExamples" text="Listã de exemple"/> +<gentext key="ListofFigures" text="Listã de figuri"/> +<gentext key="ListofEquations" text="Listã de ecuaþii"/> +<gentext key="ListofUnknown" text="Listã de necunoscute"/> + +<gentext key="nav-prev" text="Prev"/> +<gentext key="nav-prev-sibling" text="Fast Backward"/> +<gentext key="nav-next-sibling" text="Fast Forward"/> +<gentext key="nav-next" text="Next"/> +<gentext key="nav-up" text="Up"/> +<gentext key="nav-home" text="Home"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/ru.xml b/docs/docbook/xslt/db2latex/common/ru.xml new file mode 100644 index 0000000000..a097cd419b --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/ru.xml @@ -0,0 +1,113 @@ +<localization language="ru"> + +<gentext key="abstract" text="Аннотация"/> +<gentext key="appendix" text="Приложение"/> +<gentext key="appendix.abr" text="Прил."/> +<gentext key="article" text="Статья"/> +<gentext key="audience" text="Аудитория"/> +<gentext key="bibliography" text="Литература"/> +<gentext key="book" text="Книга"/> +<gentext key="caution" text="ПРЕДОСТЕРЕЖЕНИЕ"/> +<gentext key="caution" text="Предостережение"/> +<gentext key="chapter" text="Глава"/> +<gentext key="chapter.abr" text="Гл."/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Посвящение"/> +<gentext key="edition" text="Редакция"/> +<gentext key="equation" text="Формула"/> +<gentext key="equation.abr" text="Ф."/> +<gentext key="example" text="Пример"/> +<gentext key="example.abr" text="Прим."/> +<gentext key="figure" text="Рисунок"/> +<gentext key="figure.abr" text="Рис."/> +<gentext key="glossary" text="Глоссарий"/> +<gentext key="important" text="ВАЖНО"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Важно"/> +<gentext key="index" text="Предметный указатель"/> +<gentext key="legalnotice" text="Авторские права"/> +<gentext key="level" text="Уровень"/> +<gentext key="note" text="ЗАМЕЧАНИЕ"/> +<gentext key="name" text="Имя"/> +<gentext key="note" text="Замечание"/> +<gentext key="origin" text="Источник"/> +<gentext key="part" text="Часть"/> +<gentext key="part.abr" text="Ч."/> +<gentext key="preface" text="Предисловие"/> +<gentext key="procedure" text="Процедура"/> +<gentext key="procedure.abr" text="Проц."/> +<gentext key="published" text="Опубликовано"/> +<gentext key="reference" text="Ссылка"/> +<gentext key="revision" text="Издание"/> +<gentext key="history" text="История"/> +<gentext key="revisionhistory" text="История переиздания"/> +<gentext key="section" text="Раздел"/> +<gentext key="section.abr" text="Разд."/> +<gentext key="see" text="См."/> +<gentext key="seealso" text="См. также"/> +<gentext key="seealso" text="См. также"/> +<gentext key="set" text="Подборка"/> +<gentext key="setindex" text="Индекс подборки"/> +<gentext key="sidebar" text="Выделение"/> +<gentext key="step" text="Шаг"/> +<gentext key="tip" text="ПОДСКАЗКА"/> +<gentext key="table" text="Таблица"/> +<gentext key="table.abr" text="Табл."/> +<gentext key="tip" text="Подсказка"/> +<gentext key="warning" text="ВНИМАНИЕ"/> +<gentext key="warning" text="Внимание"/> +<gentext key="appendix" text="приложение"/> +<gentext key="chapter" text="глава"/> +<gentext key="section" text="раздел"/> +<gentext key="step" text="шаг"/> + +<gentext key="TableofContents" text="Содержание"/> +<gentext key="called" text=""/> +<gentext key="in" text="в"/> +<gentext key="by" text=""/> +<gentext key="Edited" text="Под редакцией"/> +<gentext key="Editedby" text="Под редакцией"/> +<gentext key="and" text=""/> +<!-- the list of author names, but "and" in such + lists of Russian books is not traditionally + used (I. Kouznetsov) --> +<gentext key="Notes" text="Примечания"/> +<gentext key="TableNotes" text="Примечания"/> + +<!-- Suggestion of I. Kouznetsov: Error messages are better in English --> + +<gentext key="nonexistantelement" text="non-existant element"/> +<gentext key="the" text=""/> +<gentext key="Pgs" text="Стр."/> +<gentext key="unsupported" text="unsupported"/> +<gentext key="xrefto" text="xref to"/> +<gentext key="unexpectedelementname" text="unexpected element name"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Список таблиц"/> +<gentext key="ListofExamples" text="Список примеров"/> +<gentext key="ListofFigures" text="Список иллюстраций"/> +<gentext key="ListofEquations" text="Список формул"/> +<gentext key="ListofUnknown" text="Неопределенный список"/> + +<gentext key="nav-prev" text="Пред."/> +<gentext key="nav-prev-sibling" text="Пред. Подраздел"/> +<gentext key="nav-next-sibling" text="След. Подраздел"/> +<gentext key="nav-next" text="След."/> +<gentext key="nav-up" text="Уровень выше"/> +<gentext key="nav-home" text="начало"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/sk.xml b/docs/docbook/xslt/db2latex/common/sk.xml new file mode 100644 index 0000000000..0c2fbc85fb --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/sk.xml @@ -0,0 +1,104 @@ +<localization language="sk"> + +<gentext key="abstract" text="Obsah"/> +<gentext key="answer" text="A:"/> +<gentext key="appendix" text="Dodatok"/> +<gentext key="article" text="Článok"/> +<gentext key="bibliography" text="Bibliografia"/> +<gentext key="book" text="Kniha"/> +<gentext key="caution" text="VÝSTRAHA"/> +<gentext key="caution" text="Výstraha"/> +<gentext key="chapter" text="Kapitola"/> +<gentext key="colophon" text="Tiráž"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Venovanie"/> +<gentext key="edition" text="Vydanie"/> +<gentext key="equation" text="Rovnice"/> +<gentext key="example" text="Príklad"/> +<gentext key="figure" text="Obrázok"/> +<gentext key="glosssee" text="Pozri"/> +<gentext key="glossseealso" text="Pozri tiež"/> +<gentext key="glossary" text="Slovník"/> +<gentext key="important" text="DÔLEŽITÉ"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Dôležité"/> +<gentext key="index" text="Zoznam"/> +<gentext key="legalnotice" text="Právna poznámka"/> +<gentext key="msgaud" text="Publikum"/> +<gentext key="msglevel" text="Úroveň"/> +<gentext key="msgorig" text="Pôvod"/> +<gentext key="note" text="POZNÁMKA"/> +<gentext key="note" text="Poznámka"/> +<gentext key="part" text="Časť"/> +<gentext key="preface" text="Úvod"/> +<gentext key="procedure" text="Postup"/> +<gentext key="published" text="Vydané"/> +<gentext key="question" text="Q:"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="Odkaz"/> +<gentext key="refname" text="Meno"/> +<gentext key="refsection" text=""/> +<gentext key="refsynopsisdiv" text="Prehľad"/> +<gentext key="revision" text="Revízia"/> +<gentext key="revhistory" text="Prehľad revízií"/> +<gentext key="section" text="Oddiel"/> +<gentext key="see" text="Pozri"/> +<gentext key="seealso" text="Pozri tiež"/> +<gentext key="set" text="Nastaviť"/> +<gentext key="setindex" text="Nastaviť index"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="Krok"/> +<gentext key="tip" text="TIP"/> +<gentext key="table" text="Tabuľka"/> +<gentext key="tip" text="Tip"/> +<gentext key="warning" text="VAROVANIE"/> +<gentext key="warning" text="Varovanie"/> +<gentext key="appendix" text="dodatok"/> +<gentext key="chapter" text="kapitola"/> +<gentext key="section" text="oddiel"/> +<gentext key="sidebar" text="boční lišta"/> +<gentext key="step" text="krok"/> +<gentext key="seealso" text="Pozri tiež"/> + +<gentext key="TableofContents" text="Obsah"/> +<gentext key="in" text="v"/> +<gentext key="by" text=""/> +<gentext key="Edited" text="Vydané"/> +<gentext key="Editedby" text="Vydané"/> +<gentext key="and" text="a"/> +<gentext key="Notes" text="Poznámky"/> +<gentext key="TableNotes" text="Poznámky"/> +<gentext key="nonexistantelement" text="neexistujúci prvok"/> +<gentext key="Pgs" text="Str."/> +<gentext key="unsupported" text="nepodporovaný"/> +<gentext key="xrefto" text="xref k"/> +<gentext key="unexpectedelementname" text="Neočakávané meno prvku"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Zoznam tabuliek"/> +<gentext key="ListofExamples" text="Zoznam príkladov"/> +<gentext key="ListofFigures" text="Zoznam obrázkov"/> +<gentext key="ListofEquations" text="Zoznam rovníc"/> +<gentext key="ListofUnknown" text="Zoznam neznámeho"/> + +<gentext key="nav-prev" text="Predchádzajúci"/> +<gentext key="nav-prev-sibling" text="Rýchlo nazpät"/> +<gentext key="nav-next-sibling" text="Rýchlo dopredu"/> +<gentext key="nav-next" text="Ďalší"/> +<gentext key="nav-up" text="Hore"/> +<gentext key="nav-home" text="Domov"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/sl.xml b/docs/docbook/xslt/db2latex/common/sl.xml new file mode 100644 index 0000000000..fca0f5e348 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/sl.xml @@ -0,0 +1,104 @@ +<localization language="sl"> + +<gentext key="abstract" text="Povzetek"/> +<gentext key="answer" text="O:"/> +<gentext key="appendix" text="Dodatek"/> +<gentext key="article" text="Članek"/> +<gentext key="bibliography" text="Literatura"/> +<gentext key="book" text="Knjiga"/> +<gentext key="caution" text="OPOZORILO"/> +<gentext key="caution" text="Opozorilo"/> +<gentext key="chapter" text="Poglavje"/> +<gentext key="colophon" text="Kolofon"/> +<gentext key="copyright" text="Pravna zaščita"/> +<gentext key="dedication" text="Posvetilo"/> +<gentext key="edition" text="Izdaja"/> +<gentext key="equation" text="Enačba"/> +<gentext key="example" text="Primer"/> +<gentext key="figure" text="Slika"/> +<gentext key="glosssee" text="glej"/> +<gentext key="glossseealso" text="glej tudi"/> +<gentext key="glossary" text="Slovarček"/> +<gentext key="important" text="POMEMBNO"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Pomembno"/> +<gentext key="index" text="Stvarno kazalo"/> +<gentext key="legalnotice" text="Pravno sporočilo"/> +<gentext key="msgaud" text="Občinstvo"/> +<gentext key="msglevel" text="Raven"/> +<gentext key="msgorig" text="Izvor"/> +<gentext key="note" text="OPOMBA"/> +<gentext key="note" text="Opomba"/> +<gentext key="part" text="Del"/> +<gentext key="preface" text="Predgovor"/> +<gentext key="procedure" text="Postopek"/> +<gentext key="published" text="Izdano"/> +<gentext key="question" text="V:"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="Sklic"/> +<gentext key="refname" text="Ime"/> +<gentext key="refsection" text=""/> +<gentext key="refsynopsisdiv" text="Sinopsis"/> +<gentext key="revision" text="Različica"/> +<gentext key="revhistory" text="Zgodovina različic"/> +<gentext key="section" text="Razdelek"/> +<gentext key="see" text="glej"/> +<gentext key="seealso" text="glej tudi"/> +<gentext key="set" text="Postavi"/> <!-- ? --> +<gentext key="setindex" text="Postavi stvarno kazalo"/> <!-- ? --> +<gentext key="sidebar" text=""/> +<gentext key="step" text="Korak"/> +<gentext key="tip" text="NAMIG"/> +<gentext key="table" text="Tabela"/> +<gentext key="tip" text="Namig"/> +<gentext key="warning" text="POZOR"/> +<gentext key="warning" text="Pozor"/> +<gentext key="appendix" text="dodatek"/> +<gentext key="chapter" text="poglavje"/> +<gentext key="section" text="razdelek"/> +<gentext key="sidebar" text="sidebar"/> <!-- ? --> +<gentext key="step" text="korak"/> +<gentext key="seealso" text="Glej tudi"/> + +<gentext key="TableofContents" text="Kazalo"/> +<gentext key="in" text="v"/> +<gentext key="by" text="od"/> <!-- ? --> +<gentext key="Edited" text="Urejeno"/> <!-- ? --> +<gentext key="Editedby" text="Urejeno od"/> <!-- ? --> +<gentext key="and" text="in"/> +<gentext key="Notes" text="Notes"/> <!-- ? --> +<gentext key="TableNotes" text="Notes"/> <!-- ? --> +<gentext key="nonexistantelement" text="neobstoječi element"/> +<gentext key="Pgs" text="Str."/> +<gentext key="unsupported" text="nepodprto"/> +<gentext key="xrefto" text="xref na"/> <!-- ? --> +<gentext key="unexpectedelementname" text="Nepričakovano ime elementa"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Seznam tabel"/> +<gentext key="ListofExamples" text="Seznam primerov"/> +<gentext key="ListofFigures" text="Seznam slik"/> +<gentext key="ListofEquations" text="Seznam enačb"/> +<gentext key="ListofUnknown" text="Seznam neznanih stvari"/> <!-- ? --> + +<gentext key="nav-prev" text="Nazaj"/> +<gentext key="nav-prev-sibling" text="Hitro nazaj"/> +<gentext key="nav-next-sibling" text="Hitro naprej"/> +<gentext key="nav-next" text="Naprej"/> +<gentext key="nav-up" text="Gor"/> +<gentext key="nav-home" text="Domov"/> + +<dingbat key="startquote" text='“'/> +<dingbat key="endquote" text='”'/> +<dingbat key="nestedstartquote" text="`"/> +<dingbat key="nestedendquote" text="'"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/sv.xml b/docs/docbook/xslt/db2latex/common/sv.xml new file mode 100644 index 0000000000..27b45cce15 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/sv.xml @@ -0,0 +1,99 @@ +<localization language="sv"> + +<gentext key="abstract" text="Abstrakt"/> +<gentext key="appendix" text="Appendix"/> +<gentext key="article" text="Artikel"/> +<gentext key="bibliography" text="Bibliografi"/> +<gentext key="book" text="Bok"/> +<gentext key="caution" text="OBSERVERA"/> +<gentext key="caution" text="Observera"/> +<gentext key="chapter" text="Kapitel"/> +<gentext key="copyright" text="Copyright"/> +<gentext key="dedication" text="Dedikation"/> +<gentext key="edition" text="Edition"/> +<gentext key="equation" text="Ekvation"/> +<gentext key="example" text="Exempel"/> +<gentext key="figure" text="Figur"/> +<gentext key="glosssee" text="Se"/> +<gentext key="glossseealso" text="Se Även"/> +<gentext key="glossary" text="Gloslista"/> +<gentext key="important" text="VIKTIGT"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="important" text="Viktigt"/> +<gentext key="index" text="Index"/> +<gentext key="legalnotice" text="Legal Notice"/> +<gentext key="msgaud" text="Målgrupp"/> +<gentext key="msglevel" text="Nivå"/> +<gentext key="msgorig" text="Ursprung"/> +<gentext key="note" text="NOT"/> +<gentext key="note" text="Not"/> +<gentext key="part" text="Del"/> +<gentext key="preface" text="Företal"/> +<gentext key="procedure" text="Procedur"/> +<gentext key="published" text="Publicerad"/> +<gentext key="refname" text="Namn"/> +<gentext key="reference" text="Referens"/> +<gentext key="revision" text="Revision"/> +<gentext key="revhistory" text="Revisions Historik;"/> +<gentext key="section" text="Sektion"/> +<gentext key="see" text="Se"/> +<gentext key="seealso" text="Se Även"/> +<gentext key="set" text="Set"/> +<gentext key="setindex" text="Set Index"/> +<gentext key="sidebar" text="Sidebar"/> +<gentext key="step" text="Steg"/> +<gentext key="tip" text="TIPS"/> +<gentext key="table" text="Tabell"/> +<gentext key="tip" text="Tips"/> +<gentext key="warning" text="VARNING"/> +<gentext key="warning" text="Varning"/> +<gentext key="appendix" text="appendix"/> +<gentext key="chapter" text="kapitel"/> +<gentext key="section" text="sektion"/> +<gentext key="step" text="steg"/> +<gentext key="seealso" text="Se även"/> + +<gentext key="TableofContents" text="Innehållsförteckning"/> +<gentext key="called" text="kallas"/> +<gentext key="in" text="i"/> +<gentext key="by" text="av"/> +<gentext key="Edited" text="Utgiven"/> +<gentext key="Editedby" text="Utgiven av"/> +<gentext key="and" text="och"/> +<gentext key="Notes" text="Noter"/> +<gentext key="TableNotes" text="Noter"/> +<gentext key="nonexistantelement" text="non-existant element"/> +<gentext key="the" text=""/> +<gentext key="Pgs" text="Sid."/> +<gentext key="unsupported" text="unsupported"/> +<gentext key="xrefto" text="xref till"/> +<gentext key="unexpectedelementname" text="Unexpected element name"/> +<gentext key="Revisedby" text="Revised by: "/> + +<gentext key="ListofTables" text="Tabellförteckning"/> +<gentext key="ListofExamples" text="Exempelförteckning"/> +<gentext key="ListofFigures" text="Figurförteckning"/> +<gentext key="ListofEquations" text="Ekvationsförteckning"/> +<gentext key="ListofUnknown" text="Förteckning av okända"/> + +<gentext key="nav-prev" text="Förutgående"/> +<gentext key="nav-prev-sibling" text="Snabbt frammåt"/> +<gentext key="nav-next-sibling" text="Snabbt bakåt"/> +<gentext key="nav-next" text="Nästa"/> +<gentext key="nav-up" text="Upp"/> +<gentext key="nav-home" text="Hem"/> + +<dingbat key="startquote" text="“"/> +<dingbat key="endquote" text="”"/> +<dingbat key="nestedstartquote" text="‘"/> +<dingbat key="nestedendquote" text="’"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="bibliography" text="%t"/> +<xref element="chapter" text="%g %n, %t"/> +<xref element="dedication" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> +<xref element="preface" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/zh_cn.xml b/docs/docbook/xslt/db2latex/common/zh_cn.xml new file mode 100644 index 0000000000..ef373b4a33 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/zh_cn.xml @@ -0,0 +1,95 @@ +<localization language="zh_cn"> + +<gentext key="abstract" text="摘要"/> +<gentext key="answer" text="答:"/> +<gentext key="appendix" text="附录"/> +<gentext key="article" text="文章"/> +<gentext key="bibliography" text="参考书目"/> +<gentext key="book" text="书目"/> +<gentext key="caution" text="注意"/> +<gentext key="chapter" text="章"/> +<gentext key="colophon" text="Colophon"/> +<gentext key="copyright" text="版权"/> +<gentext key="dedication" text="奉献"/> +<gentext key="edition" text="版"/> +<gentext key="equation" text="方程"/> +<gentext key="example" text="例子"/> +<gentext key="figure" text="图形"/> +<gentext key="glossary" text="术语表"/> +<gentext key="glosssee" text="见"/> +<gentext key="glossseealso" text="另见"/> +<gentext key="important" text="重要"/> +<gentext key="index" text="索引"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="legalnotice" text="法律布告"/> +<gentext key="msgaud" text="读者"/> +<gentext key="msglevel" text="难度"/> +<gentext key="msgorig" text="出处"/> +<gentext key="note" text="注"/> +<gentext key="part" text="部分"/> +<gentext key="preface" text="前言"/> +<gentext key="procedure" text="过程"/> +<gentext key="published" text="出版"/> +<gentext key="question" text="问:"/> +<gentext key="refentry" text=""/> +<gentext key="reference" text="参考"/> +<gentext key="refname" text="名字"/> +<gentext key="refsection" text=""/> +<gentext key="refsynopsisdiv" text="大纲"/> +<gentext key="revhistory" text="修订历史"/> +<gentext key="revision" text="修订"/> +<gentext key="section" text="节"/> +<gentext key="see" text="见"/> +<gentext key="seealso" text="另见"/> +<gentext key="set" text="Set"/> +<gentext key="setindex" text="Set Index"/> +<gentext key="sidebar" text="sidebar"/> +<gentext key="step" text="步骤"/> +<gentext key="table" text="表格"/> +<gentext key="tip" text="提示"/> +<gentext key="tip" text="提示"/> +<gentext key="warning" text="警告"/> + +<gentext key="TableofContents" text="目录"/> +<gentext key="in" text="在"/> +<gentext key="by" text="由"/> +<gentext key="Edited" text="编辑"/> +<gentext key="Editedby" text="编辑"/> +<gentext key="and" text="和"/> +<gentext key="Notes" text="注"/> +<gentext key="TableNotes" text="注"/> +<gentext key="nonexistantelement" text="不存在的元素"/> +<gentext key="Pgs" text="页"/> +<gentext key="unsupported" text="不支持"/> +<gentext key="xrefto" text="参照"/> +<gentext key="unexpectedelementname" text="未预料到的元素名"/> +<gentext key="Revisedby" text="修订"/> + +<gentext key="ListofTables" text="表格列表"/> +<gentext key="ListofExamples" text="示例列表"/> +<gentext key="ListofFigures" text="图形列表"/> +<gentext key="ListofEquations" text="方程式列表"/> +<gentext key="ListofUnknown" text="其他内容列表"/> + +<gentext key="nav-prev" text="后退"/> +<gentext key="nav-prev-sibling" text="快速后退"/> +<gentext key="nav-next-sibling" text="快速前进"/> +<gentext key="nav-next" text="前进"/> +<gentext key="nav-up" text="上一级"/> +<gentext key="nav-home" text="起点"/> + +<dingbat key="startquote" text='"'/> +<dingbat key="endquote" text='"'/> +<dingbat key="nestedstartquote" text="'"/> +<dingbat key="nestedendquote" text="'"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="appendix" text="%g %n"/> +<xref element="chapter" text="%g %n"/> +<xref element="dedication" text="%t"/> +<xref element="preface" text="%t"/> +<xref element="bibliography" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/common/zh_tw.xml b/docs/docbook/xslt/db2latex/common/zh_tw.xml new file mode 100644 index 0000000000..7168114f49 --- /dev/null +++ b/docs/docbook/xslt/db2latex/common/zh_tw.xml @@ -0,0 +1,98 @@ +<localization language="zh_tw"> + +<gentext key="abstract" text="摘要"/> +<gentext key="answer" text="答："/> +<gentext key="appendix" text="附錄"/> +<gentext key="article" text="文章"/> +<gentext key="bibliography" text="參考文獻"/> +<gentext key="book" text="書目"/> +<gentext key="caution" text="注意"/> +<gentext key="chapter" text="章"/> +<gentext key="colophon" text="版本記錄"/> +<gentext key="copyright" text="版權"/> +<gentext key="dedication" text="奉獻"/> +<gentext key="edition" text="版"/> +<gentext key="equation" text="方程式"/> +<gentext key="example" text="範例"/> +<gentext key="figure" text="圖形"/> +<gentext key="glossary" text="小辭彙"/> +<gentext key="glosssee" text="參見"/> +<gentext key="glossseealso" text="另參見"/> +<gentext key="important" text="重要"/> +<gentext key="index" text="索引"/> +<gentext key="isbn" text="ISBN"/> +<gentext key="legalnotice" text="法律聲明"/> +<gentext key="msgaud" text="讀者"/> +<gentext key="msglevel" text="程度"/> +<gentext key="msgorig" text="出處"/> +<gentext key="note" text="注"/> +<gentext key="part" text="部"/> +<gentext key="preface" text="序言"/> +<gentext key="procedure" text="過程"/> +<gentext key="published" text="出版"/> +<gentext key="question" text="問："/> +<gentext key="refentry" text="參照項目"/> +<gentext key="reference" text="參考"/> +<gentext key="refname" text="參考名"/> +<gentext key="refsection" text="參照章節"/> +<gentext key="refsynopsisdiv" text="大綱"/> +<gentext key="revhistory" text="修訂記錄"/> +<gentext key="revision" text="修訂"/> +<gentext key="section" text="節"/> +<gentext key="see" text="見"/> +<gentext key="seealso" text="另見"/> +<gentext key="set" text="Set"/> +<gentext key="setindex" text="Set Index"/> +<gentext key="sidebar" text=""/> +<gentext key="step" text="步驟"/> +<gentext key="table" text="表格"/> +<gentext key="tip" text="提示"/> +<gentext key="tip" text="提示"/> +<gentext key="warning" text="警告"/> + +<gentext key="TableofContents" + text="內容目錄"/> +<gentext key="in" text="在"/> +<gentext key="by" text="由"/> +<gentext key="Edited" text="編輯"/> +<gentext key="Editedby" text="編輯"/> +<gentext key="and" text="且"/> +<gentext key="Notes" text="注"/> +<gentext key="TableNotes" text="注釋"/> +<gentext key="nonexistantelement" + text="不存在的元素"/> +<gentext key="Pgs" text="頁"/> +<gentext key="unsupported" text="未支援"/> +<gentext key="xrefto" text="參照"/> +<gentext key="unexpectedelementname" + text="非預期的元素名"/> +<gentext key="Revisedby" text="修訂"/> + +<gentext key="ListofTables" text="附表目錄"/> +<gentext key="ListofExamples" text="範例目錄"/> +<gentext key="ListofFigures" text="附圖目錄"/> +<gentext key="ListofEquations" text="公式目錄"/> +<gentext key="ListofUnknown" text="其它內容目錄"/> + +<gentext key="nav-prev" text="前一頁"/> +<gentext key="nav-prev-sibling" text="快速向前"/> +<gentext key="nav-next-sibling" text="快速向後"/> +<gentext key="nav-next" text="下一頁"/> +<gentext key="nav-up" text="上一層"/> +<gentext key="nav-home" text="內容"/> + +<dingbat key="startquote" text="""/> +<dingbat key="endquote" text="""/> +<dingbat key="nestedstartquote" text="'"/> +<dingbat key="nestedendquote" text="'"/> +<dingbat key="bullet" text="ߦ"/> + +<xref element="appendix" text="%g %n"/> +<xref element="chapter" text="%g %n"/> +<xref element="dedication" text="%t"/> +<xref element="preface" text="%t"/> +<xref element="bibliography" text="%t"/> +<xref element="glossary" text="%t"/> +<xref element="index" text="%t"/> + +</localization> diff --git a/docs/docbook/xslt/db2latex/component.mod.xsl b/docs/docbook/xslt/db2latex/component.mod.xsl new file mode 100644 index 0000000000..2197c94674 --- /dev/null +++ b/docs/docbook/xslt/db2latex/component.mod.xsl @@ -0,0 +1,94 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: component.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="component" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: component.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Component <filename>component.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <xsl:template name="component.title"> + <xsl:variable name="id"> + <xsl:call-template name="label.id"><xsl:with-param name="object" select="."/></xsl:call-template> + </xsl:variable> + <xsl:text> {\sc </xsl:text><xsl:apply-templates select="." mode="title.ref"/><xsl:text>}</xsl:text> + </xsl:template> + + + + <xsl:template name="component.subtitle"> + <xsl:variable name="subtitle"><xsl:apply-templates select="." mode="subtitle.content"/></xsl:variable> + <xsl:if test="$subtitle != ''"> + <xsl:text> {\sc </xsl:text><xsl:copy-of select="$subtitle"/><xsl:text>}</xsl:text> + </xsl:if> + </xsl:template> + + + + <xsl:template name="component.separator"> + </xsl:template> + + + + <xsl:template match="colophon"> + <xsl:variable name="id"><xsl:call-template name="label.id"/></xsl:variable> + <xsl:call-template name="component.separator"/> + <xsl:call-template name="component.title"/> + <xsl:call-template name="component.subtitle"/> + <xsl:apply-templates/> + </xsl:template> + + + <xsl:template match="colophon/title"/> + + + + <xsl:template match="bibliography" mode="component.number"> + <xsl:param name="add.space" select="false()"/> + </xsl:template> + + <xsl:template match="glossary" mode="component.number"> + <xsl:param name="add.space" select="false()"/> + </xsl:template> + + <xsl:template match="index" mode="component.number"> + <xsl:param name="add.space" select="false()"/> + </xsl:template> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/dedication.mod.xsl b/docs/docbook/xslt/db2latex/dedication.mod.xsl new file mode 100644 index 0000000000..67012391f8 --- /dev/null +++ b/docs/docbook/xslt/db2latex/dedication.mod.xsl @@ -0,0 +1,129 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: dedication.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="dedication" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: dedication.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Dedication <filename>dedication.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + +<!--############################################################################# + | XSL Parameters + +- ############################################################################# --> +<xsl:param name="latex.dedication.title.style">\sc</xsl:param> + + + +<!--############################################################################# + | Dedication Template + +- ############################################################################# --> +<xsl:template match="dedication"> +<xsl:text>\newpage </xsl:text> +<xsl:text>% ------------------------------------------------------------- </xsl:text> +<xsl:text>% Dedication </xsl:text> +<xsl:text>% ------------------------------------------------------------- </xsl:text> +<xsl:call-template name="label.id"/> +<xsl:call-template name="dedication.title"/> +<xsl:call-template name="dedication.subtitle"/> +<!-- except title, titleabbrev and subtitle --> +<xsl:apply-templates select="*[name(.) != 'title' and name(.) != 'subtitle' and name(.) != 'titleabbrev']"/> +</xsl:template> + + +<!--############################################################################# + | Dedication Title + +- ############################################################################# --> +<xsl:template name="dedication.title"> +<!-- Output dedication title or generic text --> +<xsl:text>{</xsl:text> +<xsl:value-of select="$latex.dedication.title.style"/> +<xsl:text> </xsl:text> +<xsl:choose> + <xsl:when test="title"> + <xsl:apply-templates select="title"/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="gentext"> + <xsl:with-param name="key">dedication</xsl:with-param> + </xsl:call-template> + </xsl:otherwise> +</xsl:choose> +<xsl:text>} </xsl:text> +<!-- done with title --> +</xsl:template> + + +<xsl:template match="dedication/title"> +<xsl:apply-templates/> +</xsl:template> + + + +<!--############################################################################# + | Dedication Subtitle + +- ############################################################################# --> +<xsl:template name="dedication.subtitle"> +<xsl:variable name="subtitle"> + <xsl:apply-templates select="." mode="subtitle.content"/> +</xsl:variable> +<xsl:if test="$subtitle != ''"> + <xsl:text>{</xsl:text> + <xsl:value-of select="$latex.dedication.title.style"/> + <xsl:text> </xsl:text> + <xsl:copy-of select="$subtitle"/> + <xsl:text>} </xsl:text> +</xsl:if> +</xsl:template> + + +<xsl:template match="dedication/subtitle"> +<xsl:apply-templates/> +</xsl:template> + +<xsl:template match="dedication/titleabbrev"/> + + +<!--############################################################################# + | Special treatment for dedication paragraphs + +- ############################################################################# --> +<xsl:template match="dedication/para"> +<xsl:text> \paragraph*{} </xsl:text> <!-- This is a fixme !! --> +<xsl:apply-templates/> +</xsl:template> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/dingbat.mod.xsl b/docs/docbook/xslt/db2latex/dingbat.mod.xsl new file mode 100644 index 0000000000..86b2f25b30 --- /dev/null +++ b/docs/docbook/xslt/db2latex/dingbat.mod.xsl @@ -0,0 +1,72 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: dingbat.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: +| ++ ############################################################################## --> + + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="dingbat" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: dingbat.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year><year>2001</year><year>2002</year><year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>Dingbats <filename>dingbat.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + </section> + </partintro> + </doc:reference> + + + + <xsl:template name="dingbat"> + <xsl:param name="dingbat">bullet</xsl:param> + <xsl:call-template name="dingbat.characters"> + <xsl:with-param name="dingbat" select="$dingbat"/> + </xsl:call-template> + </xsl:template> + + <xsl:template name="dingbat.characters"> + <xsl:param name="dingbat">bullet</xsl:param> + <xsl:choose> + <xsl:when test="$dingbat='bullet'"> $\bullet$ </xsl:when> + <xsl:when test="$dingbat='copyright'">\copyright{}</xsl:when> + <xsl:when test="$dingbat='trademark'">\texttrademark{}</xsl:when> + <xsl:when test="$dingbat='registered'">\textregistered{}</xsl:when> + <xsl:when test="$dingbat='nbsp'">~</xsl:when> + <xsl:when test="$dingbat='ldquo'">``</xsl:when> + <xsl:when test="$dingbat='rdquo'">''</xsl:when> + <xsl:when test="$dingbat='lsquo'">`</xsl:when> + <xsl:when test="$dingbat='rsquo'">'</xsl:when> + <xsl:when test="$dingbat='em-dash'">---</xsl:when> + <xsl:when test="$dingbat='mdash'">---</xsl:when> + <xsl:when test="$dingbat='en-dash'">--</xsl:when> + <xsl:when test="$dingbat='ndash'">--</xsl:when> + <xsl:otherwise> + <xsl:text> [dingbat?] </xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/docbook.xsl b/docs/docbook/xslt/db2latex/docbook.xsl new file mode 100644 index 0000000000..3a8759d57d --- /dev/null +++ b/docs/docbook/xslt/db2latex/docbook.xsl @@ -0,0 +1,154 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: docbook.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: +| This is the "parent" stylesheet. The used "modules" are included here. +| output encoding text in ISO-8859-1 indented. ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + <xsl:output method="text" encoding="ISO-8859-1" indent="yes"/> + + <xsl:include href="common/l10n.xsl"/> + <xsl:include href="common/common.xsl"/> + + <xsl:include href="VERSION.xml"/> + <xsl:include href="vars.mod.xsl"/> + <xsl:include href="latex.mapping.xsl"/> + <xsl:include href="preamble.mod.xsl"/> + <xsl:include href="font.mod.xsl"/> + <xsl:include href="labelid.mod.xsl"/> + + <xsl:include href="book-article.mod.xsl"/> + + <xsl:include href="dedication.mod.xsl"/> + <xsl:include href="preface.mod.xsl"/> + + <xsl:include href="part-chap-app.mod.xsl"/> + + <xsl:include href="sections.mod.xsl"/> + <xsl:include href="bridgehead.mod.xsl"/> + + <xsl:include href="abstract.mod.xsl"/> + <xsl:include href="biblio.mod.xsl"/> + <xsl:include href="revision.mod.xsl"/> + + <xsl:include href="admonition.mod.xsl"/> + <xsl:include href="verbatim.mod.xsl"/> + <xsl:include href="email.mod.xsl"/> + <xsl:include href="sgmltag.mod.xsl"/> + <xsl:include href="citation.mod.xsl"/> + <xsl:include href="qandaset.mod.xsl"/> + <xsl:include href="procedure.mod.xsl"/> + <xsl:include href="lists.mod.xsl"/> + <xsl:include href="callout.mod.xsl"/> + + + <xsl:include href="figure.mod.xsl"/> + <xsl:include href="graphic.mod.xsl"/> + <xsl:include href="mediaobject.mod.xsl"/> + + <xsl:include href="index.mod.xsl"/> + + + <xsl:include href="xref.mod.xsl"/> + <xsl:include href="formal.mod.xsl"/> + <xsl:include href="example.mod.xsl"/> + <xsl:include href="table.mod.xsl"/> + <xsl:include href="inline.mod.xsl"/> + <xsl:include href="authorgroup.mod.xsl"/> + <xsl:include href="dingbat.mod.xsl"/> + <xsl:include href="info.mod.xsl"/> + <xsl:include href="keywords.mod.xsl"/> + <xsl:include href="refentry.mod.xsl"/> + <xsl:include href="component.mod.xsl"/> + <xsl:include href="glossary.mod.xsl"/> + <xsl:include href="block.mod.xsl"/> + + + <xsl:include href="synop-oop.mod.xsl"/> + <xsl:include href="synop-struct.mod.xsl"/> + + <xsl:include href="pi.mod.xsl"/> + + <xsl:include href="footnote.mod.xsl"/> + + <xsl:include href="texmath.mod.xsl"/> + <xsl:include href="mathelem.mod.xsl"/> + <xsl:include href="mathml/mathml.mod.xsl"/> + <xsl:include href="mathml/mathml.presentation.mod.xsl"/> + <xsl:include href="mathml/mathml.content.mod.xsl"/> + <xsl:include href="mathml/mathml.content.token.mod.xsl"/> + <xsl:include href="mathml/mathml.content.functions.mod.xsl"/> + <xsl:include href="mathml/mathml.content.constsymb.mod.xsl"/> + + <xsl:include href="para.mod.xsl"/> + <xsl:include href="msgset.mod.xsl"/> + <xsl:include href="errors.mod.xsl"/> + + <xsl:include href="normalize-scape.mod.xsl"/> + + + + <xsl:template match="/"> + <xsl:variable name="xsl-vendor" select="system-property('xsl:vendor')"/> + <xsl:message>################################################################################</xsl:message> + <xsl:message> XSLT stylesheets DocBook - LaTeX 2e </xsl:message> + <xsl:message> Reqs: LaTeX 2e installation common packages </xsl:message> + <xsl:message>################################################################################</xsl:message> + <xsl:message> RELEASE : <xsl:value-of select="$VERSION"/> </xsl:message> + <xsl:message> VERSION : <xsl:value-of select="$CVSVERSION"/> </xsl:message> + <xsl:message> TAG : <xsl:value-of select="$TAG"/> </xsl:message> + <xsl:message> WWW : http://db2latex.sourceforge.net </xsl:message> + <xsl:message> SUMMARY : http://www.sourceforge.net/projects/db2latex </xsl:message> + <xsl:message> AUTHOR : Ramon Casellas casellas@infres.enst.fr </xsl:message> + <xsl:message> AUTHOR : James Devenish j-devenish@users.sf.net </xsl:message> + <xsl:message> USING : <xsl:call-template name="set-vendor"/> </xsl:message> + <xsl:message>################################################################################</xsl:message> + <xsl:apply-templates/> + </xsl:template> + + + <!--############################################################################# --> + <!-- XSL Processor Vendor --> + <!-- XSL Mailing Lists http://www.dpawson.co.uk/xsl/N10378.html --> + <!--############################################################################# --> + <xsl:template name="set-vendor"> + <xsl:variable name="xsl-vendor" select="system-property('xsl:vendor')"/> + <xsl:choose> + <xsl:when test="contains($xsl-vendor, 'SAXON 6.4')"> + <xsl:text>SAXON 6.4.X</xsl:text> + </xsl:when> + <xsl:when test="contains($xsl-vendor, 'SAXON 6.2')"> + <xsl:text>SAXON 6.2.X</xsl:text> + </xsl:when> + <xsl:when test="starts-with($xsl-vendor,'SAXON')"> + <xsl:text>SAXON</xsl:text> + </xsl:when> + <xsl:when test="contains($xsl-vendor,'Apache')"> + <xsl:text>XALAN</xsl:text> + </xsl:when> + <xsl:when test="contains($xsl-vendor,'Xalan')"> + <xsl:text>XALAN</xsl:text> + </xsl:when> + <xsl:when test="contains($xsl-vendor,'libxslt')"> + <xsl:text>libxslt/xsltproc</xsl:text> + </xsl:when> + <xsl:when test="contains($xsl-vendor,'Clark')"> + <xsl:text>XT</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>UNKNOWN</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/email.mod.xsl b/docs/docbook/xslt/db2latex/email.mod.xsl new file mode 100644 index 0000000000..fad6b59551 --- /dev/null +++ b/docs/docbook/xslt/db2latex/email.mod.xsl @@ -0,0 +1,65 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: email.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="email" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: email.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Email <filename>email.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + <!--############################################################################# --> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="email" xmlns=""> + <refpurpose> XSL template for email </refpurpose> + <refdescription> + <para>Outputs the mail in {\texttt }. Calls the normalize-scape template in order to get a + normalized email string. It does not process email content model.</para> + <formalpara><title>Remarks and Bugs</title> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + + <xsl:template match="email"> + <xsl:text>\texttt{<</xsl:text> + <xsl:call-template name="ulink"> + <xsl:with-param name="url" select="concat('mailto:',.)"/> + </xsl:call-template> + <xsl:text>>}</xsl:text> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/errors.mod.xsl b/docs/docbook/xslt/db2latex/errors.mod.xsl new file mode 100644 index 0000000000..466f052c7f --- /dev/null +++ b/docs/docbook/xslt/db2latex/errors.mod.xsl @@ -0,0 +1,18 @@ +<?xml version='1.0'?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version='1.0'> + <!--############################################################################# + | $Id: errors.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: + + ############################################################################## --> + + + <xsl:template match="*"> + <xsl:message>DB2LaTeX: Need to process XPath match <xsl:value-of select="concat(name(..),'/',name(.))"/></xsl:message> + <xsl:text> [</xsl:text><xsl:value-of select="name(.)"/><xsl:text>] </xsl:text> + <xsl:apply-templates/> + <xsl:text> [/</xsl:text><xsl:value-of select="name(.)"/><xsl:text>] </xsl:text> + </xsl:template> +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/example.mod.xsl b/docs/docbook/xslt/db2latex/example.mod.xsl new file mode 100644 index 0000000000..6f67df52bf --- /dev/null +++ b/docs/docbook/xslt/db2latex/example.mod.xsl @@ -0,0 +1,79 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: example.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="example" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: example.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Example <filename>example.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + <xsl:template match="example"> + <xsl:variable name="placement"> + <xsl:call-template name="generate.formal.title.placement"> + <xsl:with-param name="object" select="local-name(.)" /> + </xsl:call-template> + </xsl:variable> + <xsl:variable name="caption"> + <xsl:text>\caption{</xsl:text> + <xsl:apply-templates select="title" mode="caption.mode"/> + <xsl:text>} </xsl:text> + </xsl:variable> + <xsl:call-template name="map.begin"/> + <xsl:if test="$placement='before'"> + <xsl:text>\captionswapskip{}</xsl:text> + <xsl:value-of select="$caption" /> + <xsl:text>\captionswapskip{}</xsl:text> + </xsl:if> + <xsl:apply-templates /> + <xsl:if test="$placement!='before'"><xsl:value-of select="$caption" /></xsl:if> + <xsl:call-template name="map.end"/> + </xsl:template> + + + + <xsl:template match="example/title"></xsl:template> + + + + + <xsl:template match="informalexample"> + <xsl:call-template name="informal.object"/> + </xsl:template> + + + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/figure.mod.xsl b/docs/docbook/xslt/db2latex/figure.mod.xsl new file mode 100644 index 0000000000..f23689608a --- /dev/null +++ b/docs/docbook/xslt/db2latex/figure.mod.xsl @@ -0,0 +1,130 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: figure.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: Template for figure tag. ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="figure" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: figure.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Figures and InformalFigures <filename>figure.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + <!--############################################################################# --> + + + + + <!--############################################################################# --> + <doc:template match="figure|informalfigure" xmlns=""> + <refpurpose> XSL template for figure|informalfigure </refpurpose> + <refdescription> + <para>Outputs <literal>\begin{figure}</literal>, + applies templates and outputs <literal>\end{figure}</literal>. </para> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + <listitem><para>The <literal>figure.title</literal> can be typset in italics by specifying <literal>$latex.figure.title.style</literal> (<literal>\itshape</literal> would be common).</para></listitem> + <listitem><para>If a <literal>figure.mediaobject.caption</literal> exists, it will be typeset after the <literal>figure.title</literal> (but only if there is a single <literal>figure.mediaobject.caption</literal>).</para></listitem> + </itemizedlist> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + +<!-- Auxiliary template to output a figure caption.--> +<xsl:template name="aux.figure.caption"> +<xsl:text>\caption{{</xsl:text> +<xsl:value-of select="$latex.figure.title.style"/> +<xsl:text>{</xsl:text> +<xsl:apply-templates select="title"/> +<xsl:text>}}</xsl:text> +<xsl:if test="count(child::mediaobject/caption)=1"> + <xsl:text>. </xsl:text> + <xsl:apply-templates select="mediaobject/caption" /> +</xsl:if> +<xsl:text>} </xsl:text> +</xsl:template> + +<xsl:template match="figure|informalfigure"> + <xsl:variable name="placement"> + <xsl:call-template name="generate.formal.title.placement"> + <xsl:with-param name="object" select="local-name(.)" /> + </xsl:call-template> + </xsl:variable> + <xsl:call-template name="map.begin"/> + <xsl:if test="$placement='before'"> + <xsl:text>\captionswapskip{}</xsl:text> + <xsl:call-template name="aux.figure.caption" /> + <xsl:text>\captionswapskip{}</xsl:text> + </xsl:if> + <xsl:apply-templates select="*[name(.) != 'title']"/> + <xsl:if test="$placement!='before'"> + <xsl:call-template name="aux.figure.caption" /> + </xsl:if> + <xsl:call-template name="map.end"/> +</xsl:template> + + + + <!--############################################################################# --> + <!-- + <doc:template match="figure[programlisting]" xmlns=""> + <refpurpose> XSL template for programlisting within a figure </refpurpose> + <refdescription> + <para>Outputs <literal>\begin{figure}</literal>, + applies templates and outputs <literal>\end{abstract}</literal>. </para> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + </itemizedlist> + </formalpara> + </refdescription> + </doc:template> + --> + <!--############################################################################# --> + + <!-- + <xsl:template match="figure[programlisting]"> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="programlisting"/> + </xsl:call-template> + <xsl:apply-templates /> + <xsl:call-template name="map.end"> + <xsl:with-param name="keyword" select="programlisting"/> + </xsl:call-template> + </xsl:template> + --> + + <xsl:template match="figure/title"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="informalfigure/title"> + </xsl:template> +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/font.mod.xsl b/docs/docbook/xslt/db2latex/font.mod.xsl new file mode 100644 index 0000000000..c66d6aab37 --- /dev/null +++ b/docs/docbook/xslt/db2latex/font.mod.xsl @@ -0,0 +1,58 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: font.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="font" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: font.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Font <filename>font.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <doc:param name="latex.document.font" xmlns=""> + <refpurpose> Document Font </refpurpose> + <refdescription> + Possible values: default, times, palatcm, charter, helvet, palatino, avant, newcent, bookman + </refdescription> + </doc:param> + + + <xsl:param name="latex.document.font">palatino</xsl:param> + + <!-- + If you want to change explicitly to a certain font, use the command \fontfamily{XYZ}\selectfont whereby XYZ can be set to: pag for Adobe AvantGarde, pbk for Adobe Bookman, pcr for Adobe Courier, phv for Adobe Helvetica, pnc for Adobe NewCenturySchoolbook, ppl for Adobe Palatino, ptm for Adobe Times Roman, pzc for Adobe ZapfChancery + --> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/footnote.mod.xsl b/docs/docbook/xslt/db2latex/footnote.mod.xsl new file mode 100644 index 0000000000..1fb23dfbeb --- /dev/null +++ b/docs/docbook/xslt/db2latex/footnote.mod.xsl @@ -0,0 +1,85 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: footnote.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="footnote" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: footnote.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>FootNotes <filename>footnote.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + <!--############################################################################# --> + + + + <xsl:template match="footnote"> + <xsl:call-template name="label.id"/> + <xsl:text>\begingroup\catcode`\#=12\footnote{</xsl:text> + <xsl:apply-templates/> + <xsl:text>}\endgroup\docbooktolatexmakefootnoteref{</xsl:text> + <xsl:call-template name="generate.label.id"/> + <xsl:text>}</xsl:text> + </xsl:template> + + <doc:template name="footnote"> + <refpurpose>Construct a footnote that copes with URLs</refpurpose> + <refdescription><para>This template exists in this file so that all + the footnote-generating templates are close to each other. However, + it is actually a part of the ulink template in xref.mod.xsl</para></refdescription> + </doc:template> + <xsl:template name="footnote"> + <xsl:param name="hyphenation"/> + <xsl:param name="url"/> + <xsl:call-template name="label.id"/> + <xsl:text>\begingroup\catcode`\#=12\footnote{</xsl:text> + <xsl:call-template name="generate.typeset.url"> + <xsl:with-param name="hyphenation" select="$hyphenation"/> + <xsl:with-param name="url" select="$url"/> + </xsl:call-template> + <xsl:text>}\endgroup\docbooktolatexmakefootnoteref{</xsl:text> + <xsl:call-template name="generate.label.id"/> + <xsl:text>}</xsl:text> + </xsl:template> + + <xsl:template match="footnote/para"> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + </xsl:template> + + + <xsl:template match="footnoteref"> + <xsl:variable name="footnote" select="id(@linkend)"/> + <xsl:text>\docbooktolatexusefootnoteref{</xsl:text> + <xsl:value-of select="@linkend"/> + <xsl:text>}</xsl:text> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/formal.mod.xsl b/docs/docbook/xslt/db2latex/formal.mod.xsl new file mode 100644 index 0000000000..6c3ea3ff55 --- /dev/null +++ b/docs/docbook/xslt/db2latex/formal.mod.xsl @@ -0,0 +1,176 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: formal.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="formal" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: formal.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Formal Objects <filename>formal.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <xsl:template name="formal.object"> + <xsl:call-template name="formal.object.heading"> + <xsl:with-param name="title"><xsl:apply-templates select="." mode="title.ref"/></xsl:with-param> + </xsl:call-template> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template name="formal.object.heading"> + <xsl:param name="title"></xsl:param> + <xsl:call-template name="label.id"/> + <xsl:copy-of select="$title"/> + </xsl:template> + + <xsl:template name="informal.object"> + <xsl:call-template name="label.id"/> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template name="semiformal.object"> + <xsl:choose> + <xsl:when test="title"> <xsl:call-template name="formal.object"/> </xsl:when> + <xsl:otherwise> <xsl:call-template name="informal.object"/></xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <xsl:template name="generate.formal.title.placement"> + <xsl:param name="object" select="figure" /> + <xsl:variable name="param.placement" select="substring-after(normalize-space($formal.title.placement),concat($object, ' '))"/> + <xsl:choose> + <xsl:when test="contains($param.placement, ' ')"> + <xsl:value-of select="substring-before($param.placement, ' ')"/> + </xsl:when> + <xsl:when test="$param.placement = ''">before</xsl:when> + <xsl:otherwise> + <xsl:value-of select="$param.placement"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + +<!-- ======================================== --> +<!-- XSL Template for DocBook Equation Element --> +<!-- 2003/07/04 Applied patches from J.Pavlovic --> +<!-- ======================================== --> +<xsl:template match="equation"> +<!-- Equation title placement --> +<xsl:variable name="placement"> + <xsl:call-template name="generate.formal.title.placement"> + <xsl:with-param name="object" select="local-name(.)" /> + </xsl:call-template> +</xsl:variable> +<!-- Equation caption --> +<xsl:variable name="caption"> + <xsl:text>\caption{</xsl:text> + <xsl:apply-templates select="title" mode="caption.mode"/> + <xsl:text>} </xsl:text> +</xsl:variable> +<xsl:call-template name="map.begin"/> +<xsl:if test="$placement='before'"> + <xsl:text>\captionswapskip{}</xsl:text> + <xsl:value-of select="$caption" /> + <xsl:text>\captionswapskip{}</xsl:text> +</xsl:if> +<xsl:choose> + <xsl:when test="informalequation"> + <xsl:apply-templates select="informalequation"/> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="tex" select="alt[@role='tex' or @role='latex']|mediaobject/textobject[@role='tex' or @role='latex']|mediaobject/textobject/phrase[@role='tex' or @role='latex']"/> + <xsl:choose> + <xsl:when test="$tex"> + <xsl:apply-templates select="$tex"/> + </xsl:when> + <xsl:when test="alt and $latex.alt.is.preferred='1'"> + <xsl:apply-templates select="alt"/> + </xsl:when> + <xsl:when test="mediaobject"> + <xsl:apply-templates select="mediaobject"/> + </xsl:when> + <xsl:when test="alt"> + <xsl:apply-templates select="alt"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="graphic"/> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> +</xsl:choose> +<xsl:if test="$placement!='before'"><xsl:value-of select="$caption" /></xsl:if> +<xsl:call-template name="map.end"/> +</xsl:template> + + +<xsl:template match="equation/title"/> + + + + + +<xsl:template match="informalequation"> +<xsl:variable name="tex" select="alt[@role='tex' or @role='latex']|mediaobject/textobject[@role='tex' or @role='latex']|mediaobject/textobject/phrase[@role='tex' or @role='latex']"/> +<xsl:text> </xsl:text> +<xsl:choose> + <xsl:when test="$tex"> + <xsl:apply-templates select="$tex"/> + </xsl:when> + <xsl:when test="alt and $latex.alt.is.preferred='1'"> + <xsl:apply-templates select="alt"/> + </xsl:when> + <xsl:when test="mediaobject"> + <xsl:apply-templates select="mediaobject"/> + </xsl:when> + <xsl:when test="alt"> + <xsl:apply-templates select="alt"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="graphic"/> + </xsl:otherwise> +</xsl:choose> +<xsl:text> </xsl:text> +</xsl:template> + + + + + + + + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/glossary.mod.xsl b/docs/docbook/xslt/db2latex/glossary.mod.xsl new file mode 100644 index 0000000000..a88fe609c2 --- /dev/null +++ b/docs/docbook/xslt/db2latex/glossary.mod.xsl @@ -0,0 +1,221 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: glossary.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="glossary" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: glossary.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>Glossary <filename>glossary.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para>This reference applies to the glossary element name. Altough LaTeX + provides some glossary support, the better glossary management support + motivates the bypass of the LaTeX <literal>\makeglossary</literal> + command.</para> + </section> + </partintro> + </doc:reference> + <!--############################################################################# --> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="glossary" xmlns=""> + <refpurpose> Glossary XSL template / entry point </refpurpose> + <refdescription><para>The <sgmltag>glossary</sgmltag> element is the entry point + to a docbook glossary. The DB2LaTeX processing of the element is quite straight- + forward. First thing is to check whether the document is a book or article. In + both cases two new LaTeX commands are defined. <literal>\dbglossary</literal> + and <literal>\dbglossdiv</literal>. In the former case, they are mapped to + <literal>\chapter*</literal> and <literal>\section*</literal>. In the second + case to <literal>\section*</literal> and <literal>\subsection*</literal>.</para> + </refdescription> + <itemizedlist> + <listitem><para>Call template map.begin.</para></listitem> + <listitem><para>Apply Templates for Preamble, GlossDivs and GlossEntries (serial).</para></listitem> + <listitem><para>Call template map.end.</para></listitem> + </itemizedlist> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + <listitem><para>Template for glossary/glossaryinfo is EMPTY.</para></listitem> + <listitem><para>Template for glossary/title | glossary/subtitle is EMPTY.</para></listitem> + <listitem><para>Template for glossary/titleabbrev is EMPTY.</para></listitem> + </itemizedlist> + </formalpara> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="glossary"> + <xsl:variable name="divs" select="glossdiv"/> + <xsl:variable name="entries" select="glossentry"/> + <xsl:variable name="preamble" select="*[not(self::title or self::subtitle or self::glossdiv or self::glossentry)]"/> + <xsl:choose> + <xsl:when test="local-name(..)='book' or local-name(..)='part'"> + <xsl:text>\newcommand{\dbglossary}[1]{\chapter*{#1}}% </xsl:text> + <xsl:text>\newcommand{\dbglossdiv}[1]{\section*{#1}}% </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\newcommand{\dbglossary}[1]{\section*{#1}}% </xsl:text> + <xsl:text>\newcommand{\dbglossdiv}[1]{\subsection*{#1}}% </xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:call-template name="map.begin"/> + <xsl:if test="./subtitle"><xsl:apply-templates select="./subtitle" mode="component.title.mode"/> </xsl:if> + <xsl:if test="$preamble"> <xsl:apply-templates select="$preamble"/> </xsl:if> + <xsl:if test="$divs"> <xsl:apply-templates select="$divs"/> </xsl:if> + <xsl:if test="$entries"> <xsl:apply-templates select="$entries"/></xsl:if> + <xsl:call-template name="map.end"/> + </xsl:template> + + <xsl:template match="glossary/glossaryinfo"/> + <xsl:template match="glossary/title"/> + <xsl:template match="glossary/subtitle"/> + <xsl:template match="glossary/titleabbrev"/> + <xsl:template match="glossary/title" mode="component.title.mode"> <xsl:apply-templates/> </xsl:template> + <xsl:template match="glossary/subtitle" mode="component.title.mode"> <xsl:apply-templates/> </xsl:template> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="glossdiv|glosslist" xmlns=""> + <refpurpose> Glossary Division and Glossary Lists XSL templates. </refpurpose> + <refdescription><para>T.B.D</para> + </refdescription> + <itemizedlist> + <listitem><para>Call template map.begin.</para></listitem> + <listitem><para>Apply Templates.</para></listitem> + <listitem><para>Call template map.end.</para></listitem> + </itemizedlist> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + <listitem><para>Template for glossdiv/glossaryinfo is EMPTY.</para></listitem> + </itemizedlist> + </formalpara> + </doc:template> + <!--############################################################################# --> + <xsl:template match="glossdiv|glosslist"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + <xsl:call-template name="map.end"/> + </xsl:template> + + <xsl:template match="glossdiv/title" /> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="glossentry" xmlns=""> + <refpurpose> Glossary Entry XSL template / entry point </refpurpose> + <refdescription> + <para>T.B.D.</para> + </refdescription> + <itemizedlist> + <listitem><para>Apply Templates.</para></listitem> + </itemizedlist> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + <listitem><para>Explicit Templates for <literal>glossentry/glossterm</literal></para></listitem> + <listitem><para>Explicit Templates for <literal>glossentry/acronym</literal></para></listitem> + <listitem><para>Explicit Templates for <literal>glossentry/abbrev</literal></para></listitem> + <listitem><para>Explicit Templates for <literal>glossentry/glossdef</literal></para></listitem> + <listitem><para>Explicit Templates for <literal>glossentry/glosssee</literal></para></listitem> + <listitem><para>Explicit Templates for <literal>glossentry/glossseealso</literal></para></listitem> + <listitem><para>Template for glossentry/revhistory is EMPTY.</para></listitem> + </itemizedlist> + </formalpara> + </doc:template> + <!--############################################################################# --> + + + <xsl:template match="glossentry"> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="glossentry/glossterm"> + <xsl:text>\item[</xsl:text> + <xsl:if test="../@id!=''"> + <xsl:text>\hypertarget{</xsl:text> + <xsl:value-of select="../@id"/> + <xsl:text>}</xsl:text> + </xsl:if> + <xsl:text>{</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="."/> + </xsl:call-template> + <xsl:text>}] </xsl:text> + </xsl:template> + + <xsl:template match="glossentry/acronym"> + <xsl:text> ( \texttt {</xsl:text> <xsl:apply-templates/> <xsl:text>} ) </xsl:text> + </xsl:template> + + <xsl:template match="glossentry/abbrev"> + <xsl:text> [ </xsl:text> <xsl:apply-templates/> <xsl:text> ] </xsl:text> + </xsl:template> + + <xsl:template match="glossentry/revhistory"/> + + <xsl:template match="glossentry/glossdef"> + <xsl:text> </xsl:text> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="glossseealso|glossentry/glosssee"> + <xsl:variable name="otherterm" select="@otherterm"/> + <xsl:variable name="targets" select="//node()[@id=$otherterm]"/> + <xsl:variable name="target" select="$targets[1]"/> + <xsl:call-template name="gentext.element.name"/> + <xsl:call-template name="gentext.space"/> + <xsl:call-template name="gentext.startquote"/> + <xsl:choose> + <xsl:when test="@otherterm"> + <xsl:text>\hyperlink{</xsl:text><xsl:value-of select="@otherterm"/> + <xsl:text>}{</xsl:text><xsl:apply-templates select="$target" mode="xref"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> + <xsl:call-template name="gentext.endquote"/> + <xsl:text>. </xsl:text> + </xsl:template> + + <xsl:template match="glossentry" mode="xref"> + <xsl:apply-templates select="./glossterm" mode="xref"/> + </xsl:template> + + <xsl:template match="glossterm" mode="xref"> + <xsl:apply-templates/> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/graphic.mod.xsl b/docs/docbook/xslt/db2latex/graphic.mod.xsl new file mode 100644 index 0000000000..89799dbbb9 --- /dev/null +++ b/docs/docbook/xslt/db2latex/graphic.mod.xsl @@ -0,0 +1,90 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: graphic.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="graphic" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: graphic.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Graphics <filename>graphic.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <xsl:template match="screenshot"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="screeninfo"> + </xsl:template> + + + <xsl:template match="graphic[@fileref]"> + <xsl:text>\includegraphics{</xsl:text> <xsl:value-of select="normalize-space(@fileref)"/>} + </xsl:template> + + <xsl:template match="graphic[@entityref]"> + <xsl:text>\includegraphics{</xsl:text> <xsl:value-of select="unparsed-entity-uri(@entityref)"/>} + </xsl:template> + + + <xsl:template match="inlinegraphic[@fileref]"> + <xsl:choose> + <xsl:when test="@format='linespecific'"> + <a xml:link="simple" show="embed" actuate="auto" href="{@fileref}"/> + </xsl:when> + <xsl:otherwise> + <xsl:text>\includegraphics{</xsl:text> + <xsl:if test="@align"> + <!-- <xsl:attribute name="align"><xsl:value-of select="@align"/></xsl:attribute> --> + </xsl:if> + <xsl:value-of select="normalize-space(@fileref)"/>} + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="inlinegraphic[@entityref]"> + <xsl:choose> + <xsl:when test="@format='linespecific'"> + <a xml:link="simple" show="embed" actuate="auto" href="{@fileref}"/> + </xsl:when> + <xsl:otherwise> + <xsl:text>\includegraphics{</xsl:text> + <xsl:if test="@align"> + <!-- <xsl:attribute name="align"><xsl:value-of select="@align"/></xsl:attribute> --> + </xsl:if> + <xsl:value-of select="unparsed-entity-uri(@entityref)"/>} + </xsl:otherwise> + </xsl:choose> + </xsl:template> +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/html.mod.xsl b/docs/docbook/xslt/db2latex/html.mod.xsl new file mode 100644 index 0000000000..fade6e7e78 --- /dev/null +++ b/docs/docbook/xslt/db2latex/html.mod.xsl @@ -0,0 +1,17 @@ +<?xml version='1.0'?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version='1.0'> + <!--############################################################################# + | $Id: html.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: + | + + ############################################################################## --> + + + <xsl:template name="html"> + </xsl:template> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/index.mod.xsl b/docs/docbook/xslt/db2latex/index.mod.xsl new file mode 100644 index 0000000000..76985c19fd --- /dev/null +++ b/docs/docbook/xslt/db2latex/index.mod.xsl @@ -0,0 +1,216 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: index.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="index" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: index.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Index <filename>index.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + +<!-- This parameter is for enabeling or disabling of indexterms --> +<xsl:param name="latex.generate.indexterm">1</xsl:param> + +<!-- Our key for ranges --> +<xsl:key name="indexterm-range" match="indexterm[@class='startofrange']" use="@id"/> + + + + +<!-- ############################################################### --> +<!-- Index --> +<!-- --> +<!-- ############################################################### --> +<xsl:template match="index|setindex"> + <xsl:call-template name="label.id"/> + <xsl:text>\printindex </xsl:text> +</xsl:template> + +<xsl:template match="index/title"></xsl:template> +<xsl:template match="index/subtitle"></xsl:template> +<xsl:template match="index/titleabbrev"></xsl:template> + +<xsl:template match="index/title" mode="component.title.mode"> + <xsl:call-template name="label.id"> <xsl:with-param name="object" select=".."/> </xsl:call-template> +</xsl:template> + +<xsl:template match="index/subtitle" mode="component.title.mode"/> + + +<!-- ############################################################### --> +<!-- IndexDiv --> +<!-- --> +<!-- ############################################################### --> +<xsl:template match="indexdiv"> + <xsl:apply-templates/> +</xsl:template> + +<xsl:template match="indexdiv/title"> + <xsl:call-template name="label.id"> <xsl:with-param name="object" select=".."/> </xsl:call-template> +</xsl:template> + + +<!-- INDEX TERM CONTENT MODEL +IndexTerm ::= +(Primary, +((Secondary, +((Tertiary, +(See|SeeAlso+)?)| +See|SeeAlso+)?)| +See|SeeAlso+)?) +--> +<!-- ############################################################### --> +<!-- IndexDiv --> +<!-- --> +<!-- ############################################################### --> +<xsl:template match="indexterm"> +<xsl:if test="$latex.generate.indexterm != 0"> +<!-- + <xsl:text>\index{</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="normalize-space(./primary)"/> + </xsl:call-template> + <xsl:if test="./secondary"> + <xsl:text>!</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="normalize-space(./secondary)"/> + </xsl:call-template> + </xsl:if> + <xsl:if test="./tertiary"> + <xsl:text>!</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="normalize-space(./tertiary)"/> + </xsl:call-template> + </xsl:if> + <xsl:if test="./see"> + <xsl:text>|see{</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="normalize-space(./see)"/> + </xsl:call-template> + <xsl:text>}</xsl:text> + </xsl:if> + <xsl:if test="./seealso"> + <xsl:text>|see{</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="normalize-space(./seealso)"/> + </xsl:call-template> + <xsl:text>}</xsl:text> + </xsl:if> + <xsl:text>}</xsl:text> +--> + <xsl:variable name="idxterm"> + <xsl:apply-templates mode="indexterm"/> + </xsl:variable> + + <xsl:if test="@class and @zone"> + <xsl:message terminate="yes">Error: Only one attribut (@class or @zone) is in indexterm possible!</xsl:message> + </xsl:if> + + <xsl:choose> + <xsl:when test="@class='startofrange'"> + <xsl:text>\index{</xsl:text> + <xsl:value-of select="normalize-space($idxterm)"/> + <xsl:text>|(}</xsl:text> + </xsl:when> + <xsl:when test="@class='endofrange'"> + <xsl:choose> + <xsl:when test="count(key('indexterm-range',@startref)) = 0"> + <xsl:message terminate="yes"><xsl:text>Error: No indexterm with </xsl:text> + <xsl:text>id='</xsl:text><xsl:value-of select="@startref"/> + <xsl:text>' found!</xsl:text> + <xsl:text> Check your attributs id/startref in your indexterms!</xsl:text> + </xsl:message> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="thekey" select="key('indexterm-range',@startref)"/> + <xsl:text>\index{</xsl:text> + <xsl:apply-templates select="$thekey/*" mode="indexterm"/> + <xsl:text>|)}</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:text>\index{</xsl:text> + <xsl:message terminate="no"><xsl:text>Simple case:</xsl:text></xsl:message> + <xsl:value-of select="normalize-space($idxterm)"/> + <xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:if> +</xsl:template> + + +<!-- ================================================ --> +<xsl:template match="*" mode="indexterm"> + <xsl:message>WARNING: Element '<xsl:value-of select="local-name()"/>' in indexterm not supported!</xsl:message> +</xsl:template> + + + +<!-- ================================================ --> +<xsl:template match="primary" mode="indexterm"> +<xsl:apply-templates mode="indexterm"/> +</xsl:template> + +<xsl:template match="secondary" mode="indexterm"> +<xsl:text>!</xsl:text> +<xsl:apply-templates mode="indexterm"/> +</xsl:template> + +<xsl:template match="tertiary" mode="indexterm"> +<xsl:text>!</xsl:text> +<xsl:apply-templates mode="indexterm"/> +</xsl:template> + +<xsl:template match="see|seealso" mode="indexterm"> +<xsl:text>|see{</xsl:text> +<xsl:apply-templates mode="indexterm"/> +<xsl:text>} </xsl:text> +</xsl:template> + + +<!-- ================================================ --> +<!-- A simple example of what can be in an primary, --> +<!-- secondary or tertiary. --> +<!-- ================================================ --> +<xsl:template match="acronym" mode="indexterm"> +<xsl:apply-templates mode="indexterm"/> +</xsl:template> + + +<xsl:template match="primary|secondary|tertiary|see|seealso"/> +<xsl:template match="indexentry"/> +<xsl:template match="primaryie|secondaryie|tertiaryie|seeie|seealsoie"/> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/info.mod.xsl b/docs/docbook/xslt/db2latex/info.mod.xsl new file mode 100644 index 0000000000..3b8bb5162a --- /dev/null +++ b/docs/docbook/xslt/db2latex/info.mod.xsl @@ -0,0 +1,69 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: info.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="info" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: info.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Info <filename>info.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <!-- These templates define the "default behavior" for info + elements. Even if you don't process the *info wrappers, + some of these elements are needed because the elements are + processed from named templates that are called with modes. + Since modes aren't sticky, these rules apply. + (TODO: clarify this comment) --> + + + <xsl:template match="corpauthor"> + <xsl:apply-templates/> + </xsl:template> + + + <xsl:template match="jobtitle"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="orgname"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="orgdiv"> + <xsl:apply-templates/> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/inline.mod.xsl b/docs/docbook/xslt/db2latex/inline.mod.xsl new file mode 100644 index 0000000000..5661ca4385 --- /dev/null +++ b/docs/docbook/xslt/db2latex/inline.mod.xsl @@ -0,0 +1,526 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: inline.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="inline" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: inline.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>Inline <filename>inline.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + <!--############################################################################# --> + + + + + <xsl:template name="inline.charseq"> + <xsl:param name="content"> + <xsl:apply-templates/> + </xsl:param> + <xsl:copy-of select="$content"/> + </xsl:template> + + <xsl:template name="inline.monoseq"> + <xsl:param name="hyphenation">\docbookhyphenatedot</xsl:param> + <xsl:param name="content"> + <xsl:apply-templates/> + </xsl:param> + <xsl:text>{\texttt{</xsl:text> + <xsl:if test="$latex.hyphenation.tttricks='1'"><xsl:value-of select="$hyphenation" /></xsl:if> + <xsl:text>{</xsl:text> + <xsl:copy-of select="$content"/> + <xsl:text>}}}</xsl:text> + </xsl:template> + + <xsl:template name="inline.boldseq"> + <xsl:param name="content"> + <xsl:apply-templates/> + </xsl:param> + <xsl:text>{\bfseries </xsl:text> + <xsl:copy-of select="$content"/> + <xsl:text>}</xsl:text> + </xsl:template> + + <xsl:template name="inline.italicseq"> + <xsl:param name="content"> + <xsl:apply-templates/> + </xsl:param> + <xsl:text>{\em </xsl:text> + <xsl:copy-of select="$content"/> + <xsl:text>}</xsl:text> + </xsl:template> + + <xsl:template name="inline.boldmonoseq"> + <xsl:param name="hyphenation">\docbookhyphenatedot</xsl:param> + <xsl:param name="content"> + <xsl:apply-templates/> + </xsl:param> + <xsl:text>{\texttt\bfseries{</xsl:text> + <xsl:if test="$latex.hyphenation.tttricks='1'"><xsl:value-of select="$hyphenation" /></xsl:if> + <xsl:text>{</xsl:text> + <xsl:copy-of select="$content"/> + <xsl:text>}}}</xsl:text> + </xsl:template> + + <xsl:template name="inline.italicmonoseq"> + <xsl:param name="hyphenation">\docbookhyphenatedot</xsl:param> + <xsl:param name="content"> + <xsl:apply-templates/> + </xsl:param> + <xsl:text>{\texttt\itshape{</xsl:text> + <xsl:if test="$latex.hyphenation.tttricks='1'"><xsl:value-of select="$hyphenation" /></xsl:if> + <xsl:text>{</xsl:text> + <xsl:copy-of select="$content"/> + <xsl:text>}}}</xsl:text> + </xsl:template> + + <xsl:template name="inline.superscriptseq"> + <xsl:param name="content"> + <xsl:apply-templates/> + </xsl:param> + <xsl:text>$^\text{</xsl:text> + <xsl:copy-of select="$content"/> + <xsl:text>}$</xsl:text> + </xsl:template> + + <xsl:template name="inline.subscriptseq"> + <xsl:param name="content"> + <xsl:apply-templates/> + </xsl:param> + <xsl:text>$_\text{</xsl:text> + <xsl:copy-of select="$content"/> + <xsl:text>}$</xsl:text> + </xsl:template> + + + + + + + <!-- ==================================================================== --> + <!-- some special cases --> + + <xsl:template match="author"> + <xsl:call-template name="person.name"/> + </xsl:template> + + <xsl:template match="editor"> + <xsl:call-template name="person.name"/> + </xsl:template> + + <xsl:template match="othercredit"> + <xsl:call-template name="person.name"/> + </xsl:template> + + <xsl:template match="authorinitials"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <!-- ==================================================================== --> + + <xsl:template match="accel"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="action"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="application"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="classname"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="exceptionname"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="interfacename"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="methodname"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="command"> + <xsl:call-template name="inline.boldseq"/> + </xsl:template> + + <xsl:template match="computeroutput"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="constant"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="database"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="errorcode"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="errorname"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="errortype"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="envar"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="filename"> + <xsl:call-template name="inline.monoseq"><xsl:with-param name="hyphenation">\docbookhyphenatefilename</xsl:with-param></xsl:call-template> + </xsl:template> + + + + <xsl:template match="function"> + <xsl:choose> + <xsl:when test="$function.parens != '0' + or parameter or function or replaceable"> <xsl:variable name="nodes" select="text()|*"/> + <xsl:call-template name="inline.monoseq"> + <xsl:with-param name="content"> + <xsl:apply-templates select="$nodes[1]"/> + </xsl:with-param> + </xsl:call-template> + <xsl:text>(</xsl:text> + <xsl:apply-templates select="$nodes[position()>1]"/> + <xsl:text>)</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="inline.monoseq"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="function/parameter" priority="2"> + <xsl:call-template name="inline.italicmonoseq"/> + <xsl:if test="following-sibling::*"> + <xsl:text>, </xsl:text> + </xsl:if> + </xsl:template> + + <xsl:template match="function/replaceable" priority="2"> + <xsl:call-template name="inline.italicmonoseq"/> + <xsl:if test="following-sibling::*"> + <xsl:text>, </xsl:text> + </xsl:if> + </xsl:template> + + <xsl:template match="guibutton|guiicon|guilabel|guimenu|guimenuitem|guisubmenu|interface"> + <xsl:text>{\sffamily \bfseries </xsl:text> + <xsl:call-template name="inline.charseq" /> + <xsl:text>}</xsl:text> + </xsl:template> + + <xsl:template match="hardware"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="interfacedefinition"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="keycap|keysym"> + <xsl:call-template name="inline.boldseq" /> + </xsl:template> + + <xsl:template match="keycode"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="literal"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="medialabel"> + <xsl:call-template name="inline.italicseq"/> + </xsl:template> + + <xsl:template match="shortcut"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="mousebutton"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="option"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="parameter" priority="1"> + <xsl:call-template name="inline.italicmonoseq"/> + </xsl:template> + + <xsl:template match="property"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="prompt"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="replaceable" priority="1"> + <xsl:call-template name="inline.italicmonoseq"/> + </xsl:template> + + <xsl:template match="returnvalue"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="structfield"> + <xsl:call-template name="inline.italicmonoseq"/> + </xsl:template> + + <xsl:template match="structname"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="symbol"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="systemitem"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="token"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="type"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="userinput"> + <xsl:call-template name="inline.boldmonoseq"/> + </xsl:template> + + <xsl:template match="abbrev"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="acronym"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="citerefentry"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="citetitle"> + <xsl:call-template name="inline.italicseq"/> + </xsl:template> + + <xsl:template match="emphasis"> + <xsl:call-template name="inline.italicseq"/> + </xsl:template> + + <xsl:template match="emphasis[@role='bold']"> + <xsl:call-template name="inline.boldseq"/> + </xsl:template> + + <xsl:template match="foreignphrase"> + <xsl:call-template name="inline.italicseq"/> + </xsl:template> + + <xsl:template match="markup"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <doc:template match="phrase"> + <refpurpose> A span of text </refpurpose> + <refdescription><para> + This is a regular inline sequence. + However, if the role attribute is 'tex' or 'latex', the content + will be output without LaTeX active-character escaping. + </para></refdescription> + </doc:template> + <xsl:template match="phrase"> + <xsl:choose> + <xsl:when test="@role='tex' or @role='latex'"> + <xsl:value-of select="."/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="inline.charseq"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="quote"> + <xsl:call-template name="gentext.nestedstartquote"/> + <xsl:call-template name="inline.charseq"/> + <xsl:call-template name="gentext.nestedendquote"/> + </xsl:template> + + <xsl:template match="varname"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template match="wordasword"> + <xsl:call-template name="inline.italicseq"/> + </xsl:template> + + <xsl:template match="lineannotation"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="superscript"> + <xsl:call-template name="inline.superscriptseq"/> + </xsl:template> + + <xsl:template match="subscript"> + <xsl:call-template name="inline.subscriptseq"/> + </xsl:template> + + <xsl:template match="trademark"> + <xsl:call-template name="inline.charseq"/> + <xsl:call-template name="dingbat"> + <xsl:with-param name="dingbat">trademark</xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template match="firstterm"> + <xsl:call-template name="inline.italicseq"/> + </xsl:template> + + <xsl:template match="glossterm"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="keycombo"> + <xsl:variable name="action" select="@action"/> + <xsl:variable name="joinchar"> + <xsl:choose> + <xsl:when test="$action='seq'"><xsl:text> </xsl:text></xsl:when> + <xsl:when test="$action='simul'">+</xsl:when> + <xsl:when test="$action='press'">--</xsl:when> + <xsl:when test="$action='click'">--</xsl:when> + <xsl:when test="$action='double-click'">--</xsl:when> + <xsl:when test="$action='other'"></xsl:when> + <xsl:otherwise>--</xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:for-each select="./*"> + <xsl:if test="position()>1"><xsl:value-of select="$joinchar"/></xsl:if> + <xsl:apply-templates select="."/> + </xsl:for-each> + </xsl:template> + + <!-- ==================================================================== --> + + <xsl:template match="menuchoice"> + <xsl:variable name="shortcut" select="./shortcut"/> + <xsl:call-template name="process.menuchoice"/> + <xsl:if test="$shortcut"> + <xsl:text> (</xsl:text> + <xsl:apply-templates select="$shortcut"/> + <xsl:text>)</xsl:text> + </xsl:if> + </xsl:template> + + <xsl:template name="process.menuchoice"> + <xsl:param name="nodelist" select="guibutton|guiicon|guilabel|guimenu|guimenuitem|guisubmenu|interface"/><!-- not(shortcut) --> + <xsl:param name="count" select="1"/> + + <xsl:choose> + <xsl:when test="$count>count($nodelist)"></xsl:when> + <xsl:when test="$count=1"> + <xsl:apply-templates select="$nodelist[$count=position()]"/> + <xsl:call-template name="process.menuchoice"> + <xsl:with-param name="nodelist" select="$nodelist"/> + <xsl:with-param name="count" select="$count+1"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="node" select="$nodelist[$count=position()]"/> + <xsl:choose> + <xsl:when test="name($node)='guimenuitem' + or name($node)='guisubmenu'"> + <xsl:text> $\to$ </xsl:text> + </xsl:when> + <xsl:otherwise>+</xsl:otherwise> + </xsl:choose> + <xsl:apply-templates select="$node"/> + <xsl:call-template name="process.menuchoice"> + <xsl:with-param name="nodelist" select="$nodelist"/> + <xsl:with-param name="count" select="$count+1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <!-- ==================================================================== --> + + <xsl:template match="optional"> + <xsl:value-of select="$arg.choice.opt.open.str"/> + <xsl:call-template name="inline.charseq"/> + <xsl:value-of select="$arg.choice.opt.close.str"/> + </xsl:template> + + <!-- ==================================================================== --> + + <xsl:template match="comment|remark"> + <xsl:if test="$show.comments != 0"> + <i><xsl:call-template name="inline.charseq"/></i> + </xsl:if> + </xsl:template> + + <!-- ==================================================================== --> + + <xsl:template match="productname"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="productnumber"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <!-- ==================================================================== --> + + <xsl:template match="pob|street|city|state|postcode|country|phone|fax|otheraddr"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <!-- ==================================================================== --> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/keywords.mod.xsl b/docs/docbook/xslt/db2latex/keywords.mod.xsl new file mode 100644 index 0000000000..c3fd7376b5 --- /dev/null +++ b/docs/docbook/xslt/db2latex/keywords.mod.xsl @@ -0,0 +1,62 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: keywords.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="keywords" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: keywords.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Keywords <filename>keywords.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + +<xsl:template match="keywordset"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + <xsl:call-template name="map.end"/> +</xsl:template> + +<xsl:template match="keyword"> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="normalize-space(.)"/> + </xsl:call-template> + <xsl:if test="following-sibling::keyword">, </xsl:if> +</xsl:template> + + + + + +<xsl:template match="subjectset"></xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/labelid.mod.xsl b/docs/docbook/xslt/db2latex/labelid.mod.xsl new file mode 100644 index 0000000000..7f8206321f --- /dev/null +++ b/docs/docbook/xslt/db2latex/labelid.mod.xsl @@ -0,0 +1,479 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: labelid.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: When this template is called, it marks the object with a label +| and an hypertarget. ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="labelid" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: labelid.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Labels <filename>labelid.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + <doc:template name="label.id" xmlns=""> + <refpurpose>Marks the current object with a label.</refpurpose> + <refdescription> + <para>This template marks the current object with a <literal> + \label{.}</literal>. The passed argument indicates the object whose + <literal>id attribute</literal> is used to generate the label. + In this sense, in most cases its the current node itself. + If the used object has not an id attribute, a unique id is + obtained by means of the <literal>generate-id</literal> function. + Moreover, if we are using the hyperref package, a hypertarget is + also defined for this object. </para> + </refdescription> + <refparameter> + <variablelist> + <varlistentry><term>object</term> + <listitem><para>The node whose id is to be used.</para></listitem> + </varlistentry> + </variablelist> + </refparameter> + <refreturn> + <para>This template returns the id that has been used to label the + object.</para> + </refreturn> + </doc:template> + + <xsl:template name="label.id"> + <xsl:text>\label{</xsl:text> + <xsl:call-template name="generate.label.id"/> + <xsl:text>}</xsl:text> + </xsl:template> + + <xsl:template name="generate.label.id"> + <xsl:param name="object" select="."/> + <xsl:variable name="id"> + <xsl:choose> + <xsl:when test="$object/@id"> + <xsl:value-of select="$object/@id"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="generate-id($object)"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:value-of select="normalize-space($id)"/> + </xsl:template> + + + + + <!-- + <xsl:template match="*" mode="label.content"> + <xsl:message> + <xsl:text>Request for label of unexpected element: </xsl:text> + <xsl:value-of select="name(.)"/> + </xsl:message> + </xsl:template> + + <xsl:template match="set|book" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:if test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:if> + </xsl:template> + + <xsl:template match="part" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$part.autolabel != 0"> + <xsl:number from="book" count="part" format="I"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> + </xsl:template> + + + <xsl:template match="preface" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$preface.autolabel != 0"> + <xsl:number from="book" count="preface" format="1" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> + </xsl:template> + + <xsl:template match="chapter" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$chapter.autolabel != 0"> + <xsl:number from="book" count="chapter" format="1" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> + </xsl:template> + + <xsl:template match="appendix" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$chapter.autolabel != 0"> + <xsl:number from="book" count="appendix" format="A" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> + </xsl:template> + + <xsl:template match="article" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:if test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:if> + </xsl:template> + + + <xsl:template match="dedication|colophon" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:if test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:if> + </xsl:template> + + <xsl:template match="reference" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$part.autolabel != 0"> + <xsl:number from="book" count="reference" format="I" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> + </xsl:template> + + <xsl:template match="refentry" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:if test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:if> + </xsl:template> + + <xsl:template match="section" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + + <xsl:if test="local-name(..) = 'section'"> + <xsl:apply-templates select=".." mode="label.content"> + <xsl:with-param name="punct">.</xsl:with-param> + </xsl:apply-templates> + </xsl:if> + + <xsl:variable name="parent.is.component"> + <xsl:call-template name="is.component"> + <xsl:with-param name="node" select=".."/> + </xsl:call-template> + </xsl:variable> + + <xsl:variable name="label"> + <xsl:call-template name="label.this.section"> + <xsl:with-param name="section" select="."/> + </xsl:call-template> + </xsl:variable> + + <xsl:if test="$section.label.includes.component.label != 0 + and $parent.is.component != 0"> + <xsl:apply-templates select=".." mode="label.content"> + <xsl:with-param name="punct">.</xsl:with-param> + </xsl:apply-templates> + </xsl:if> + + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$label != 0"> + <xsl:number count="section"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> + </xsl:template> + + <xsl:template match="sect1" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + + <xsl:variable name="parent.is.component"> + <xsl:call-template name="is.component"> + <xsl:with-param name="node" select=".."/> + </xsl:call-template> + </xsl:variable> + <xsl:if test="$section.label.includes.component.label != 0 + and $parent.is.component"> + <xsl:apply-templates select=".." mode="label.content"> + <xsl:with-param name="punct">.</xsl:with-param> + </xsl:apply-templates> + </xsl:if> + + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$section.autolabel != 0"> + <xsl:number count="sect1"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> + </xsl:template> + + <xsl:template match="sect2|sect3|sect4|sect5" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + + <xsl:apply-templates select=".." mode="label.content"> + <xsl:with-param name="punct">.</xsl:with-param> + </xsl:apply-templates> + + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$section.autolabel != 0"> + <xsl:choose> + <xsl:when test="local-name(.) = 'sect2'"> + <xsl:number count="sect2"/> + </xsl:when> + <xsl:when test="local-name(.) = 'sect3'"> + <xsl:number count="sect3"/> + </xsl:when> + <xsl:when test="local-name(.) = 'sect4'"> + <xsl:number count="sect4"/> + </xsl:when> + <xsl:when test="local-name(.) = 'sect5'"> + <xsl:number count="sect5"/> + </xsl:when> + <xsl:otherwise> + <xsl:message>label.content: this can't happen!</xsl:message> + </xsl:otherwise> + </xsl:choose> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> + </xsl:template> + <xsl:template match="refsect1|refsect2|refsect3" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$section.autolabel != 0"> + <xsl:number level="multiple" count="refsect1|refsect2|refsect3"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> + </xsl:template> + + <xsl:template match="simplesect" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$section.autolabel != 0"> + <xsl:number level="multiple" count="section + |sect1|sect2|sect3|sect4|sect5 + |refsect1|refsect2|refsect3 + |simplesect"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> + </xsl:template> + + <xsl:template match="qandadiv" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:variable name="prefix"> + <xsl:if test="$qanda.inherit.numeration != 0"> + <xsl:variable name="lparent" select="(ancestor::set + |ancestor::book + |ancestor::chapter + |ancestor::appendix + |ancestor::preface + |ancestor::section + |ancestor::simplesect + |ancestor::sect1 + |ancestor::sect2 + |ancestor::sect3 + |ancestor::sect4 + |ancestor::sect5 + |ancestor::refsect1 + |ancestor::refsect2 + |ancestor::refsect3)[last()]"/> + <xsl:if test="count($lparent)>0"> + <xsl:apply-templates select="$lparent" mode="label.content"/> + </xsl:if> + </xsl:if> + </xsl:variable> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="$prefix"/> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:when test="$qandadiv.autolabel != 0"> + <xsl:value-of select="$prefix"/> + <xsl:number level="multiple" count="qandadiv" format="1"/> + <xsl:value-of select="$punct"/> + </xsl:when> + </xsl:choose> + </xsl:template> + + <xsl:template match="question|answer" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:variable name="prefix"> + <xsl:if test="$qanda.inherit.numeration != 0"> + <xsl:variable name="lparent" select="(ancestor::set + |ancestor::book + |ancestor::chapter + |ancestor::appendix + |ancestor::preface + |ancestor::section + |ancestor::simplesect + |ancestor::sect1 + |ancestor::sect2 + |ancestor::sect3 + |ancestor::sect4 + |ancestor::sect5 + |ancestor::refsect1 + |ancestor::refsect2 + |ancestor::refsect3 + |ancestor::qandadiv)[last()]"/> + <xsl:if test="count($lparent)>0"> + <xsl:apply-templates select="$lparent" mode="label.content"/> + </xsl:if> + </xsl:if> + </xsl:variable> + + <xsl:variable name="inhlabel" + select="ancestor-or-self::qandaset/@defaultlabel[1]"/> + + <xsl:variable name="deflabel"> + <xsl:choose> + <xsl:when test="$inhlabel != ''"> + <xsl:value-of select="$inhlabel"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$qanda.defaultlabel"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="label" select="label"/> + + <xsl:choose> + <xsl:when test="count($label)>0"> + <xsl:value-of select="$prefix"/> + <xsl:apply-templates select="$label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + + <xsl:when test="$deflabel = 'qanda'"> + <xsl:call-template name="gentext.element.name"/> + </xsl:when> + + <xsl:when test="$deflabel = 'number'"> + <xsl:if test="name(.) = 'question'"> + <xsl:value-of select="$prefix"/> + <xsl:number level="multiple" count="qandaentry" format="1"/> + <xsl:value-of select="$punct"/> + </xsl:if> + </xsl:when> + </xsl:choose> + </xsl:template> + + <xsl:template match="bibliography|glossary|index" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:if test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:if> + </xsl:template> + + <xsl:template match="figure|table|example|equation" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + <xsl:choose> + <xsl:when test="@label"> + <xsl:value-of select="@label"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="pchap" + select="ancestor::chapter|ancestor::appendix"/> + <xsl:choose> + <xsl:when test="count($pchap)>0"> + <xsl:apply-templates select="$pchap" mode="label.content"> + <xsl:with-param name="punct">.</xsl:with-param> + </xsl:apply-templates> + <xsl:number format="1" from="chapter|appendix" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:when> + <xsl:otherwise> + <xsl:number format="1" from="book|article" level="any"/> + <xsl:value-of select="$punct"/> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="abstract" mode="label.content"> + <xsl:param name="punct">.</xsl:param> + </xsl:template> + --> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/latex.mapping.dtd b/docs/docbook/xslt/db2latex/latex.mapping.dtd new file mode 100644 index 0000000000..361ce5a18d --- /dev/null +++ b/docs/docbook/xslt/db2latex/latex.mapping.dtd @@ -0,0 +1,13 @@ +<!ELEMENT latexbindings (latexmapping+)> +<!ELEMENT latexmapping (mapping+)> +<!ELEMENT mapping (line*)> +<!ELEMENT line (#PCDATA)> + +<!ATTLIST latexmapping +role CDATA #REQUIRED +> +<!ATTLIST mapping +key CDATA #REQUIRED +text CDATA #REQUIRED +> + diff --git a/docs/docbook/xslt/db2latex/latex.mapping.xml b/docs/docbook/xslt/db2latex/latex.mapping.xml new file mode 100644 index 0000000000..1616774046 --- /dev/null +++ b/docs/docbook/xslt/db2latex/latex.mapping.xml @@ -0,0 +1,290 @@ +<?xml version='1.0'?> +<!DOCTYPE latexbindings SYSTEM "latex.mapping.dtd" []> + +<latexbindings> + + <!-- + ################################################################ + Keywords + %id + %title + ################################################################ --> + + + <!-- LaTeX mapping, role, BEGIN --> + <latexmapping role="begin"> + + <mapping key="abstract" text=""> + <line> </line> + <line>% -------------------------------------------- </line> + <line>% Abstract </line> + <line>% -------------------------------------------- </line> + <line>\begin{abstract} </line> + </mapping> + + <mapping key="admonition" text=""> + <line> </line> + <line>\begin{admonition}%title% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path </line> + </mapping> + + <mapping key="appendixes" text=""> + <line>% ------------------------------------------------------------- </line> + <line>% Appendixes start here </line> + <line>% ------------------------------------------------------------- </line> + <line>\appendix </line> + </mapping> + + <mapping key="appendix" text=""> + <line> </line> + <line>% ------------------------------------------------------------- </line> + <line>% appendix: %title </line> + <line>% ------------------------------------------------------------- </line> + <line>\dbappendix{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="chapter" text=""> + <line> </line> + <line>% ------------------------------------------------------------- </line> + <line>% Chapter %title </line> + <line>% ------------------------------------------------------------- </line> + <line>\chapter{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="figure" text=""> + <line> </line> + <line>% figure ------------------------------------------------------ </line> + <line>\begin{figure}[hbt] </line> + <line>\begin{center}% </line> + <line>\hypertarget{%id}{}% </line> + </mapping> + + + <mapping key="keywordset" text=""> + <line> </line> + <line>% keywords ------------------------------------------------------ </line> + <line>\begin{keywords} </line> + </mapping> + + <mapping key="table" text=""> + <line> </line> + <line>% table ------------------------------------------------------ </line> + <line>\begin{table}[hbt] </line> + <line>\begin{center}% </line> + <line>\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="informaltable" text=""> + <line> </line> + <line>% tabular ------------------------------------------------------ </line> + <line>\begin{center} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="equation" text=""> + <line> \begin{dbequation} </line> + <line>\begin{center} </line> + </mapping> + + <mapping key="glossary" text=""> + <line>% ------------------------------------------------------------- </line> + <line>% </line> + <line>% GLOSSARY %title </line> + <line>% </line> + <line>% ------------------------------------------------------------- </line> + <line>\dbglossary{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="glossdiv" text=""> + <line>% </line> + <line>% ------------------------------------------------------------- </line> + <line>\dbglossdiv{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + <line>\noindent% </line> + <line>\begin{description}% </line> + </mapping> + + <mapping key="part" text=""> + <line>% ------------------------------------------------------------- </line> + <line>% </line> + <line>% PART %title </line> + <line>% </line> + <line>% ------------------------------------------------------------- </line> + <line>\part{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="refentry" text=""> + <line>% </line> + <line>% ------------------------------------------------------------- </line> + <line>% Refentry </line> + <line>% ------------------------------------------------------------- </line> + <line>\section*{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="reference" text=""> + <line>% </line> + <line>% ------------------------------------------------------------- </line> + <line>% Reference </line> + <line>% ------------------------------------------------------------- </line> + <line>\chapter*{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="revhistory" text=""> + <line> </line> + <line>% ------------------------ </line> + <line>% RevHistory </line> + <line>% ------------------------ </line> + <line>\pagebreak </line> + <line>\section*{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + <line>\begin{center} </line> + <line>\begin{tt} </line> + <line>\begin{tabular}{|l||l|l|} \hline </line> + </mapping> + + <mapping key="example" text=" \begin{example}% "/> + + <mapping key="programlisting" text=" \begin{program}% "/> + + <mapping key="sect1" text=""> + <line> </line> + <line>% ------------------------ </line> + <line>% Section </line> + <line>\section{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="sect2" text=""> + <line>\subsection{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="sect3" text=""> + <line>\subsubsection{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="sect4" text=""> + <line>\subparagraph*{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="sect5" text=""> + <line>\subparagraph*{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="sect6" text=""> + <line>\subparagraph*{%title} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="formalpara" text=""> + <line>\subsubsection*{\small{%title}} </line> + <line>\label{%id}\hypertarget{%id}{}% </line> + </mapping> + + <mapping key="refentry" text=" \section*{%title} \label{%id} "/> + <mapping key="refsect1" text=" \subsection*{%title} \label{%id} "/> + <mapping key="refsect2" text=" \subsubsection*{%title} \label{%id} "/> + <mapping key="refsect3" text=" \paragraph*{%title} \label{%id} "/> + + </latexmapping> + + + + <!-- LaTeX mapping, role, END --> + + <latexmapping role="end"> + + <mapping key="abstract" text=""> + <line>\end{abstract} </line> + <line> </line> + </mapping> + + <mapping key="admonition" text=""> + <line>\end{admonition} </line> + <line> </line> + </mapping> + + <mapping key="book" text=""> + <line> </line> + <line>\end{document} </line> + <line> </line> + </mapping> + + <mapping key="chapter" text=""/> + + <mapping key="example" text=""> + <line>\label{%id}\hypertarget{%id}{}% </line> + <line>\end{example} </line> + <line> </line> + </mapping> + + <mapping key="figure" text=""> + <line>\label{%id} </line> + <line>\end{center} </line> + <line>\end{figure} </line> + <line> </line> + </mapping> + <mapping key="equation" text=""> + <line>\label{%id}\hypertarget{%id}{}% </line> + <line>\end{center} </line> + <line>\end{dbequation} </line> + <line> </line> + </mapping> + + <mapping key="glossary" text=""> + </mapping> + + <mapping key="glossdiv" text=""> + <line>\end{description}% </line> + </mapping> + + + <mapping key="keywordset" text=""> + <line>\end{keywords} </line> + </mapping> + + <mapping key="part" text=""> + </mapping> + + <mapping key="table" text=""> + <line>\label{%id} </line> + <line>\end{center} </line> + <line>\end{table} </line> + <line> </line> + </mapping> + + <mapping key="informaltable" text=""> + <line>\end{center} </line> + <line> </line> + </mapping> + + <mapping key="programlisting" text=""> + <line>\label{%id}\hypertarget{%id}{}% </line> + <line>\end{center} </line> + <line>\end{program} </line> + <line> </line> + </mapping> + + <mapping key="revhistory" text=""> + <line>\end{tabular} </line> + <line>\end{tt} </line> + <line>\end{center} </line> + <line>% ------------------------ </line> + <line>% End RevHistory </line> + <line>% ------------------------ </line> + </mapping> + </latexmapping> + + <latexmapping role="entities"> + <mapping key="∞" text=" \infty "/> + </latexmapping> + +</latexbindings> diff --git a/docs/docbook/xslt/db2latex/latex.mapping.xsl b/docs/docbook/xslt/db2latex/latex.mapping.xsl new file mode 100644 index 0000000000..5e11f9de3c --- /dev/null +++ b/docs/docbook/xslt/db2latex/latex.mapping.xsl @@ -0,0 +1,177 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: latex.mapping.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + <xsl:variable name="latex.mapping.xml" select="document('latex.mapping.xml')"/> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="glossary" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: latex.mapping.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <author> + <firstname>Ramon</firstname><surname>Casellas</surname> + </author> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>The DB2LaTeX mapping system <filename>latex.mapping.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para>The DB2LaTeX mapping system centralizes mapping docbook tags (e.g. <sgmltag>chapter</sgmltag>) + to LaTeX commands <literal>\chapter</literal>. It used an auxiliary file, <filename>latex.mapping.xml</filename> + that defines how the mapping is to be done.</para> + </section> + </partintro> + </doc:reference> + <!--############################################################################# --> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template name="latex.mapping" xmlns=""> + <refpurpose></refpurpose> + <refdescription> + <para></para> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + </itemizedlist> + </formalpara> + <formalpara><title>Default Behaviour</title> + <screen></screen> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + + + <xsl:template name="latex.mapping"> + <xsl:param name="object" select="."/> + <xsl:param name="keyword" select="local-name($object)"/> + <xsl:param name="role" select="begin"/> + <xsl:param name="string"> + <xsl:call-template name="extract.object.title"> + <xsl:with-param name="object" select="$object"/> + </xsl:call-template> + </xsl:param> + <xsl:param name="use.label" select="1"/> + <xsl:param name="use.hypertarget" select="1"/> + <xsl:variable name="id"> + <xsl:choose> + <xsl:when test="$object/@id"> <xsl:value-of select="$object/@id"/> </xsl:when> + <xsl:otherwise> <xsl:value-of select="generate-id($object)"/> </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="title"> + <xsl:choose> + <xsl:when test="$string=''"> + <xsl:call-template name="gentext.element.name"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="normalize-space($string)"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="latex.mapping.node" + select="($latex.mapping.xml/latexbindings/latexmapping[@role=$role]/mapping[@key=$keyword])"/> + <xsl:choose> + <xsl:when test="$latex.mapping.node/@text!=''"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to"><xsl:value-of select="$id"/></xsl:with-param> + <xsl:with-param name="from">%id</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to"><xsl:value-of select="$title"/></xsl:with-param> + <xsl:with-param name="from">%title</xsl:with-param> + <xsl:with-param name="string"> + <xsl:value-of select="$latex.mapping.node/@text"/> + </xsl:with-param> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:for-each select="$latex.mapping.node/line"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to"><xsl:value-of select="$id"/></xsl:with-param> + <xsl:with-param name="from">%id</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to"><xsl:value-of select="$title"/></xsl:with-param> + <xsl:with-param name="from">%title</xsl:with-param> + <xsl:with-param name="string" select="."/> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:for-each> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + + <xsl:template name="map.begin"> + <xsl:param name="object" select="."/> + <xsl:param name="keyword" select="local-name($object)"/> + <xsl:param name="string"> + <xsl:call-template name="extract.object.title"> + <xsl:with-param name="object" select="$object"/> + </xsl:call-template> + </xsl:param> + <xsl:call-template name="latex.mapping"> + <xsl:with-param name="keyword" select="$keyword"/> + <xsl:with-param name="role">begin</xsl:with-param> + <xsl:with-param name="string" select="$string"/> + </xsl:call-template> + </xsl:template> + + <xsl:template name="map.end"> + <xsl:param name="object" select="."/> + <xsl:param name="keyword" select="local-name($object)"/> + <xsl:param name="role" select="begin"/> + <xsl:param name="string"> + <xsl:call-template name="extract.object.title"> + <xsl:with-param name="object" select="$object"/> + </xsl:call-template> + </xsl:param> + <xsl:call-template name="latex.mapping"> + <xsl:with-param name="keyword" select="$keyword"/> + <xsl:with-param name="string" select="$string"/> + <xsl:with-param name="role">end</xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template match="title" mode="latex"><xsl:apply-templates/></xsl:template> + + <xsl:template name="extract.object.title"> + <xsl:param name="object" select="."/> + <xsl:choose> + <xsl:when test="$latex.apply.title.templates='1'"> + <xsl:apply-templates select="$object/title" mode="latex"/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="$object/title"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/lists.mod.xsl b/docs/docbook/xslt/db2latex/lists.mod.xsl new file mode 100644 index 0000000000..29afd0f58d --- /dev/null +++ b/docs/docbook/xslt/db2latex/lists.mod.xsl @@ -0,0 +1,455 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: lists.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="lists" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: lists.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Lists <filename>lists.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + <xsl:template match="variablelist/title| orderedlist/title | itemizedlist/title | simplelist/title"> + <xsl:text> {\sc </xsl:text> + <xsl:apply-templates/> + <xsl:text>} </xsl:text> + </xsl:template> + + + <xsl:template match="itemizedlist"> + <xsl:if test="title"> <xsl:apply-templates select="title"/></xsl:if> + <xsl:text> \begin{itemize} </xsl:text> + <xsl:apply-templates select="listitem"/> + <xsl:text> \end{itemize} </xsl:text> + </xsl:template> + + + <xsl:template match="orderedlist"> + <xsl:variable name="numeration"> + <xsl:choose> + <xsl:when test="@numeration"> + <xsl:value-of select="@numeration"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="arabic"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:if test="title"> <xsl:apply-templates select="title"/></xsl:if> + <xsl:text> \begin{enumerate}</xsl:text> + <xsl:if test="@numeration"> + <xsl:choose> + <xsl:when test="@numeration='arabic'"> <xsl:text>[1]</xsl:text> </xsl:when> + <xsl:when test="@numeration='upperalpha'"><xsl:text>[A]</xsl:text> </xsl:when> + <xsl:when test="@numeration='loweralpha'"><xsl:text>[a]</xsl:text> </xsl:when> + <xsl:when test="@numeration='upperroman'"><xsl:text>[I]</xsl:text> </xsl:when> + <xsl:when test="@numeration='lowerroman'"><xsl:text>[i]</xsl:text> </xsl:when> + </xsl:choose> + </xsl:if> + <xsl:apply-templates select="listitem"/> + \end{enumerate} + </xsl:template> + + + + <xsl:template match="variablelist"> + <xsl:if test="title"> + <xsl:apply-templates select="title"/> + </xsl:if> + <xsl:text> \noindent </xsl:text> + <xsl:text> \begin{description} </xsl:text> + <xsl:apply-templates select="varlistentry"/> + <xsl:text> \end{description} </xsl:text> + </xsl:template> + + + <xsl:template match="listitem"> + <xsl:text> %--- Item </xsl:text> + <xsl:text>\item </xsl:text> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + </xsl:template> + + + <xsl:template match="varlistentry"> + <xsl:variable name="id"> + <xsl:call-template name="label.id"/> + </xsl:variable> + <xsl:text>\item[</xsl:text><xsl:apply-templates select="term"/><xsl:text>]\mbox{} % mbox is a trick to induce different typesetting decisions</xsl:text> + <xsl:apply-templates select="listitem"/> + </xsl:template> + + + <xsl:template match="varlistentry/term"> + <xsl:apply-templates/><xsl:text>, </xsl:text> + </xsl:template> + + <xsl:template match="varlistentry/term[position()=last()]"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="varlistentry/listitem"> + <xsl:apply-templates/> + </xsl:template> + + + <xsl:template name="tabular.string"> + <xsl:param name="cols" select="1"/> + <xsl:param name="i" select="1"/> + <xsl:choose> + <xsl:when test="$i > $cols"></xsl:when> + <xsl:otherwise> + <xsl:text>l</xsl:text> + <xsl:call-template name="tabular.string"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <!--========================================================================== + | Inline simplelist. It is rendered as a list of comma separated values. + | We make the difference between the last member and the rest. XSL easily + | allows this. + +============================================================================--> + + <xsl:template match="simplelist[@type='inline']"> + <xsl:apply-templates/> + </xsl:template> + <xsl:template match="simplelist[@type='inline']/member"> + <xsl:apply-templates/> + <xsl:text>, </xsl:text> + </xsl:template> + <xsl:template match="simplelist[@type='inline']/member[position()=last()]"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="simplelist[@type='horiz']"> + <xsl:variable name="cols"> + <xsl:choose> + <xsl:when test="@columns"> + <xsl:value-of select="@columns"/> + </xsl:when> + <xsl:otherwise>1</xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:text> </xsl:text> + <xsl:text>\begin{tabular*}{\linewidth}{</xsl:text> + <xsl:call-template name="tabular.string"> + <xsl:with-param name="cols" select="$cols"/> + </xsl:call-template> + <xsl:text>} </xsl:text> + <xsl:call-template name="simplelist.horiz"> + <xsl:with-param name="cols" select="$cols"/> + </xsl:call-template> + <xsl:text> \end{tabular*} </xsl:text> + </xsl:template> + + + + + <xsl:template name="simplelist.horiz"> + <xsl:param name="cols">1</xsl:param> + <xsl:param name="cell">1</xsl:param> + <xsl:param name="members" select="./member"/> + <xsl:if test="$cell <= count($members)"> + <xsl:text> </xsl:text> + <xsl:call-template name="simplelist.horiz.row"> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="cell" select="$cell"/> + <xsl:with-param name="members" select="$members"/> + </xsl:call-template> + <xsl:text> \\</xsl:text> + <xsl:call-template name="simplelist.horiz"> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="cell" select="$cell + $cols"/> + <xsl:with-param name="members" select="$members"/> + </xsl:call-template> + </xsl:if> + </xsl:template> + + <xsl:template name="simplelist.horiz.row"> + <xsl:param name="cols">1</xsl:param> + <xsl:param name="cell">1</xsl:param> + <xsl:param name="members" select="./member"/> + <xsl:param name="curcol">1</xsl:param> + <xsl:if test="$curcol <= $cols"> + <xsl:choose> + <xsl:when test="$members[position()=$cell]"> + <xsl:apply-templates select="$members[position()=$cell]"/> + <xsl:text> </xsl:text> + <xsl:if test="$curcol < $cols"> + <xsl:call-template name="generate.latex.cell.separator"/> + </xsl:if> + </xsl:when> + </xsl:choose> + <xsl:call-template name="simplelist.horiz.row"> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="cell" select="$cell+1"/> + <xsl:with-param name="members" select="$members"/> + <xsl:with-param name="curcol" select="$curcol+1"/> + </xsl:call-template> + </xsl:if> + </xsl:template> + + + + + + + + + + + + <xsl:template match="simplelist|simplelist[@type='vert']"> + <xsl:variable name="cols"> + <xsl:choose> + <xsl:when test="@columns"> + <xsl:value-of select="@columns"/> + </xsl:when> + <xsl:otherwise>1</xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:text> </xsl:text> + <!--<xsl:text>\vspace{1cm} </xsl:text>--> + <xsl:text>\begin{tabular*}{\linewidth}{</xsl:text> + <xsl:call-template name="tabular.string"> + <xsl:with-param name="i" select="1"/> + <xsl:with-param name="cols" select="$cols"/> + </xsl:call-template> + <xsl:text>}</xsl:text> + <xsl:call-template name="simplelist.vert"> + <xsl:with-param name="cols" select="$cols"/> + </xsl:call-template> + <xsl:text> \end{tabular*} </xsl:text> + <!--<xsl:text>\vspace{1cm} </xsl:text>--> + </xsl:template> + + + + <xsl:template name="simplelist.vert"> + <xsl:param name="cols">1</xsl:param> + <xsl:param name="cell">1</xsl:param> + <xsl:param name="members" select="./member"/> + <xsl:param name="rows" select="floor((count($members)+$cols - 1) div $cols)"/> + <xsl:if test="$cell <= $rows"> + <xsl:text> </xsl:text> + <xsl:call-template name="simplelist.vert.row"> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="rows" select="$rows"/> + <xsl:with-param name="cell" select="$cell"/> + <xsl:with-param name="members" select="$members"/> + </xsl:call-template> + <xsl:text> \\</xsl:text> + <xsl:call-template name="simplelist.vert"> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="cell" select="$cell+1"/> + <xsl:with-param name="members" select="$members"/> + <xsl:with-param name="rows" select="$rows"/> + </xsl:call-template> + </xsl:if> + </xsl:template> + + + + <xsl:template name="simplelist.vert.row"> + <xsl:param name="cols">1</xsl:param> + <xsl:param name="rows">1</xsl:param> + <xsl:param name="cell">1</xsl:param> + <xsl:param name="members" select="./member"/> + <xsl:param name="curcol">1</xsl:param> + <xsl:if test="$curcol <= $cols"> + <xsl:choose> + <xsl:when test="$members[position()=$cell]"> + <xsl:apply-templates select="$members[position()=$cell]"/> + <xsl:text> </xsl:text> + <xsl:if test="$curcol < $cols"> + <xsl:call-template name="generate.latex.cell.separator"/> + </xsl:if> + </xsl:when> + <xsl:otherwise> + </xsl:otherwise> + </xsl:choose> + <xsl:call-template name="simplelist.vert.row"> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="rows" select="$rows"/> + <xsl:with-param name="cell" select="$cell+$rows"/> + <xsl:with-param name="members" select="$members"/> + <xsl:with-param name="curcol" select="$curcol+1"/> + </xsl:call-template> + </xsl:if> + </xsl:template> + + + <xsl:template match="member"> + <xsl:apply-templates/> + </xsl:template> + + + + + <xsl:template match="segmentedlist"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="segmentedlist/title"> + <xsl:text> {\sc </xsl:text> + <xsl:apply-templates/> + <xsl:text>} \\ </xsl:text> + </xsl:template> + + <xsl:template match="segtitle"> + </xsl:template> + + <xsl:template match="segtitle" mode="segtitle-in-seg"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="seglistitem"> + <xsl:apply-templates/> + <xsl:choose> + <xsl:when test="position()=last()"><xsl:text> </xsl:text></xsl:when> + <xsl:otherwise><xsl:text> \\ </xsl:text></xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + + <xsl:template match="seg"> + <xsl:variable name="segnum" select="position()"/> + <xsl:variable name="seglist" select="ancestor::segmentedlist"/> + <xsl:variable name="segtitles" select="$seglist/segtitle"/> + + <!-- + Note: segtitle is only going to be the right thing in a well formed + SegmentedList. If there are too many Segs or too few SegTitles, + you'll get something odd...maybe an error + --> + + <xsl:text>{ \em </xsl:text> + <xsl:apply-templates select="$segtitles[$segnum=position()]" mode="segtitle-in-seg"/> + <xsl:text>:} </xsl:text> + <xsl:apply-templates/> + </xsl:template> + + + + + + + + + + + <!-- ==================================================================== --> + + <xsl:template match="calloutlist"> + <xsl:if test="./title"> + <xsl:apply-templates select="./title" mode="calloutlist.title.mode"/> + </xsl:if> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="calloutlist/title"> + </xsl:template> + + <xsl:template match="calloutlist/title" mode="calloutlist.title.mode"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="callout"> + <dt> + <xsl:call-template name="callout.arearefs"> + <xsl:with-param name="arearefs" select="@arearefs"/> + </xsl:call-template> + </dt> + <dl><xsl:apply-templates/></dl> + </xsl:template> + + <xsl:template name="callout.arearefs"> + <xsl:param name="arearefs"></xsl:param> + <xsl:if test="$arearefs!=''"> + <xsl:choose> + <xsl:when test="substring-before($arearefs,' ')=''"> + <xsl:call-template name="callout.arearef"> + <xsl:with-param name="arearef" select="$arearefs"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="callout.arearef"> + <xsl:with-param name="arearef" + select="substring-before($arearefs,' ')"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + <xsl:call-template name="callout.arearefs"> + <xsl:with-param name="arearefs" + select="substring-after($arearefs,' ')"/> + </xsl:call-template> + </xsl:if> + </xsl:template> + + + + + + <xsl:template name="callout.arearef"> + <xsl:param name="arearef"></xsl:param> + <xsl:variable name="targets" select="//node()[@id=$arearef]"/> + <xsl:variable name="target" select="$targets[1]"/> + <xsl:choose> + <xsl:when test="count($target)=0"> + <xsl:value-of select="$arearef"/> + <xsl:text>callout ???</xsl:text> + </xsl:when> + <xsl:when test="local-name($target)='co'"> + <!-- FIXME --> + <xsl:text>\href{ </xsl:text> + <xsl:value-of select="$target/@id"/> + <xsl:text>}{</xsl:text> + <xsl:value-of select="$target/@id"/><xsl:text>} </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>callout ???</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/mathelem.mod.xsl b/docs/docbook/xslt/db2latex/mathelem.mod.xsl new file mode 100644 index 0000000000..66e7089413 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathelem.mod.xsl @@ -0,0 +1,225 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: mathelem.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: Math Elements as theorems, lemmas, propositions, etc. +| Note: these elements are not part of the DocBook DTD. I have extended +| the docbook DTD in order to support this tags, so that's why I have these +| templates here. ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="mathelems" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: mathelem.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Math Elements <filename>mathelems.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <xsl:template match="mathelement"> + <xsl:apply-templates/> + </xsl:template> + + + <!-- + ########################################## + # + # \begin{hypothesis}[title] + # + # \end{hypothesis} + # + ########################################## + --> + <xsl:template match="mathelement/mathhypothesis"> + <xsl:text>\begin{hypothesis}[</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="title"/> + </xsl:call-template> + <xsl:text>] </xsl:text> + <xsl:variable name="id"> <xsl:call-template name="label.id"/> </xsl:variable> + <xsl:apply-templates/> + <xsl:text>\end{rem} </xsl:text> + </xsl:template> + + <!-- + ########################################## + # + # \begin{rem}[title] + # + # \end{rem} + # + ########################################## + --> + <xsl:template match="mathelement/mathremark"> + <xsl:text>\begin{rem}[</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="title"/> + </xsl:call-template> + <xsl:text>] </xsl:text> + <xsl:variable name="id"> <xsl:call-template name="label.id"/> </xsl:variable> + <xsl:apply-templates/> + <xsl:text>\end{rem} </xsl:text> + </xsl:template> + + + <!-- + ########################################## + # + # \begin{exm}[title] + # + # \end{exm} + # + ########################################## + --> + <xsl:template match="mathelement/mathexample"> + <xsl:text>\begin{exm}[</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="title"/> + </xsl:call-template> + <xsl:text>] </xsl:text> + <xsl:variable name="id"> <xsl:call-template name="label.id"/> </xsl:variable> + <xsl:apply-templates/> + <xsl:text>\end{exm} </xsl:text> + </xsl:template> + + + <!-- + ########################################## + # + # \begin{prop}[title] + # + # \end{prop} + # + ########################################## + --> + <xsl:template match="mathelement/mathproposition"> + <xsl:text>\begin{prop}[</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="title"/> + </xsl:call-template> + <xsl:text>] </xsl:text> + <xsl:variable name="id"> <xsl:call-template name="label.id"/> </xsl:variable> + <xsl:apply-templates/> + <xsl:text>\end{prop} </xsl:text> + </xsl:template> + + + <!-- + ########################################## + # + # \begin{thm}[title] + # + # \end{thm} + # + ########################################## + --> + <xsl:template match="mathelement/maththeorem"> + <xsl:text>\begin{thm}[</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="title"/> + </xsl:call-template> + <xsl:text>] </xsl:text> + <xsl:variable name="id"> <xsl:call-template name="label.id"/> </xsl:variable> + <xsl:apply-templates/> + <xsl:text>\end{thm} </xsl:text> + </xsl:template> + + + + <!-- + ########################################## + # + # \begin{defn}[definition title] + # + # \end{defn} + # + ########################################## + --> + <xsl:template match="mathelement/mathdefinition"> + <xsl:text>\begin{defn}[</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="title"/> + </xsl:call-template> + <xsl:text>] </xsl:text> + <xsl:variable name="id"> <xsl:call-template name="label.id"/> </xsl:variable> + <xsl:apply-templates/> + <xsl:text>\end{defn} </xsl:text> + </xsl:template> + + + + <!-- + ########################################## + # + # \begin{lem}[lemma title] + # + # \end{lem} + # + ########################################## + --> + <xsl:template match="mathelement/mathlemma"> + <xsl:text>\begin{lem}[</xsl:text> + <xsl:call-template name="normalize-scape"> + <xsl:with-param name="string" select="title"/> + </xsl:call-template> + <xsl:text>] </xsl:text> + <xsl:variable name="id"> <xsl:call-template name="label.id"/> </xsl:variable> + <xsl:apply-templates/> + <xsl:text>\end{lem} </xsl:text> + </xsl:template> + + + <!-- + ########################################## + # + # \begin{proof} + # + # \end{proof} + # + ########################################## + --> + <xsl:template match="mathproof"> + <xsl:text>\begin{proof}</xsl:text> + <xsl:variable name="id"> <xsl:call-template name="label.id"/> </xsl:variable> + <xsl:apply-templates/> + <xsl:text>\end{proof} </xsl:text> + </xsl:template> + + + <xsl:template match="mathphrase|mathcondition|mathassertion"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="mathelement/*/title"> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isoamsa.ent b/docs/docbook/xslt/db2latex/mathml/ent/isoamsa.ent new file mode 100644 index 0000000000..5ecf4db216 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isoamsa.ent @@ -0,0 +1,173 @@ + +<!-- + File isoamsa.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY angzarr "⍼" ><!--angle with down zig-zag arrow --> +<!ENTITY cirmid "⫯" ><!--circle, mid below --> +<!ENTITY cudarrl "⤸" ><!--left, curved, down arrow --> +<!ENTITY cudarrr "⤵" ><!--right, curved, down arrow --> +<!ENTITY cularr "↶" ><!--/curvearrowleft A: left curved arrow --> +<!ENTITY cularrp "⤽" ><!--curved left arrow with plus --> +<!ENTITY curarr "↷" ><!--/curvearrowright A: rt curved arrow --> +<!ENTITY curarrm "⤼" ><!--curved right arrow with minus --> +<!ENTITY dArr "⇓" ><!--/Downarrow A: down dbl arrow --> +<!ENTITY Darr "↡" ><!--down two-headed arrow --> +<!ENTITY ddarr "⇊" ><!--/downdownarrows A: two down arrows --> +<!ENTITY DDotrahd "⤑" ><!--right arrow with dotted stem --> +<!ENTITY dfisht "⥿" ><!--down fish tail --> +<!ENTITY dHar "⥥" ><!--down harpoon-left, down harpoon-right --> +<!ENTITY dharl "⇃" ><!--/downharpoonleft A: dn harpoon-left --> +<!ENTITY dharr "⇂" ><!--/downharpoonright A: down harpoon-rt --> +<!ENTITY duarr "⇵" ><!--down arrow, up arrow --> +<!ENTITY duhar "⥯" ><!--down harp, up harp --> +<!ENTITY dzigrarr "⇝" ><!--right long zig-zag arrow --> +<!ENTITY erarr "⥱" ><!--equal, right arrow below --> +<!ENTITY harr "↔" ><!--/leftrightarrow A: l&r arrow --> +<!ENTITY hArr "⇔" ><!--/Leftrightarrow A: l&r dbl arrow --> +<!ENTITY harrcir "⥈" ><!--left and right arrow with a circle --> +<!ENTITY harrw "↭" ><!--/leftrightsquigarrow A: l&r arr-wavy --> +<!ENTITY hoarr "⇿" ><!--horizontal open arrow --> +<!ENTITY imof "⊷" ><!--image of --> +<!ENTITY lAarr "⇚" ><!--/Lleftarrow A: left triple arrow --> +<!ENTITY Larr "↞" ><!--/twoheadleftarrow A: --> +<!ENTITY larrbfs "⤟" ><!--left arrow-bar, filled square --> +<!ENTITY larrfs "⤝" ><!--left arrow, filled square --> +<!ENTITY larrhk "↩" ><!--/hookleftarrow A: left arrow-hooked --> +<!ENTITY larrlp "↫" ><!--/looparrowleft A: left arrow-looped --> +<!ENTITY larrpl "⤹" ><!--left arrow, plus --> +<!ENTITY larrsim "⥳" ><!--left arrow, similar --> +<!ENTITY larrtl "↢" ><!--/leftarrowtail A: left arrow-tailed --> +<!ENTITY latail "⤙" ><!--left arrow-tail --> +<!ENTITY lAtail "⤛" ><!--left double arrow-tail --> +<!ENTITY lbarr "⤌" ><!--left broken arrow --> +<!ENTITY lBarr "⤎" ><!--left doubly broken arrow --> +<!ENTITY ldca "⤶" ><!--left down curved arrow --> +<!ENTITY ldrdhar "⥧" ><!--left harpoon-down over right harpoon-down --> +<!ENTITY ldrushar "⥋" ><!--left-down-right-up harpoon --> +<!ENTITY ldsh "↲" ><!--left down angled arrow --> +<!ENTITY lfisht "⥼" ><!--left fish tail --> +<!ENTITY lHar "⥢" ><!--left harpoon-up over left harpoon-down --> +<!ENTITY lhard "↽" ><!--/leftharpoondown A: l harpoon-down --> +<!ENTITY lharu "↼" ><!--/leftharpoonup A: left harpoon-up --> +<!ENTITY lharul "⥪" ><!--left harpoon-up over long dash --> +<!ENTITY llarr "⇇" ><!--/leftleftarrows A: two left arrows --> +<!ENTITY llhard "⥫" ><!--left harpoon-down below long dash --> +<!ENTITY loarr "⇽" ><!--left open arrow --> +<!ENTITY lrarr "⇆" ><!--/leftrightarrows A: l arr over r arr --> +<!ENTITY lrhar "⇋" ><!--/leftrightharpoons A: l harp over r --> +<!ENTITY lrhard "⥭" ><!--right harpoon-down below long dash --> +<!ENTITY lsh "↰" ><!--/Lsh A: --> +<!ENTITY lurdshar "⥊" ><!--left-up-right-down harpoon --> +<!ENTITY luruhar "⥦" ><!--left harpoon-up over right harpoon-up --> +<!ENTITY map "↦" ><!--/mapsto A: --> +<!ENTITY Map "⤅" ><!--twoheaded mapsto --> +<!ENTITY midcir "⫰" ><!--mid, circle below --> +<!ENTITY mumap "⊸" ><!--/multimap A: --> +<!ENTITY nearhk "⤤" ><!--NE arrow-hooked --> +<!ENTITY nearr "↗" ><!--/nearrow A: NE pointing arrow --> +<!ENTITY neArr "⇗" ><!--NE pointing dbl arrow --> +<!ENTITY nesear "⤨" ><!--/toea A: NE & SE arrows --> +<!ENTITY nharr "↮" ><!--/nleftrightarrow A: not l&r arrow --> +<!ENTITY nhArr "⇎" ><!--/nLeftrightarrow A: not l&r dbl arr --> +<!ENTITY nlarr "↚" ><!--/nleftarrow A: not left arrow --> +<!ENTITY nlArr "⇍" ><!--/nLeftarrow A: not implied by --> +<!ENTITY nrarr "↛" ><!--/nrightarrow A: not right arrow --> +<!ENTITY nrArr "⇏" ><!--/nRightarrow A: not implies --> +<!ENTITY nrarrc "⤳̸" ><!--not right arrow-curved --> +<!ENTITY nrarrw "↝̸" ><!--not right arrow-wavy --> +<!ENTITY nvHarr "⇎" ><!--not, vert, left and right double arrow --> +<!ENTITY nvlArr "⇍" ><!--not, vert, left double arrow --> +<!ENTITY nvrArr "⇏" ><!--not, vert, right double arrow --> +<!ENTITY nwarhk "⤣" ><!--NW arrow-hooked --> +<!ENTITY nwarr "↖" ><!--/nwarrow A: NW pointing arrow --> +<!ENTITY nwArr "⇖" ><!--NW pointing dbl arrow --> +<!ENTITY nwnear "⤧" ><!--NW & NE arrows --> +<!ENTITY olarr "↺" ><!--/circlearrowleft A: l arr in circle --> +<!ENTITY orarr "↻" ><!--/circlearrowright A: r arr in circle --> +<!ENTITY origof "⊶" ><!--original of --> +<!ENTITY rAarr "⇛" ><!--/Rrightarrow A: right triple arrow --> +<!ENTITY Rarr "↠" ><!--/twoheadrightarrow A: --> +<!ENTITY rarrap "⥵" ><!--approximate, right arrow above --> +<!ENTITY rarrbfs "⤠" ><!--right arrow-bar, filled square --> +<!ENTITY rarrc "⤳" ><!--right arrow-curved --> +<!ENTITY rarrfs "⤞" ><!--right arrow, filled square --> +<!ENTITY rarrhk "↪" ><!--/hookrightarrow A: rt arrow-hooked --> +<!ENTITY rarrlp "↬" ><!--/looparrowright A: rt arrow-looped --> +<!ENTITY rarrpl "⥅" ><!--right arrow, plus --> +<!ENTITY rarrsim "⥴" ><!--right arrow, similar --> +<!ENTITY rarrtl "↣" ><!--/rightarrowtail A: rt arrow-tailed --> +<!ENTITY Rarrtl "⤖" ><!--right two-headed arrow with tail --> +<!ENTITY rarrw "⇝" ><!--/rightsquigarrow A: rt arrow-wavy --> +<!ENTITY ratail "↣" ><!--right arrow-tail --> +<!ENTITY rAtail "⤜" ><!--right double arrow-tail --> +<!ENTITY rbarr "⤍" ><!--/bkarow A: right broken arrow --> +<!ENTITY rBarr "⤏" ><!--/dbkarow A: right doubly broken arrow --> +<!ENTITY RBarr "⤐" ><!--/drbkarow A: twoheaded right broken arrow --> +<!ENTITY rdca "⤷" ><!--right down curved arrow --> +<!ENTITY rdldhar "⥩" ><!--right harpoon-down over left harpoon-down --> +<!ENTITY rdsh "↳" ><!--right down angled arrow --> +<!ENTITY rfisht "⥽" ><!--right fish tail --> +<!ENTITY rHar "⥤" ><!--right harpoon-up over right harpoon-down --> +<!ENTITY rhard "⇁" ><!--/rightharpoondown A: rt harpoon-down --> +<!ENTITY rharu "⇀" ><!--/rightharpoonup A: rt harpoon-up --> +<!ENTITY rharul "⥬" ><!--right harpoon-up over long dash --> +<!ENTITY rlarr "⇄" ><!--/rightleftarrows A: r arr over l arr --> +<!ENTITY rlhar "⇌" ><!--/rightleftharpoons A: r harp over l --> +<!ENTITY roarr "⇾" ><!--right open arrow --> +<!ENTITY rrarr "⇉" ><!--/rightrightarrows A: two rt arrows --> +<!ENTITY rsh "↱" ><!--/Rsh A: --> +<!ENTITY ruluhar "⥨" ><!--right harpoon-up over left harpoon-up --> +<!ENTITY searhk "⤥" ><!--/hksearow A: SE arrow-hooken --> +<!ENTITY searr "↘" ><!--/searrow A: SE pointing arrow --> +<!ENTITY seArr "⇘" ><!--SE pointing dbl arrow --> +<!ENTITY seswar "⤩" ><!--/tosa A: SE & SW arrows --> +<!ENTITY simrarr "⥲" ><!--similar, right arrow below --> +<!ENTITY slarr "←⁣" ><!--short left arrow --> +<!ENTITY srarr "→⁣" ><!--short right arrow --> +<!ENTITY swarhk "⤦" ><!--/hkswarow A: SW arrow-hooked --> +<!ENTITY swarr "↙" ><!--/swarrow A: SW pointing arrow --> +<!ENTITY swArr "⇙" ><!--SW pointing dbl arrow --> +<!ENTITY swnwar "⤪" ><!--SW & NW arrows --> +<!ENTITY uArr "⇑" ><!--/Uparrow A: up dbl arrow --> +<!ENTITY Uarr "↟" ><!--up two-headed arrow --> +<!ENTITY Uarrocir "⥉" ><!--up two-headed arrow above circle --> +<!ENTITY udarr "⇅" ><!--up arrow, down arrow --> +<!ENTITY udhar "⥮" ><!--up harp, down harp --> +<!ENTITY ufisht "⥾" ><!--up fish tail --> +<!ENTITY uHar "⥣" ><!--up harpoon-left, up harpoon-right --> +<!ENTITY uharl "↿" ><!--/upharpoonleft A: up harpoon-left --> +<!ENTITY uharr "↾" ><!--/upharpoonright /restriction A: up harp-r --> +<!ENTITY uuarr "⇈" ><!--/upuparrows A: two up arrows --> +<!ENTITY varr "↕" ><!--/updownarrow A: up&down arrow --> +<!ENTITY vArr "⇕" ><!--/Updownarrow A: up&down dbl arrow --> +<!ENTITY xharr "↔" ><!--/longleftrightarrow A: long l&r arr --> +<!ENTITY xhArr "⇔" ><!--/Longleftrightarrow A: long l&r dbl arr --> +<!ENTITY xlarr "←" ><!--/longleftarrow A: long left arrow --> +<!ENTITY xlArr "⇐" ><!--/Longleftarrow A: long l dbl arrow --> +<!ENTITY xmap "↦" ><!--/longmapsto A: --> +<!ENTITY xrarr "→" ><!--/longrightarrow A: long right arrow --> +<!ENTITY xrArr "⇒" ><!--/Longrightarrow A: long rt dbl arr --> +<!ENTITY zigrarr "⇝" ><!--right zig-zag arrow --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isoamsb.ent b/docs/docbook/xslt/db2latex/mathml/ent/isoamsb.ent new file mode 100644 index 0000000000..08e646c2bd --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isoamsb.ent @@ -0,0 +1,146 @@ + +<!-- + File isoamsb.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY ac "⤏" ><!--most positive --> +<!ENTITY acE "⧛" ><!--most positive, two lines below --> +<!ENTITY amalg "⨿" ><!--/amalg B: amalgamation or coproduct --> +<!ENTITY barvee "⊽" ><!--bar, vee --> +<!ENTITY barwed "⊼" ><!--/barwedge B: logical and, bar above --> +<!ENTITY Barwed "⌆" ><!--/doublebarwedge B: log and, dbl bar above --> +<!ENTITY bsolb "⧅" ><!--reverse solidus in square --> +<!ENTITY Cap "⋒" ><!--/Cap /doublecap B: dbl intersection --> +<!ENTITY capand "⩄" ><!--intersection, and --> +<!ENTITY capbrcup "⩉" ><!--intersection, bar, union --> +<!ENTITY capcap "⩋" ><!--intersection, intersection, joined --> +<!ENTITY capcup "⩇" ><!--intersection above union --> +<!ENTITY capdot "⩀" ><!--intersection, with dot --> +<!ENTITY caps "∩⁣" ><!--intersection, serifs --> +<!ENTITY ccaps "⩍" ><!--closed intersection, serifs --> +<!ENTITY ccups "⩌" ><!--closed union, serifs --> +<!ENTITY ccupssm "⩐" ><!--closed union, serifs, smash product --> +<!ENTITY coprod "∐" ><!--/coprod L: coproduct operator --> +<!ENTITY Cup "⋓" ><!--/Cup /doublecup B: dbl union --> +<!ENTITY cupbrcap "⩈" ><!--union, bar, intersection --> +<!ENTITY cupcap "⩆" ><!--union above intersection --> +<!ENTITY cupcup "⩊" ><!--union, union, joined --> +<!ENTITY cupdot "⊍" ><!--union, with dot --> +<!ENTITY cupor "⩅" ><!--union, or --> +<!ENTITY cups "∪⁣" ><!--union, serifs --> +<!ENTITY cuvee "⋎" ><!--/curlyvee B: curly logical or --> +<!ENTITY cuwed "⋏" ><!--/curlywedge B: curly logical and --> +<!ENTITY dagger "†" ><!--/dagger B: dagger relation --> +<!ENTITY Dagger "‡" ><!--/ddagger B: double dagger relation --> +<!ENTITY diam "⋄" ><!--/diamond B: open diamond --> +<!ENTITY divonx "⋇" ><!--/divideontimes B: division on times --> +<!ENTITY eplus "⩱" ><!--equal, plus --> +<!ENTITY hercon "⊹" ><!--hermitian conjugate matrix --> +<!ENTITY intcal "⊺" ><!--/intercal B: intercal --> +<!ENTITY iprod "⨼" ><!--/intprod --> +<!ENTITY loplus "⨭" ><!--plus sign in left half circle --> +<!ENTITY lotimes "⨴" ><!--multiply sign in left half circle --> +<!ENTITY lthree "⋋" ><!--/leftthreetimes B: --> +<!ENTITY ltimes "⋉" ><!--/ltimes B: times sign, left closed --> +<!ENTITY midast "*" ><!--/ast B: asterisk --> +<!ENTITY minusb "⊟" ><!--/boxminus B: minus sign in box --> +<!ENTITY minusd "∸" ><!--/dotminus B: minus sign, dot above --> +<!ENTITY minusdu "⨪" ><!--minus sign, dot below --> +<!ENTITY ncap "⩃" ><!--bar, intersection --> +<!ENTITY ncup "⩂" ><!--bar, union --> +<!ENTITY oast "⊛" ><!--/circledast B: asterisk in circle --> +<!ENTITY ocir "⊚" ><!--/circledcirc B: small circle in circle --> +<!ENTITY odash "⊝" ><!--/circleddash B: hyphen in circle --> +<!ENTITY odiv "⨸" ><!--divide in circle --> +<!ENTITY odot "⊙" ><!--/odot B: middle dot in circle --> +<!ENTITY odsold "⦼" ><!--dot, solidus, dot in circle --> +<!ENTITY ofcir "⦿" ><!--filled circle in circle --> +<!ENTITY ogt "⧁" ><!--greater-than in circle --> +<!ENTITY ohbar "⦵" ><!--circle with horizontal bar --> +<!ENTITY olcir "⦾" ><!--large circle in circle --> +<!ENTITY olt "⧀" ><!--less-than in circle --> +<!ENTITY omid "⦶" ><!--vertical bar in circle --> +<!ENTITY ominus "⊖" ><!--/ominus B: minus sign in circle --> +<!ENTITY opar "⦷" ><!--parallel in circle --> +<!ENTITY operp "⦹" ><!--perpendicular in circle --> +<!ENTITY oplus "⊕" ><!--/oplus B: plus sign in circle --> +<!ENTITY osol "⊘" ><!--/oslash B: solidus in circle --> +<!ENTITY otimes "⊗" ><!--/otimes B: multiply sign in circle --> +<!ENTITY Otimes "⨷" ><!--multiply sign in double circle --> +<!ENTITY otimesas "⨶" ><!--multiply sign in circle, circumflex accent --> +<!ENTITY ovbar "⌽" ><!--circle with vertical bar --> +<!ENTITY plusacir "⨣" ><!--plus, circumflex accent above --> +<!ENTITY plusb "⊞" ><!--/boxplus B: plus sign in box --> +<!ENTITY pluscir "⨢" ><!--plus, small circle above --> +<!ENTITY plusdo "∔" ><!--/dotplus B: plus sign, dot above --> +<!ENTITY plusdu "⨥" ><!--plus sign, dot below --> +<!ENTITY pluse "⩲" ><!--plus, equals --> +<!ENTITY plussim "⨦" ><!--plus, similar below --> +<!ENTITY plustwo "⨧" ><!--plus, two; Nim-addition --> +<!ENTITY prod "∏" ><!--/prod L: product operator --> +<!ENTITY race "⧚" ><!--reverse most positive, line below --> +<!ENTITY roplus "⨮" ><!--plus sign in right half circle --> +<!ENTITY rotimes "⨵" ><!--multiply sign in right half circle --> +<!ENTITY rthree "⋌" ><!--/rightthreetimes B: --> +<!ENTITY rtimes "⋊" ><!--/rtimes B: times sign, right closed --> +<!ENTITY sdot "⋅" ><!--/cdot B: small middle dot --> +<!ENTITY sdotb "⊡" ><!--/dotsquare /boxdot B: small dot in box --> +<!ENTITY setmn "∖" ><!--/setminus B: reverse solidus --> +<!ENTITY simplus "⨤" ><!--plus, similar above --> +<!ENTITY smashp "⨳" ><!--smash product --> +<!ENTITY solb "⧄" ><!--solidus in square --> +<!ENTITY sqcap "⊓" ><!--/sqcap B: square intersection --> +<!ENTITY sqcaps "⊓⁣" ><!--square intersection, serifs --> +<!ENTITY sqcup "⊔" ><!--/sqcup B: square union --> +<!ENTITY sqcups "⊔⁣" ><!--square union, serifs --> +<!ENTITY ssetmn "∖" ><!--/smallsetminus B: sm reverse solidus --> +<!ENTITY sstarf "⋆" ><!--/star B: small star, filled --> +<!ENTITY subdot "⪽" ><!--subset, with dot --> +<!ENTITY sum "∑" ><!--/sum L: summation operator --> +<!ENTITY supdot "⪾" ><!--superset, with dot --> +<!ENTITY timesb "⊠" ><!--/boxtimes B: multiply sign in box --> +<!ENTITY timesbar "⨱" ><!--multiply sign, bar below --> +<!ENTITY timesd "⨰" ><!--times, dot --> +<!ENTITY tridot "◬" ><!--dot in triangle --> +<!ENTITY triminus "⨺" ><!--minus in triangle --> +<!ENTITY triplus "⨹" ><!--plus in triangle --> +<!ENTITY trisb "⧍" ><!--triangle, serifs at bottom --> +<!ENTITY tritime "⨻" ><!--multiply in triangle --> +<!ENTITY uplus "⊎" ><!--/uplus B: plus sign in union --> +<!ENTITY veebar "⊻" ><!--/veebar B: logical or, bar below --> +<!ENTITY wedbar "⩟" ><!--wedge, bar below --> +<!ENTITY wreath "≀" ><!--/wr B: wreath product --> +<!ENTITY xcap "⋂" ><!--/bigcap L: intersection operator --> +<!ENTITY xcirc "◯" ><!--/bigcirc B: large circle --> +<!ENTITY xcup "⋃" ><!--/bigcup L: union operator --> +<!ENTITY xdtri "▽" ><!--/bigtriangledown B: big dn tri, open --> +<!ENTITY xodot "⊙" ><!--/bigodot L: circle dot operator --> +<!ENTITY xoplus "⊕" ><!--/bigoplus L: circle plus operator --> +<!ENTITY xotime "⊗" ><!--/bigotimes L: circle times operator --> +<!ENTITY xsqcup "⊔" ><!--/bigsqcup L: square union operator --> +<!ENTITY xuplus "⊎" ><!--/biguplus L: --> +<!ENTITY xutri "△" ><!--/bigtriangleup B: big up tri, open --> +<!ENTITY xvee "⋁" ><!--/bigvee L: logical and operator --> +<!ENTITY xwedge "⋀" ><!--/bigwedge L: logical or operator --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isoamsc.ent b/docs/docbook/xslt/db2latex/mathml/ent/isoamsc.ent new file mode 100644 index 0000000000..cce399cf9d --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isoamsc.ent @@ -0,0 +1,49 @@ + +<!-- + File isoamsc.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY dlcorn "⌞" ><!--/llcorner O: lower left corner --> +<!ENTITY drcorn "⌟" ><!--/lrcorner C: lower right corner --> +<!ENTITY gtlPar "⦕" ><!--dbl left parenthesis, greater --> +<!ENTITY langd "⦑" ><!--left angle, dot --> +<!ENTITY lbrke "⦋" ><!--left bracket, equal --> +<!ENTITY lbrksld "⦏" ><!--left bracket, solidus bottom corner --> +<!ENTITY lbrkslu "⦍" ><!--left bracket, solidus top corner --> +<!ENTITY lceil "⌈" ><!--/lceil O: left ceiling --> +<!ENTITY lfloor "⌊" ><!--/lfloor O: left floor --> +<!ENTITY lmoust "⦘" ><!--/lmoustache --> +<!ENTITY lparlt "⦓" ><!--O: left parenthesis, lt --> +<!ENTITY ltrPar "⦖" ><!--dbl right parenthesis, less --> +<!ENTITY rangd "⦒" ><!--right angle, dot --> +<!ENTITY rbrke "⦌" ><!--right bracket, equal --> +<!ENTITY rbrksld "⦎" ><!--right bracket, solidus bottom corner --> +<!ENTITY rbrkslu "⦐" ><!--right bracket, solidus top corner --> +<!ENTITY rceil "⌉" ><!--/rceil C: right ceiling --> +<!ENTITY rfloor "⌋" ><!--/rfloor C: right floor --> +<!ENTITY rmoust "⦗" ><!--/rmoustache --> +<!ENTITY rpargt "⦔" ><!--C: right paren, gt --> +<!ENTITY ulcorn "⌜" ><!--/ulcorner O: upper left corner --> +<!ENTITY urcorn "⌝" ><!--/urcorner C: upper right corner --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isoamsn.ent b/docs/docbook/xslt/db2latex/mathml/ent/isoamsn.ent new file mode 100644 index 0000000000..cddeba066e --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isoamsn.ent @@ -0,0 +1,117 @@ + +<!-- + File isoamsn.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY gnap "⪊" ><!--/gnapprox N: greater, not approximate --> +<!ENTITY gne "≩" ><!--/gneq N: greater, not equals --> +<!ENTITY gnE "≩" ><!--/gneqq N: greater, not dbl equals --> +<!ENTITY gnsim "⋧" ><!--/gnsim N: greater, not similar --> +<!ENTITY gvnE "≩̸" ><!--/gvertneqq N: gt, vert, not dbl eq --> +<!ENTITY lnap "⪉" ><!--/lnapprox N: less, not approximate --> +<!ENTITY lne "≨" ><!--/lneq N: less, not equals --> +<!ENTITY lnE "≨" ><!--/lneqq N: less, not double equals --> +<!ENTITY lnsim "⋦" ><!--/lnsim N: less, not similar --> +<!ENTITY lvnE "≨̸" ><!--/lvertneqq N: less, vert, not dbl eq --> +<!ENTITY nap "≉" ><!--/napprox N: not approximate --> +<!ENTITY napE "⩰̸" ><!--not approximately equal or equal to --> +<!ENTITY napid "≋̸" ><!--not approximately identical to --> +<!ENTITY ncong "≇" ><!--/ncong N: not congruent with --> +<!ENTITY ncongdot "⩭̸" ><!--not congruent, dot --> +<!ENTITY nequiv "≢" ><!--/nequiv N: not identical with --> +<!ENTITY nge "≱⃥" ><!--/ngeq N: not greater-than-or-equal --> +<!ENTITY ngE "≱" ><!--/ngeqq N: not greater, dbl equals --> +<!ENTITY nges "≱" ><!--/ngeqslant N: not gt-or-eq, slanted --> +<!ENTITY nGg "⋙̸" ><!--not triple greater than --> +<!ENTITY ngsim "≵" ><!--not greater, similar --> +<!ENTITY ngt "≯" ><!--/ngtr N: not greater-than --> +<!ENTITY nGt "≫̸" ><!--not, vert, much greater than --> +<!ENTITY nGtv "≫̸⁣" ><!--not much greater than, variant --> +<!ENTITY nle "≰⃥" ><!--/nleq N: not less-than-or-equal --> +<!ENTITY nlE "≰" ><!--/nleqq N: not less, dbl equals --> +<!ENTITY nles "≰" ><!--/nleqslant N: not less-or-eq, slant --> +<!ENTITY nLl "⋘̸" ><!--not triple less than --> +<!ENTITY nlsim "≴" ><!--not less, similar --> +<!ENTITY nlt "≮" ><!--/nless N: not less-than --> +<!ENTITY nLt "≪̸" ><!--not, vert, much less than --> +<!ENTITY nltri "⋪" ><!--/ntriangleleft N: not left triangle --> +<!ENTITY nltrie "⋬" ><!--/ntrianglelefteq N: not l tri, eq --> +<!ENTITY nLtv "≪̸⁣" ><!--not much less than, variant --> +<!ENTITY nmid "∤" ><!--/nmid --> +<!ENTITY npar "∦" ><!--/nparallel N: not parallel --> +<!ENTITY npr "⊀" ><!--/nprec N: not precedes --> +<!ENTITY nprcue "⋠" ><!--not curly precedes, eq --> +<!ENTITY npre "⪯̸" ><!--/npreceq N: not precedes, equals --> +<!ENTITY nrtri "⋫" ><!--/ntriangleright N: not rt triangle --> +<!ENTITY nrtrie "⋭" ><!--/ntrianglerighteq N: not r tri, eq --> +<!ENTITY nsc "⊁" ><!--/nsucc N: not succeeds --> +<!ENTITY nsccue "⋡" ><!--not succeeds, curly eq --> +<!ENTITY nsce "⪰̸" ><!--/nsucceq N: not succeeds, equals --> +<!ENTITY nsim "≁" ><!--/nsim N: not similar --> +<!ENTITY nsime "≄" ><!--/nsimeq N: not similar, equals --> +<!ENTITY nsmid "∤⁣" ><!--/nshortmid --> +<!ENTITY nspar "∦⁣" ><!--/nshortparallel N: not short par --> +<!ENTITY nsqsube "⋢" ><!--not, square subset, equals --> +<!ENTITY nsqsupe "⋣" ><!--not, square superset, equals --> +<!ENTITY nsub "⊄" ><!--not subset --> +<!ENTITY nsube "⊈" ><!--/nsubseteq N: not subset, equals --> +<!ENTITY nsubE "⊈" ><!--/nsubseteqq N: not subset, dbl eq --> +<!ENTITY nsup "⊅" ><!--not superset --> +<!ENTITY nsupe "⊉" ><!--/nsupseteq N: not superset, equals --> +<!ENTITY nsupE "⊉" ><!--/nsupseteqq N: not superset, dbl eq --> +<!ENTITY ntgl "≹" ><!--not greater, less --> +<!ENTITY ntlg "≸" ><!--not less, greater --> +<!ENTITY nvap "≉̸" ><!--not, vert, approximate --> +<!ENTITY nvdash "⊬" ><!--/nvdash N: not vertical, dash --> +<!ENTITY nvDash "⊭" ><!--/nvDash N: not vertical, dbl dash --> +<!ENTITY nVdash "⊮" ><!--/nVdash N: not dbl vertical, dash --> +<!ENTITY nVDash "⊯" ><!--/nVDash N: not dbl vert, dbl dash --> +<!ENTITY nvge "≱" ><!--not, vert, greater-than-or-equal --> +<!ENTITY nvgt "≯" ><!--not, vert, greater-than --> +<!ENTITY nvle "≰" ><!--not, vert, less-than-or-equal --> +<!ENTITY nvlt "≮" ><!--not, vert, less-than --> +<!ENTITY nvltrie "⋬̸" ><!--not, vert, left triangle, equals --> +<!ENTITY nvrtrie "⋭̸" ><!--not, vert, right triangle, equals --> +<!ENTITY nvsim "≁̸" ><!--not, vert, similar --> +<!ENTITY parsim "⫳" ><!--parallel, similar --> +<!ENTITY prnap "⋨" ><!--/precnapprox N: precedes, not approx --> +<!ENTITY prnE "⪵" ><!--/precneqq N: precedes, not dbl eq --> +<!ENTITY prnsim "⋨" ><!--/precnsim N: precedes, not similar --> +<!ENTITY rnmid "⫮" ><!--reverse /nmid --> +<!ENTITY scnap "⋩" ><!--/succnapprox N: succeeds, not approx --> +<!ENTITY scnE "⪶" ><!--/succneqq N: succeeds, not dbl eq --> +<!ENTITY scnsim "⋩" ><!--/succnsim N: succeeds, not similar --> +<!ENTITY simne "≆" ><!--similar, not equals --> +<!ENTITY solbar "⌿" ><!--solidus, bar through --> +<!ENTITY subne "⊊" ><!--/subsetneq N: subset, not equals --> +<!ENTITY subnE "⊊" ><!--/subsetneqq N: subset, not dbl eq --> +<!ENTITY supne "⊋" ><!--/supsetneq N: superset, not equals --> +<!ENTITY supnE "⊋" ><!--/supsetneqq N: superset, not dbl eq --> +<!ENTITY vnsub "⊄" ><!--/nsubset N: not subset, var --> +<!ENTITY vnsup "⊅" ><!--/nsupset N: not superset, var --> +<!ENTITY vsubne "⊊⁣" ><!--/varsubsetneq N: subset, not eq, var --> +<!ENTITY vsubnE "⊊⁣" ><!--/varsubsetneqq N: subset not dbl eq, var --> +<!ENTITY vsupne "⊋⁣" ><!--/varsupsetneq N: superset, not eq, var --> +<!ENTITY vsupnE "⊋⁣" ><!--/varsupsetneqq N: super not dbl eq, var --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isoamso.ent b/docs/docbook/xslt/db2latex/mathml/ent/isoamso.ent new file mode 100644 index 0000000000..8ac4bdb619 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isoamso.ent @@ -0,0 +1,77 @@ + +<!-- + File isoamso.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY ang "∠" ><!--/angle - angle --> +<!ENTITY ange "⦤" ><!--angle, equal --> +<!ENTITY angmsd "∡" ><!--/measuredangle - angle-measured --> +<!ENTITY angmsdaa "⦨" ><!--angle-measured, arrow, up, right --> +<!ENTITY angmsdab "⦩" ><!--angle-measured, arrow, up, left --> +<!ENTITY angmsdac "⦪" ><!--angle-measured, arrow, down, right --> +<!ENTITY angmsdad "⦫" ><!--angle-measured, arrow, down, left --> +<!ENTITY angmsdae "⦬" ><!--angle-measured, arrow, right, up --> +<!ENTITY angmsdaf "⦭" ><!--angle-measured, arrow, left, up --> +<!ENTITY angmsdag "⦮" ><!--angle-measured, arrow, right, down --> +<!ENTITY angmsdah "⦯" ><!--angle-measured, arrow, left, down --> +<!ENTITY angrtvb "⦝⁣" ><!--right angle-measured --> +<!ENTITY angrtvbd "⦝" ><!--right angle-measured, dot --> +<!ENTITY bbrk "⎵" ><!--bottom square bracket --> +<!ENTITY bemptyv "⦰" ><!--reversed circle, slash --> +<!ENTITY beth "ℶ" ><!--/beth - beth, Hebrew --> +<!ENTITY boxbox "⧉" ><!--two joined squares --> +<!ENTITY bprime "‵" ><!--/backprime - reverse prime --> +<!ENTITY bsemi "⁏" ><!--reverse semi-colon --> +<!ENTITY cemptyv "⦲" ><!--circle, slash, small circle above --> +<!ENTITY cirE "⧃" ><!--circle, two horizontal stroked to the right --> +<!ENTITY cirscir "⧂" ><!--circle, small circle to the right --> +<!ENTITY comp "∁" ><!--/complement - complement sign --> +<!ENTITY daleth "ℸ" ><!--/daleth - daleth, Hebrew --> +<!ENTITY demptyv "⦱" ><!--circle, slash, bar above --> +<!ENTITY ell "ℓ" ><!--/ell - cursive small l --> +<!ENTITY empty "∅⁣" ><!--/emptyset - zero, slash --> +<!ENTITY emptyv "∅" ><!--/varnothing - circle, slash --> +<!ENTITY gimel "ℷ" ><!--/gimel - gimel, Hebrew --> +<!ENTITY iiota "℩" ><!--inverted iota --> +<!ENTITY image "ℑ" ><!--/Im - imaginary --> +<!ENTITY imath "ı" ><!--/imath - small i, no dot --> +<!ENTITY jmath "j⁣" ><!--/jmath - small j, no dot --> +<!ENTITY laemptyv "⦴" ><!--circle, slash, left arrow above --> +<!ENTITY lltri "◺" ><!--lower left triangle --> +<!ENTITY lrtri "⊿" ><!--lower right triangle --> +<!ENTITY mho "℧" ><!--/mho - conductance --> +<!ENTITY nang "∠̸" ><!--not, vert, angle --> +<!ENTITY nexist "∄" ><!--/nexists - negated exists --> +<!ENTITY oS "Ⓢ" ><!--/circledS - capital S in circle --> +<!ENTITY plank "ℏ" ><!--/hbar - Planck's over 2pi --> +<!ENTITY plankv "ℏ" ><!--/hslash - variant Planck's over 2pi --> +<!ENTITY raemptyv "⦳" ><!--circle, slash, right arrow above --> +<!ENTITY range "⦥" ><!--reverse angle, equal --> +<!ENTITY real "ℜ" ><!--/Re - real --> +<!ENTITY tbrk "⎴" ><!--top square bracket --> +<!ENTITY ultri "◸" ><!--upper left triangle --> +<!ENTITY urtri "◹" ><!--upper right triangle --> +<!ENTITY vzigzag "⦚" ><!--vertical zig-zag line --> +<!ENTITY weierp "℘" ><!--/wp - Weierstrass p --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isoamsr.ent b/docs/docbook/xslt/db2latex/mathml/ent/isoamsr.ent new file mode 100644 index 0000000000..7fec582555 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isoamsr.ent @@ -0,0 +1,205 @@ + +<!-- + File isoamsr.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY ape "≊" ><!--/approxeq R: approximate, equals --> +<!ENTITY apE "≊" ><!--approximately equal or equal to --> +<!ENTITY apid "≋" ><!--approximately identical to --> +<!ENTITY asymp "≍" ><!--/asymp R: asymptotically equal to --> +<!ENTITY Barv "⫧" ><!--vert, dbl bar (over) --> +<!ENTITY bcong "≌" ><!--/backcong R: reverse congruent --> +<!ENTITY bepsi "ℼ" ><!--/backepsilon R: such that --> +<!ENTITY bowtie "⋈" ><!--/bowtie R: --> +<!ENTITY bsim "∽" ><!--/backsim R: reverse similar --> +<!ENTITY bsime "⋍" ><!--/backsimeq R: reverse similar, eq --> +<!ENTITY bsolhsub "\⊂" ><!--reverse solidus, subset --> +<!ENTITY bump "≎" ><!--/Bumpeq R: bumpy equals --> +<!ENTITY bumpe "≏" ><!--/bumpeq R: bumpy equals, equals --> +<!ENTITY bumpE "⪮" ><!--bump, equals --> +<!ENTITY cire "≗" ><!--/circeq R: circle, equals --> +<!ENTITY Colon "∷" ><!--/Colon, two colons --> +<!ENTITY colone "≔" ><!--/coloneq R: colon, equals --> +<!ENTITY Colone "⩴" ><!--double colon, equals --> +<!ENTITY congdot "⩭" ><!--congruent, dot --> +<!ENTITY csub "⫏" ><!--subset, closed --> +<!ENTITY csube "⫑" ><!--subset, closed, equals --> +<!ENTITY csup "⫐" ><!--superset, closed --> +<!ENTITY csupe "⫒" ><!--superset, closed, equals --> +<!ENTITY cuepr "⋞" ><!--/curlyeqprec R: curly eq, precedes --> +<!ENTITY cuesc "⋟" ><!--/curlyeqsucc R: curly eq, succeeds --> +<!ENTITY dashv "⊣" ><!--/dashv R: dash, vertical --> +<!ENTITY Dashv "⫤" ><!--dbl dash, vertical --> +<!ENTITY easter "≛" ><!--equal, asterisk above --> +<!ENTITY ecir "≖" ><!--/eqcirc R: circle on equals sign --> +<!ENTITY ecolon "≕" ><!--/eqcolon R: equals, colon --> +<!ENTITY eDDot "⩷" ><!--/ddotseq R: equal with four dots --> +<!ENTITY eDot "≑" ><!--/doteqdot /Doteq R: eq, even dots --> +<!ENTITY efDot "≒" ><!--/fallingdotseq R: eq, falling dots --> +<!ENTITY eg "⪚" ><!--equal-or-greater --> +<!ENTITY egs "⋝" ><!--/eqslantgtr R: equal-or-gtr, slanted --> +<!ENTITY egsdot "⪘" ><!--equal-or-greater, slanted, dot inside --> +<!ENTITY el "⪙" ><!--equal-or-less --> +<!ENTITY els "⋜" ><!--/eqslantless R: eq-or-less, slanted --> +<!ENTITY elsdot "⪗" ><!--equal-or-less, slanted, dot inside --> +<!ENTITY equest "≟" ><!--/questeq R: equal with questionmark --> +<!ENTITY equivDD "⩸" ><!--equivalent, four dots above --> +<!ENTITY erDot "≓" ><!--/risingdotseq R: eq, rising dots --> +<!ENTITY esdot "≐" ><!--/doteq R: equals, single dot above --> +<!ENTITY esim "≂" ><!--/esim R: equals, similar --> +<!ENTITY Esim "⩳" ><!--equal, similar --> +<!ENTITY fork "⋔" ><!--/pitchfork R: pitchfork --> +<!ENTITY forkv "⫙" ><!--fork, variant --> +<!ENTITY frown "⌢" ><!--/frown R: down curve --> +<!ENTITY gap "≳" ><!--/gtrapprox R: greater, approximate --> +<!ENTITY gE "≧" ><!--/geqq R: greater, double equals --> +<!ENTITY gel "⋛" ><!--/gtreqless R: greater, equals, less --> +<!ENTITY gEl "⋛" ><!--/gtreqqless R: gt, dbl equals, less --> +<!ENTITY ges "⩾" ><!--/geqslant R: gt-or-equal, slanted --> +<!ENTITY gescc "⪩" ><!--greater than, closed by curve, equal, slanted --> +<!ENTITY gesdot "⪀" ><!--greater-than-or-equal, slanted, dot inside --> +<!ENTITY gesdoto "⪂" ><!--greater-than-or-equal, slanted, dot above --> +<!ENTITY gesdotol "⪄" ><!--greater-than-or-equal, slanted, dot above left --> +<!ENTITY gesl "⋛⁣" ><!--greater, equal, slanted, less --> +<!ENTITY gesles "⪔" ><!--greater, equal, slanted, less, equal, slanted --> +<!ENTITY Gg "⋙" ><!--/ggg /Gg /gggtr R: triple gtr-than --> +<!ENTITY gl "≷" ><!--/gtrless R: greater, less --> +<!ENTITY gla "⪥" ><!--greater, less, apart --> +<!ENTITY glE "⪒" ><!--greater, less, equal --> +<!ENTITY glj "⪤" ><!--greater, less, overlapping --> +<!ENTITY gsim "≳" ><!--/gtrsim R: greater, similar --> +<!ENTITY gsime "⪎" ><!--greater, similar, equal --> +<!ENTITY gsiml "⪐" ><!--greater, similar, less --> +<!ENTITY Gt "≫" ><!--/gg R: dbl greater-than sign --> +<!ENTITY gtcc "⪧" ><!--greater than, closed by curve --> +<!ENTITY gtcir "⩺" ><!--greater than, circle inside --> +<!ENTITY gtdot "⋗" ><!--/gtrdot R: greater than, with dot --> +<!ENTITY gtquest "⩼" ><!--greater than, questionmark above --> +<!ENTITY gtrarr "⥸" ><!--greater than, right arrow --> +<!ENTITY homtht "∻" ><!--homothetic --> +<!ENTITY lap "≲" ><!--/lessapprox R: less, approximate --> +<!ENTITY lat "⪫" ><!--larger than --> +<!ENTITY late "⪭" ><!--larger than or equal --> +<!ENTITY lates "⪭⁣" ><!--larger than or equal, slanted --> +<!ENTITY lE "≦" ><!--/leqq R: less, double equals --> +<!ENTITY leg "⋚" ><!--/lesseqgtr R: less, eq, greater --> +<!ENTITY lEg "⋚" ><!--/lesseqqgtr R: less, dbl eq, greater --> +<!ENTITY les "⩽" ><!--/leqslant R: less-than-or-eq, slant --> +<!ENTITY lescc "⪨" ><!--less than, closed by curve, equal, slanted --> +<!ENTITY lesdot "⩿" ><!--less-than-or-equal, slanted, dot inside --> +<!ENTITY lesdoto "⪁" ><!--less-than-or-equal, slanted, dot above --> +<!ENTITY lesdotor "⪃" ><!--less-than-or-equal, slanted, dot above right --> +<!ENTITY lesg "⋚⁣" ><!--less, equal, slanted, greater --> +<!ENTITY lesges "⪓" ><!--less, equal, slanted, greater, equal, slanted --> +<!ENTITY lg "≶" ><!--/lessgtr R: less, greater --> +<!ENTITY lgE "⪑" ><!--less, greater, equal --> +<!ENTITY Ll "⋘" ><!--/Ll /lll /llless R: triple less-than --> +<!ENTITY lsim "≲" ><!--/lesssim R: less, similar --> +<!ENTITY lsime "⪍" ><!--less, similar, equal --> +<!ENTITY lsimg "⪏" ><!--less, similar, greater --> +<!ENTITY Lt "≪" ><!--/ll R: double less-than sign --> +<!ENTITY ltcc "⪦" ><!--less than, closed by curve --> +<!ENTITY ltcir "⩹" ><!--less than, circle inside --> +<!ENTITY ltdot "⋖" ><!--/lessdot R: less than, with dot --> +<!ENTITY ltlarr "⥶" ><!--less than, left arrow --> +<!ENTITY ltquest "⩻" ><!--less than, questionmark above --> +<!ENTITY ltrie "⊴" ><!--/trianglelefteq R: left triangle, eq --> +<!ENTITY mcomma "⨩" ><!--minus, comma above --> +<!ENTITY mDDot "∺" ><!--minus with four dots, geometric properties --> +<!ENTITY mid "∣" ><!--/mid R: --> +<!ENTITY mlcp "⫛" ><!--/mlcp --> +<!ENTITY models "⊧" ><!--/models R: --> +<!ENTITY mstpos "∾" ><!--most positive --> +<!ENTITY pr "≺" ><!--/prec R: precedes --> +<!ENTITY Pr "⪻" ><!--dbl precedes --> +<!ENTITY prap "≾" ><!--/precapprox R: precedes, approximate --> +<!ENTITY prcue "≼" ><!--/preccurlyeq R: precedes, curly eq --> +<!ENTITY pre "⪯" ><!--/preceq R: precedes, equals --> +<!ENTITY prE "⪯" ><!--precedes, dbl equals --> +<!ENTITY prsim "≾" ><!--/precsim R: precedes, similar --> +<!ENTITY prurel "⊰" ><!--element precedes under relation --> +<!ENTITY ratio "∶" ><!--/ratio --> +<!ENTITY rtrie "⊵" ><!--/trianglerighteq R: right tri, eq --> +<!ENTITY rtriltri "⧎" ><!--right triangle above left triangle --> +<!ENTITY sc "≻" ><!--/succ R: succeeds --> +<!ENTITY Sc "⪼" ><!--dbl succeeds --> +<!ENTITY scap "≿" ><!--/succapprox R: succeeds, approximate --> +<!ENTITY sccue "≽" ><!--/succcurlyeq R: succeeds, curly eq --> +<!ENTITY sce "≽" ><!--/succeq R: succeeds, equals --> +<!ENTITY scE "≾" ><!--succeeds, dbl equals --> +<!ENTITY scsim "≿" ><!--/succsim R: succeeds, similar --> +<!ENTITY sdote "⩦" ><!--equal, dot below --> +<!ENTITY simg "⪞" ><!--similar, greater --> +<!ENTITY simgE "⪠" ><!--similar, greater, equal --> +<!ENTITY siml "⪝" ><!--similar, less --> +<!ENTITY simlE "⪟" ><!--similar, less, equal --> +<!ENTITY smid "∣⁣" ><!--/shortmid R: --> +<!ENTITY smile "⌣" ><!--/smile R: up curve --> +<!ENTITY smt "⪪" ><!--smaller than --> +<!ENTITY smte "⪬" ><!--smaller than or equal --> +<!ENTITY smtes "⪬⁣" ><!--smaller than or equal, slanted --> +<!ENTITY spar "∥⁣" ><!--/shortparallel R: short parallel --> +<!ENTITY sqsub "⊏" ><!--/sqsubset R: square subset --> +<!ENTITY sqsube "⊑" ><!--/sqsubseteq R: square subset, equals --> +<!ENTITY sqsup "⊐" ><!--/sqsupset R: square superset --> +<!ENTITY sqsupe "⊒" ><!--/sqsupseteq R: square superset, eq --> +<!ENTITY Sub "⋐" ><!--/Subset R: double subset --> +<!ENTITY subE "⊆" ><!--/subseteqq R: subset, dbl equals --> +<!ENTITY subedot "⫃" ><!--subset, equals, dot --> +<!ENTITY submult "⫁" ><!--subset, multiply --> +<!ENTITY subplus "⪿" ><!--subset, plus --> +<!ENTITY subrarr "⥹" ><!--subset, right arrow --> +<!ENTITY subsim "⫇" ><!--subset, similar --> +<!ENTITY subsub "⫕" ><!--subset above subset --> +<!ENTITY subsup "⫓" ><!--subset above superset --> +<!ENTITY Sup "⋑" ><!--/Supset R: dbl superset --> +<!ENTITY supdsub "⫘" ><!--superset, subset, dash joining them --> +<!ENTITY supE "⊇" ><!--/supseteqq R: superset, dbl equals --> +<!ENTITY supedot "⫄" ><!--superset, equals, dot --> +<!ENTITY suphsol "⊃/" ><!--superset, solidus --> +<!ENTITY suphsub "⫗" ><!--superset, subset --> +<!ENTITY suplarr "⥻" ><!--superset, left arrow --> +<!ENTITY supmult "⫂" ><!--superset, multiply --> +<!ENTITY supplus "⫀" ><!--superset, plus --> +<!ENTITY supsim "⫈" ><!--superset, similar --> +<!ENTITY supsub "⫔" ><!--superset above subset --> +<!ENTITY supsup "⫖" ><!--superset above superset --> +<!ENTITY thkap "≈⁣" ><!--/thickapprox R: thick approximate --> +<!ENTITY thksim "∼" ><!--/thicksim R: thick similar --> +<!ENTITY topfork "⫚" ><!--fork with top --> +<!ENTITY trie "≜" ><!--/triangleq R: triangle, equals --> +<!ENTITY twixt "≬" ><!--/between R: between --> +<!ENTITY vBar "⫨" ><!--vert, dbl bar (under) --> +<!ENTITY Vbar "⫫" ><!--dbl vert, bar (under) --> +<!ENTITY vBarv "⫩" ><!--dbl bar, vert over and under --> +<!ENTITY vdash "⊢" ><!--/vdash R: vertical, dash --> +<!ENTITY vDash "⊨" ><!--/vDash R: vertical, dbl dash --> +<!ENTITY Vdash "⊩" ><!--/Vdash R: dbl vertical, dash --> +<!ENTITY VDash "⊫" ><!--dbl vert, dbl dash --> +<!ENTITY Vdashl "⫦" ><!--vertical, dash (long) --> +<!ENTITY vltri "⊲" ><!--/vartriangleleft R: l tri, open, var --> +<!ENTITY vprop "∝" ><!--/varpropto R: proportional, variant --> +<!ENTITY vrtri "⊳" ><!--/vartriangleright R: r tri, open, var --> +<!ENTITY Vvdash "⊪" ><!--/Vvdash R: triple vertical, dash --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isobox.ent b/docs/docbook/xslt/db2latex/mathml/ent/isobox.ent new file mode 100644 index 0000000000..630edc5597 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isobox.ent @@ -0,0 +1,67 @@ + +<!-- + File isobox.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1986 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY boxdl "┐" ><!--lower left quadrant --> +<!ENTITY boxdL "╕" ><!--lower left quadrant --> +<!ENTITY boxDl "╖" ><!--lower left quadrant --> +<!ENTITY boxDL "╗" ><!--lower left quadrant --> +<!ENTITY boxdr "┌" ><!--lower right quadrant --> +<!ENTITY boxdR "╒" ><!--lower right quadrant --> +<!ENTITY boxDr "╓" ><!--lower right quadrant --> +<!ENTITY boxDR "╔" ><!--lower right quadrant --> +<!ENTITY boxh "─" ><!--horizontal line --> +<!ENTITY boxH "═" ><!--horizontal line --> +<!ENTITY boxhd "┬" ><!--lower left and right quadrants --> +<!ENTITY boxhD "╥" ><!--lower left and right quadrants --> +<!ENTITY boxHd "╤" ><!--lower left and right quadrants --> +<!ENTITY boxHD "╦" ><!--lower left and right quadrants --> +<!ENTITY boxhu "┴" ><!--upper left and right quadrants --> +<!ENTITY boxhU "╨" ><!--upper left and right quadrants --> +<!ENTITY boxHu "╧" ><!--upper left and right quadrants --> +<!ENTITY boxHU "╩" ><!--upper left and right quadrants --> +<!ENTITY boxul "┘" ><!--upper left quadrant --> +<!ENTITY boxuL "╛" ><!--upper left quadrant --> +<!ENTITY boxUl "╜" ><!--upper left quadrant --> +<!ENTITY boxUL "╝" ><!--upper left quadrant --> +<!ENTITY boxur "└" ><!--upper right quadrant --> +<!ENTITY boxuR "╘" ><!--upper right quadrant --> +<!ENTITY boxUr "╙" ><!--upper right quadrant --> +<!ENTITY boxUR "╚" ><!--upper right quadrant --> +<!ENTITY boxv "│" ><!--vertical line --> +<!ENTITY boxV "║" ><!--vertical line --> +<!ENTITY boxvh "┼" ><!--all four quadrants --> +<!ENTITY boxvH "╪" ><!--all four quadrants --> +<!ENTITY boxVh "╫" ><!--all four quadrants --> +<!ENTITY boxVH "╬" ><!--all four quadrants --> +<!ENTITY boxvl "┤" ><!--upper and lower left quadrants --> +<!ENTITY boxvL "╡" ><!--upper and lower left quadrants --> +<!ENTITY boxVl "╢" ><!--upper and lower left quadrants --> +<!ENTITY boxVL "╣" ><!--upper and lower left quadrants --> +<!ENTITY boxvr "├" ><!--upper and lower right quadrants --> +<!ENTITY boxvR "╞" ><!--upper and lower right quadrants --> +<!ENTITY boxVr "╟" ><!--upper and lower right quadrants --> +<!ENTITY boxVR "╠" ><!--upper and lower right quadrants --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isocyr1.ent b/docs/docbook/xslt/db2latex/mathml/ent/isocyr1.ent new file mode 100644 index 0000000000..4bcc9e416e --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isocyr1.ent @@ -0,0 +1,94 @@ + +<!-- + File isocyr1.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1986 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY acy "а" ><!--=small a, Cyrillic --> +<!ENTITY Acy "А" ><!--=capital A, Cyrillic --> +<!ENTITY bcy "б" ><!--=small be, Cyrillic --> +<!ENTITY Bcy "Б" ><!--=capital BE, Cyrillic --> +<!ENTITY chcy "ч" ><!--=small che, Cyrillic --> +<!ENTITY CHcy "Ч" ><!--=capital CHE, Cyrillic --> +<!ENTITY dcy "д" ><!--=small de, Cyrillic --> +<!ENTITY Dcy "Д" ><!--=capital DE, Cyrillic --> +<!ENTITY ecy "э" ><!--=small e, Cyrillic --> +<!ENTITY Ecy "Э" ><!--=capital E, Cyrillic --> +<!ENTITY fcy "ф" ><!--=small ef, Cyrillic --> +<!ENTITY Fcy "Ф" ><!--=capital EF, Cyrillic --> +<!ENTITY gcy "г" ><!--=small ghe, Cyrillic --> +<!ENTITY Gcy "Г" ><!--=capital GHE, Cyrillic --> +<!ENTITY hardcy "ъ" ><!--=small hard sign, Cyrillic --> +<!ENTITY HARDcy "Ъ" ><!--=capital HARD sign, Cyrillic --> +<!ENTITY icy "и" ><!--=small i, Cyrillic --> +<!ENTITY Icy "И" ><!--=capital I, Cyrillic --> +<!ENTITY iecy "е" ><!--=small ie, Cyrillic --> +<!ENTITY IEcy "Е" ><!--=capital IE, Cyrillic --> +<!ENTITY iocy "ё" ><!--=small io, Russian --> +<!ENTITY IOcy "Ё" ><!--=capital IO, Russian --> +<!ENTITY jcy "й" ><!--=small short i, Cyrillic --> +<!ENTITY Jcy "Й" ><!--=capital short I, Cyrillic --> +<!ENTITY kcy "к" ><!--=small ka, Cyrillic --> +<!ENTITY Kcy "К" ><!--=capital KA, Cyrillic --> +<!ENTITY khcy "х" ><!--=small ha, Cyrillic --> +<!ENTITY KHcy "Х" ><!--=capital HA, Cyrillic --> +<!ENTITY lcy "л" ><!--=small el, Cyrillic --> +<!ENTITY Lcy "Л" ><!--=capital EL, Cyrillic --> +<!ENTITY mcy "м" ><!--=small em, Cyrillic --> +<!ENTITY Mcy "М" ><!--=capital EM, Cyrillic --> +<!ENTITY ncy "н" ><!--=small en, Cyrillic --> +<!ENTITY Ncy "Н" ><!--=capital EN, Cyrillic --> +<!ENTITY numero "№" ><!--=numero sign --> +<!ENTITY ocy "о" ><!--=small o, Cyrillic --> +<!ENTITY Ocy "О" ><!--=capital O, Cyrillic --> +<!ENTITY pcy "п" ><!--=small pe, Cyrillic --> +<!ENTITY Pcy "П" ><!--=capital PE, Cyrillic --> +<!ENTITY rcy "р" ><!--=small er, Cyrillic --> +<!ENTITY Rcy "Р" ><!--=capital ER, Cyrillic --> +<!ENTITY scy "с" ><!--=small es, Cyrillic --> +<!ENTITY Scy "С" ><!--=capital ES, Cyrillic --> +<!ENTITY shchcy "щ" ><!--=small shcha, Cyrillic --> +<!ENTITY SHCHcy "Щ" ><!--=capital SHCHA, Cyrillic --> +<!ENTITY shcy "ш" ><!--=small sha, Cyrillic --> +<!ENTITY SHcy "Ш" ><!--=capital SHA, Cyrillic --> +<!ENTITY softcy "ь" ><!--=small soft sign, Cyrillic --> +<!ENTITY SOFTcy "Ь" ><!--=capital SOFT sign, Cyrillic --> +<!ENTITY tcy "т" ><!--=small te, Cyrillic --> +<!ENTITY Tcy "Т" ><!--=capital TE, Cyrillic --> +<!ENTITY tscy "ц" ><!--=small tse, Cyrillic --> +<!ENTITY TScy "Ц" ><!--=capital TSE, Cyrillic --> +<!ENTITY ucy "у" ><!--=small u, Cyrillic --> +<!ENTITY Ucy "У" ><!--=capital U, Cyrillic --> +<!ENTITY vcy "в" ><!--=small ve, Cyrillic --> +<!ENTITY Vcy "В" ><!--=capital VE, Cyrillic --> +<!ENTITY yacy "я" ><!--=small ya, Cyrillic --> +<!ENTITY YAcy "Я" ><!--=capital YA, Cyrillic --> +<!ENTITY ycy "ы" ><!--=small yeru, Cyrillic --> +<!ENTITY Ycy "Ы" ><!--=capital YERU, Cyrillic --> +<!ENTITY yucy "ю" ><!--=small yu, Cyrillic --> +<!ENTITY YUcy "Ю" ><!--=capital YU, Cyrillic --> +<!ENTITY zcy "з" ><!--=small ze, Cyrillic --> +<!ENTITY Zcy "З" ><!--=capital ZE, Cyrillic --> +<!ENTITY zhcy "ж" ><!--=small zhe, Cyrillic --> +<!ENTITY ZHcy "Ж" ><!--=capital ZHE, Cyrillic --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isocyr2.ent b/docs/docbook/xslt/db2latex/mathml/ent/isocyr2.ent new file mode 100644 index 0000000000..67c477b24d --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isocyr2.ent @@ -0,0 +1,53 @@ + +<!-- + File isocyr2.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1986 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY djcy "ђ" ><!--=small dje, Serbian --> +<!ENTITY DJcy "Ђ" ><!--=capital DJE, Serbian --> +<!ENTITY dscy "ѕ" ><!--=small dse, Macedonian --> +<!ENTITY DScy "Ѕ" ><!--=capital DSE, Macedonian --> +<!ENTITY dzcy "џ" ><!--=small dze, Serbian --> +<!ENTITY DZcy "Џ" ><!--=capital dze, Serbian --> +<!ENTITY gjcy "ѓ" ><!--=small gje, Macedonian --> +<!ENTITY GJcy "Ѓ" ><!--=capital GJE Macedonian --> +<!ENTITY iukcy "і" ><!--=small i, Ukrainian --> +<!ENTITY Iukcy "І" ><!--=capital I, Ukrainian --> +<!ENTITY jsercy "ј" ><!--=small je, Serbian --> +<!ENTITY Jsercy "Ј" ><!--=capital JE, Serbian --> +<!ENTITY jukcy "є" ><!--=small je, Ukrainian --> +<!ENTITY Jukcy "Є" ><!--=capital JE, Ukrainian --> +<!ENTITY kjcy "ќ" ><!--=small kje Macedonian --> +<!ENTITY KJcy "Ќ" ><!--=capital KJE, Macedonian --> +<!ENTITY ljcy "љ" ><!--=small lje, Serbian --> +<!ENTITY LJcy "Љ" ><!--=capital LJE, Serbian --> +<!ENTITY njcy "њ" ><!--=small nje, Serbian --> +<!ENTITY NJcy "Њ" ><!--=capital NJE, Serbian --> +<!ENTITY tshcy "ћ" ><!--=small tshe, Serbian --> +<!ENTITY TSHcy "Ћ" ><!--=capital TSHE, Serbian --> +<!ENTITY ubrcy "ў" ><!--=small u, Byelorussian --> +<!ENTITY Ubrcy "Ў" ><!--=capital U, Byelorussian --> +<!ENTITY yicy "ї" ><!--=small yi, Ukrainian --> +<!ENTITY YIcy "Ї" ><!--=capital YI, Ukrainian --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isodia.ent b/docs/docbook/xslt/db2latex/mathml/ent/isodia.ent new file mode 100644 index 0000000000..ba6496300f --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isodia.ent @@ -0,0 +1,41 @@ + +<!-- + File isodia.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1986 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY acute "´" ><!--=acute accent --> +<!ENTITY breve "˘" ><!--=breve --> +<!ENTITY caron "ˇ" ><!--=caron --> +<!ENTITY cedil "¸" ><!--=cedilla --> +<!ENTITY circ "^" ><!--circumflex accent --> +<!ENTITY dblac "˝" ><!--=double acute accent --> +<!ENTITY die "¨" ><!--=dieresis --> +<!ENTITY dot "˙" ><!--=dot above --> +<!ENTITY grave "`" ><!--=grave accent --> +<!ENTITY macr "¯" ><!--=macron --> +<!ENTITY ogon "˛" ><!--=ogonek --> +<!ENTITY ring "˚" ><!--=ring --> +<!ENTITY tilde "˜" ><!--=tilde --> +<!ENTITY uml "¨" ><!--=umlaut mark --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isogrk1.ent b/docs/docbook/xslt/db2latex/mathml/ent/isogrk1.ent new file mode 100644 index 0000000000..63b9f14ce8 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isogrk1.ent @@ -0,0 +1,75 @@ +<!-- + + File isogrk1.ent produced by the dsssl script ent.dsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments in the STIX proposal for characters + for Mathematics. + + The STIX assignments are temporary and will change if + the proposal or some variant of it is adopted by the + Unicode Consortium. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1986 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. +--> + +<!ENTITY agr "α" ><!--U03B1 =small alpha, Greek --> +<!ENTITY Agr "Α" ><!--U0391 =capital Alpha, Greek --> +<!ENTITY bgr "β" ><!--U03B2 =small beta, Greek --> +<!ENTITY Bgr "Β" ><!--U0392 =capital Beta, Greek --> +<!ENTITY dgr "δ" ><!--U03B4 =small delta, Greek --> +<!ENTITY Dgr "Δ" ><!--U0394 =capital Delta, Greek --> +<!ENTITY eegr "η" ><!--U03B7 =small eta, Greek --> +<!ENTITY egr "ε" ><!--U03B5 =small epsilon, Greek --> +<!ENTITY EEgr "Η" ><!--U0397 =capital Eta, Greek --> +<!ENTITY Egr "Ε" ><!--U0395 =capital Epsilon, Greek --> +<!ENTITY ggr "γ" ><!--U03B3 =small gamma, Greek --> +<!ENTITY Ggr "Γ" ><!--U0393 =capital Gamma, Greek --> +<!ENTITY igr "ι" ><!--U03B9 =small iota, Greek --> +<!ENTITY Igr "Ι" ><!--U0399 =capital Iota, Greek --> +<!ENTITY kgr "κ" ><!--U03BA =small kappa, Greek --> +<!ENTITY khgr "χ" ><!--U03C7 =small chi, Greek --> +<!ENTITY Kgr "Κ" ><!--U039A =capital Kappa, Greek --> +<!ENTITY KHgr "Χ" ><!--U03A7 =capital Chi, Greek --> +<!ENTITY lgr "λ" ><!--U03BB =small lambda, Greek --> +<!ENTITY Lgr "Λ" ><!--U039B =capital Lambda, Greek --> +<!ENTITY mgr "μ" ><!--U03BC =small mu, Greek --> +<!ENTITY Mgr "Μ" ><!--U039C =capital Mu, Greek --> +<!ENTITY ngr "ν" ><!--U03BD =small nu, Greek --> +<!ENTITY Ngr "Ν" ><!--U039D =capital Nu, Greek --> +<!ENTITY ogr "ο" ><!--U03BF =small omicron, Greek --> +<!ENTITY ohgr "ω" ><!--U03C9 =small omega, Greek --> +<!ENTITY Ogr "Ο" ><!--U039F =capital Omicron, Greek --> +<!ENTITY OHgr "Ω" ><!--U03A9 =capital Omega, Greek --> +<!ENTITY pgr "π" ><!--U03C0 =small pi, Greek --> +<!ENTITY phgr "φ" ><!--U03C6 =small phi, Greek --> +<!ENTITY psgr "ψ" ><!--U03C8 =small psi, Greek --> +<!ENTITY Pgr "Π" ><!--U03A0 =capital Pi, Greek --> +<!ENTITY PHgr "Φ" ><!--U03A6 =capital Phi, Greek --> +<!ENTITY PSgr "Ψ" ><!--U03A8 =capital Psi, Greek --> +<!ENTITY rgr "ρ" ><!--U03C1 =small rho, Greek --> +<!ENTITY Rgr "Ρ" ><!--U03A1 =capital Rho, Greek --> +<!ENTITY sfgr "ς" ><!--U03C2 =final small sigma, Greek --> +<!ENTITY sgr "σ" ><!--U03C3 =small sigma, Greek --> +<!ENTITY Sgr "Σ" ><!--U03A3 =capital Sigma, Greek --> +<!ENTITY tgr "τ" ><!--U03C4 =small tau, Greek --> +<!ENTITY thgr "θ" ><!--U03B8 =small theta, Greek --> +<!ENTITY Tgr "Τ" ><!--U03A4 =capital Tau, Greek --> +<!ENTITY THgr "Θ" ><!--U0398 =capital Theta, Greek --> +<!ENTITY ugr "υ" ><!--U03C5 =small upsilon, Greek --> +<!ENTITY Ugr "Υ" ><!--U03A5 =capital Upsilon, Greek --> +<!ENTITY xgr "ξ" ><!--U03BE =small xi, Greek --> +<!ENTITY Xgr "Ξ" ><!--U039E =capital Xi, Greek --> +<!ENTITY zgr "ζ" ><!--U03B6 =small zeta, Greek --> +<!ENTITY Zgr "Ζ" ><!--U0396 =capital Zeta, Greek --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isogrk2.ent b/docs/docbook/xslt/db2latex/mathml/ent/isogrk2.ent new file mode 100644 index 0000000000..424786cabb --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isogrk2.ent @@ -0,0 +1,46 @@ +<!-- + + File isogrk2.ent produced by the dsssl script ent.dsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments in the STIX proposal for characters + for Mathematics. + + The STIX assignments are temporary and will change if + the proposal or some variant of it is adopted by the + Unicode Consortium. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1986 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. +--> + +<!ENTITY aacgr "ά" ><!--U03AC =small alpha, accent, Greek --> +<!ENTITY Aacgr "Ά" ><!--U0386 =capital Alpha, accent, Greek --> +<!ENTITY eacgr "έ" ><!--U03AD =small epsilon, accent, Greek --> +<!ENTITY eeacgr "ή" ><!--U03AE =small eta, accent, Greek --> +<!ENTITY Eacgr "Έ" ><!--U0388 =capital Epsilon, accent, Greek --> +<!ENTITY EEacgr "Ή" ><!--U0389 =capital Eta, accent, Greek --> +<!ENTITY iacgr "ί" ><!--U03AF =small iota, accent, Greek --> +<!ENTITY idiagr "ΐ" ><!--U0390 =small iota, dieresis, accent, Greek --> +<!ENTITY idigr "ϊ" ><!--U03CA =small iota, dieresis, Greek --> +<!ENTITY Iacgr "Ί" ><!--U038A =capital Iota, accent, Greek --> +<!ENTITY Idigr "Ϊ" ><!--U03AA =capital Iota, dieresis, Greek --> +<!ENTITY oacgr "ό" ><!--U03CC =small omicron, accent, Greek --> +<!ENTITY ohacgr "ώ" ><!--U03CE =small omega, accent, Greek --> +<!ENTITY Oacgr "Ό" ><!--U038C =capital Omicron, accent, Greek --> +<!ENTITY OHacgr "Ώ" ><!--U038F =capital Omega, accent, Greek --> +<!ENTITY uacgr "ύ" ><!--U03CD =small upsilon, accent, Greek --> +<!ENTITY udiagr "ΰ" ><!--U03B0 =small upsilon, dieresis, accent, Greek --> +<!ENTITY udigr "ϋ" ><!--U03CB =small upsilon, dieresis, Greek --> +<!ENTITY Uacgr "Ύ" ><!--U038E =capital Upsilon, accent, Greek --> +<!ENTITY Udigr "Ϋ" ><!--U03AB =capital Upsilon, dieresis, Greek --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isogrk3.ent b/docs/docbook/xslt/db2latex/mathml/ent/isogrk3.ent new file mode 100644 index 0000000000..fa03355048 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isogrk3.ent @@ -0,0 +1,70 @@ + +<!-- + File isogrk3.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY alpha "α" ><!--/alpha small alpha, Greek --> +<!ENTITY beta "β" ><!--/beta small beta, Greek --> +<!ENTITY chi "χ" ><!--/chi small chi, Greek --> +<!ENTITY delta "δ" ><!--/delta small delta, Greek --> +<!ENTITY Delta "Δ" ><!--/Delta capital Delta, Greek --> +<!ENTITY epsi "ε" ><!--/straightepsilon, small epsilon, Greek --> +<!ENTITY epsiv "ɛ" ><!--/varepsilon --> +<!ENTITY eta "η" ><!--/eta small eta, Greek --> +<!ENTITY gamma "γ" ><!--/gamma small gamma, Greek --> +<!ENTITY Gamma "Γ" ><!--/Gamma capital Gamma, Greek --> +<!ENTITY gammad "Ϝ" ><!--/digamma --> +<!ENTITY Gammad "Ϝ" ><!--capital digamma --> +<!ENTITY iota "ι" ><!--/iota small iota, Greek --> +<!ENTITY kappa "κ" ><!--/kappa small kappa, Greek --> +<!ENTITY kappav "ϰ" ><!--/varkappa --> +<!ENTITY lambda "λ" ><!--/lambda small lambda, Greek --> +<!ENTITY Lambda "Λ" ><!--/Lambda capital Lambda, Greek --> +<!ENTITY mu "μ" ><!--/mu small mu, Greek --> +<!ENTITY nu "ν" ><!--/nu small nu, Greek --> +<!ENTITY omega "ω" ><!--/omega small omega, Greek --> +<!ENTITY Omega "Ω" ><!--/Omega capital Omega, Greek --> +<!ENTITY phi "φ" ><!--/straightphi - small phi, Greek --> +<!ENTITY Phi "Φ" ><!--/Phi capital Phi, Greek --> +<!ENTITY phiv "ϕ" ><!--/varphi - curly or open phi --> +<!ENTITY pi "π" ><!--/pi small pi, Greek --> +<!ENTITY Pi "Π" ><!--/Pi capital Pi, Greek --> +<!ENTITY piv "ϖ" ><!--/varpi --> +<!ENTITY psi "ψ" ><!--/psi small psi, Greek --> +<!ENTITY Psi "Ψ" ><!--/Psi capital Psi, Greek --> +<!ENTITY rho "ρ" ><!--/rho small rho, Greek --> +<!ENTITY rhov "ϱ" ><!--/varrho --> +<!ENTITY sigma "σ" ><!--/sigma small sigma, Greek --> +<!ENTITY Sigma "Σ" ><!--/Sigma capital Sigma, Greek --> +<!ENTITY sigmav "ς" ><!--/varsigma --> +<!ENTITY tau "τ" ><!--/tau small tau, Greek --> +<!ENTITY theta "θ" ><!--/theta straight theta, small theta, Greek --> +<!ENTITY Theta "Θ" ><!--/Theta capital Theta, Greek --> +<!ENTITY thetav "ϑ" ><!--/vartheta - curly or open theta --> +<!ENTITY upsi "υ" ><!--/upsilon small upsilon, Greek --> +<!ENTITY Upsi "ϒ" ><!--/Upsilon capital Upsilon, Greek --> +<!ENTITY xi "ξ" ><!--/xi small xi, Greek --> +<!ENTITY Xi "Ξ" ><!--/Xi capital Xi, Greek --> +<!ENTITY zeta "ζ" ><!--/zeta small zeta, Greek --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isogrk4.ent b/docs/docbook/xslt/db2latex/mathml/ent/isogrk4.ent new file mode 100644 index 0000000000..71f834042b --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isogrk4.ent @@ -0,0 +1,69 @@ +<!-- + + File isogrk4.ent produced by the dsssl script ent.dsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments in the STIX proposal for characters + for Mathematics. + + The STIX assignments are temporary and will change if + the proposal or some variant of it is adopted by the + Unicode Consortium. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. +--> + +<!ENTITY b.alpha "" ><!--UE700 small alpha, Greek --> +<!ENTITY b.beta "" ><!--UE701 small beta, Greek --> +<!ENTITY b.chi "" ><!--UE727 small chi, Greek --> +<!ENTITY b.delta "" ><!--UE706 small delta, Greek --> +<!ENTITY b.Delta "" ><!--UE707 capital delta, Greek --> +<!ENTITY b.epsi "" ><!--UE708 small epsilon, Greek --> +<!ENTITY b.epsiv "" ><!--UE709 varepsilion --> +<!ENTITY b.eta "" ><!--UE70C small eta, Greek --> +<!ENTITY b.gamma "" ><!--UE702 small gamma, Greek --> +<!ENTITY b.gammad "" ><!--UE704 digamma, Greek --> +<!ENTITY b.Gamma "" ><!--UE703 capital gamma, Greek --> +<!ENTITY b.Gammad "" ><!--UE705 capital digamma, Greek --> +<!ENTITY b.iota "" ><!--UE710 small iota, Greek --> +<!ENTITY b.kappa "" ><!--UE711 small kappa, Greek --> +<!ENTITY b.kappav "" ><!--UE712 var kappa, Greek --> +<!ENTITY b.lambda "" ><!--UE713 small lambda, Greek --> +<!ENTITY b.Lambda "" ><!--UE714 capital lambda, Greek --> +<!ENTITY b.mu "" ><!--UE715 small mu, Greek --> +<!ENTITY b.nu "" ><!--UE716 small nu, Greek --> +<!ENTITY b.omega "" ><!--UE72A small omega, Greek --> +<!ENTITY b.Omega "" ><!--UE72B capital Omega, Greek --> +<!ENTITY b.phis "" ><!--UE724 straight phi, Greek --> +<!ENTITY b.phiv "" ><!--UE726 varphi --> +<!ENTITY b.pi "" ><!--UE719 small pi, Greek --> +<!ENTITY b.piv "" ><!--UE71B varpi --> +<!ENTITY b.psi "" ><!--UE728 small psi, Greek --> +<!ENTITY b.Phi "" ><!--UE725 capital Phi, Greek --> +<!ENTITY b.Pi "" ><!--UE71A capital pi, Greek --> +<!ENTITY b.Psi "" ><!--UE729 capital Psi, Greek --> +<!ENTITY b.rho "" ><!--UE71C small rho, Greek --> +<!ENTITY b.rhov "" ><!--UE71D varrho --> +<!ENTITY b.sigma "" ><!--UE71E small sigma, Greek --> +<!ENTITY b.sigmav "" ><!--UE720 varsigma --> +<!ENTITY b.Sigma "" ><!--UE71F capital sigma, Greek --> +<!ENTITY b.tau "" ><!--UE721 small tau, Greek --> +<!ENTITY b.thetas "" ><!--UE70D straight theta, Greek --> +<!ENTITY b.thetav "" ><!--UE70F var theta, Greek --> +<!ENTITY b.Theta "" ><!--UE70E capital theta, Greek --> +<!ENTITY b.upsi "" ><!--UE722 small upsilon, Greek --> +<!ENTITY b.Upsilon "" ><!--UE723 capital upsilon, Greek --> +<!ENTITY b.xi "" ><!--UE717 small xi, Greek --> +<!ENTITY b.Xi "" ><!--UE718 capital xi, Greek --> +<!ENTITY b.zeta "" ><!--UE70B small zeta, Greek --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isolat1.ent b/docs/docbook/xslt/db2latex/mathml/ent/isolat1.ent new file mode 100644 index 0000000000..849d360aea --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isolat1.ent @@ -0,0 +1,89 @@ + +<!-- + File isolat1.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1986 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY aacute "á" ><!--=small a, acute accent --> +<!ENTITY Aacute "Á" ><!--=capital A, acute accent --> +<!ENTITY acirc "â" ><!--=small a, circumflex accent --> +<!ENTITY Acirc "Â" ><!--=capital A, circumflex accent --> +<!ENTITY aelig "æ" ><!--=small ae diphthong (ligature) --> +<!ENTITY AElig "Æ" ><!--=capital AE diphthong (ligature) --> +<!ENTITY agrave "à" ><!--=small a, grave accent --> +<!ENTITY Agrave "À" ><!--=capital A, grave accent --> +<!ENTITY aring "å" ><!--=small a, ring --> +<!ENTITY Aring "Å" ><!--=capital A, ring --> +<!ENTITY atilde "ã" ><!--=small a, tilde --> +<!ENTITY Atilde "Ã" ><!--=capital A, tilde --> +<!ENTITY auml "ä" ><!--=small a, dieresis or umlaut mark --> +<!ENTITY Auml "Ä" ><!--=capital A, dieresis or umlaut mark --> +<!ENTITY ccedil "ç" ><!--=small c, cedilla --> +<!ENTITY Ccedil "Ç" ><!--=capital C, cedilla --> +<!ENTITY eacute "é" ><!--=small e, acute accent --> +<!ENTITY Eacute "É" ><!--=capital E, acute accent --> +<!ENTITY ecirc "ê" ><!--=small e, circumflex accent --> +<!ENTITY Ecirc "Ê" ><!--=capital E, circumflex accent --> +<!ENTITY egrave "è" ><!--=small e, grave accent --> +<!ENTITY Egrave "È" ><!--=capital E, grave accent --> +<!ENTITY eth "ð" ><!--=small eth, Icelandic --> +<!ENTITY ETH "Ð" ><!--=capital Eth, Icelandic --> +<!ENTITY euml "ë" ><!--=small e, dieresis or umlaut mark --> +<!ENTITY Euml "Ë" ><!--=capital E, dieresis or umlaut mark --> +<!ENTITY iacute "í" ><!--=small i, acute accent --> +<!ENTITY Iacute "Í" ><!--=capital I, acute accent --> +<!ENTITY icirc "î" ><!--=small i, circumflex accent --> +<!ENTITY Icirc "Î" ><!--=capital I, circumflex accent --> +<!ENTITY igrave "ì" ><!--=small i, grave accent --> +<!ENTITY Igrave "Ì" ><!--=capital I, grave accent --> +<!ENTITY iuml "ï" ><!--=small i, dieresis or umlaut mark --> +<!ENTITY Iuml "Ï" ><!--=capital I, dieresis or umlaut mark --> +<!ENTITY ntilde "ñ" ><!--=small n, tilde --> +<!ENTITY Ntilde "Ñ" ><!--=capital N, tilde --> +<!ENTITY oacute "ó" ><!--=small o, acute accent --> +<!ENTITY Oacute "Ó" ><!--=capital O, acute accent --> +<!ENTITY ocirc "ô" ><!--=small o, circumflex accent --> +<!ENTITY Ocirc "Ô" ><!--=capital O, circumflex accent --> +<!ENTITY ograve "ò" ><!--=small o, grave accent --> +<!ENTITY Ograve "Ò" ><!--=capital O, grave accent --> +<!ENTITY oslash "ø" ><!--latin small letter o with stroke --> +<!ENTITY Oslash "Ø" ><!--=capital O, slash --> +<!ENTITY otilde "õ" ><!--=small o, tilde --> +<!ENTITY Otilde "Õ" ><!--=capital O, tilde --> +<!ENTITY ouml "ö" ><!--=small o, dieresis or umlaut mark --> +<!ENTITY Ouml "Ö" ><!--=capital O, dieresis or umlaut mark --> +<!ENTITY szlig "ß" ><!--=small sharp s, German (sz ligature) --> +<!ENTITY thorn "þ" ><!--=small thorn, Icelandic --> +<!ENTITY THORN "Þ" ><!--=capital THORN, Icelandic --> +<!ENTITY uacute "ú" ><!--=small u, acute accent --> +<!ENTITY Uacute "Ú" ><!--=capital U, acute accent --> +<!ENTITY ucirc "û" ><!--=small u, circumflex accent --> +<!ENTITY Ucirc "Û" ><!--=capital U, circumflex accent --> +<!ENTITY ugrave "ù" ><!--=small u, grave accent --> +<!ENTITY Ugrave "Ù" ><!--=capital U, grave accent --> +<!ENTITY uuml "ü" ><!--=small u, dieresis or umlaut mark --> +<!ENTITY Uuml "Ü" ><!--=capital U, dieresis or umlaut mark --> +<!ENTITY yacute "ý" ><!--=small y, acute accent --> +<!ENTITY Yacute "Ý" ><!--=capital Y, acute accent --> +<!ENTITY yuml "ÿ" ><!--=small y, dieresis or umlaut mark --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isolat2.ent b/docs/docbook/xslt/db2latex/mathml/ent/isolat2.ent new file mode 100644 index 0000000000..3049be7f1f --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isolat2.ent @@ -0,0 +1,148 @@ + +<!-- + File isolat2.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1986 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY abreve "ă" ><!--=small a, breve --> +<!ENTITY Abreve "Ă" ><!--=capital A, breve --> +<!ENTITY amacr "ā" ><!--=small a, macron --> +<!ENTITY Amacr "Ā" ><!--=capital A, macron --> +<!ENTITY aogon "ą" ><!--=small a, ogonek --> +<!ENTITY Aogon "Ą" ><!--=capital A, ogonek --> +<!ENTITY cacute "ć" ><!--=small c, acute accent --> +<!ENTITY Cacute "Ć" ><!--=capital C, acute accent --> +<!ENTITY ccaron "č" ><!--=small c, caron --> +<!ENTITY Ccaron "Č" ><!--=capital C, caron --> +<!ENTITY ccirc "ĉ" ><!--=small c, circumflex accent --> +<!ENTITY Ccirc "Ĉ" ><!--=capital C, circumflex accent --> +<!ENTITY cdot "ċ" ><!--=small c, dot above --> +<!ENTITY Cdot "Ċ" ><!--=capital C, dot above --> +<!ENTITY dcaron "ď" ><!--=small d, caron --> +<!ENTITY Dcaron "Ď" ><!--=capital D, caron --> +<!ENTITY dstrok "đ" ><!--=small d, stroke --> +<!ENTITY Dstrok "Đ" ><!--=capital D, stroke --> +<!ENTITY ecaron "ě" ><!--=small e, caron --> +<!ENTITY Ecaron "Ě" ><!--=capital E, caron --> +<!ENTITY edot "ė" ><!--=small e, dot above --> +<!ENTITY Edot "Ė" ><!--=capital E, dot above --> +<!ENTITY emacr "ē" ><!--=small e, macron --> +<!ENTITY Emacr "Ē" ><!--=capital E, macron --> +<!ENTITY eng "ŋ" ><!--=small eng, Lapp --> +<!ENTITY ENG "Ŋ" ><!--=capital ENG, Lapp --> +<!ENTITY eogon "ę" ><!--=small e, ogonek --> +<!ENTITY Eogon "Ę" ><!--=capital E, ogonek --> +<!ENTITY gacute "ǵ" ><!--=small g, acute accent --> +<!ENTITY gbreve "ğ" ><!--=small g, breve --> +<!ENTITY Gbreve "Ğ" ><!--=capital G, breve --> +<!ENTITY Gcedil "Ģ" ><!--=capital G, cedilla --> +<!ENTITY gcirc "ĝ" ><!--=small g, circumflex accent --> +<!ENTITY Gcirc "Ĝ" ><!--=capital G, circumflex accent --> +<!ENTITY gdot "ġ" ><!--=small g, dot above --> +<!ENTITY Gdot "Ġ" ><!--=capital G, dot above --> +<!ENTITY hcirc "ĥ" ><!--=small h, circumflex accent --> +<!ENTITY Hcirc "Ĥ" ><!--=capital H, circumflex accent --> +<!ENTITY hstrok "ħ" ><!--=small h, stroke --> +<!ENTITY Hstrok "Ħ" ><!--=capital H, stroke --> +<!ENTITY Idot "İ" ><!--=capital I, dot above --> +<!ENTITY ijlig "ij" ><!--=small ij ligature --> +<!ENTITY IJlig "IJ" ><!--=capital IJ ligature --> +<!ENTITY imacr "ī" ><!--=small i, macron --> +<!ENTITY Imacr "Ī" ><!--=capital I, macron --> +<!ENTITY inodot "ı" ><!--=small i without dot --> +<!ENTITY iogon "į" ><!--=small i, ogonek --> +<!ENTITY Iogon "Į" ><!--=capital I, ogonek --> +<!ENTITY itilde "ĩ" ><!--=small i, tilde --> +<!ENTITY Itilde "Ĩ" ><!--=capital I, tilde --> +<!ENTITY jcirc "ĵ" ><!--=small j, circumflex accent --> +<!ENTITY Jcirc "Ĵ" ><!--=capital J, circumflex accent --> +<!ENTITY kcedil "ķ" ><!--=small k, cedilla --> +<!ENTITY Kcedil "Ķ" ><!--=capital K, cedilla --> +<!ENTITY kgreen "ĸ" ><!--=small k, Greenlandic --> +<!ENTITY lacute "ĺ" ><!--=small l, acute accent --> +<!ENTITY Lacute "Ĺ" ><!--=capital L, acute accent --> +<!ENTITY lcaron "ľ" ><!--=small l, caron --> +<!ENTITY Lcaron "Ľ" ><!--=capital L, caron --> +<!ENTITY lcedil "ļ" ><!--=small l, cedilla --> +<!ENTITY Lcedil "Ļ" ><!--=capital L, cedilla --> +<!ENTITY lmidot "ŀ" ><!--=small l, middle dot --> +<!ENTITY Lmidot "Ŀ" ><!--=capital L, middle dot --> +<!ENTITY lstrok "ł" ><!--=small l, stroke --> +<!ENTITY Lstrok "Ł" ><!--=capital L, stroke --> +<!ENTITY nacute "ń" ><!--=small n, acute accent --> +<!ENTITY Nacute "Ń" ><!--=capital N, acute accent --> +<!ENTITY napos "ʼn" ><!--=small n, apostrophe --> +<!ENTITY ncaron "ň" ><!--=small n, caron --> +<!ENTITY Ncaron "Ň" ><!--=capital N, caron --> +<!ENTITY ncedil "ņ" ><!--=small n, cedilla --> +<!ENTITY Ncedil "Ņ" ><!--=capital N, cedilla --> +<!ENTITY odblac "ő" ><!--=small o, double acute accent --> +<!ENTITY Odblac "Ő" ><!--=capital O, double acute accent --> +<!ENTITY oelig "œ" ><!--=small oe ligature --> +<!ENTITY OElig "Œ" ><!--=capital OE ligature --> +<!ENTITY omacr "ō" ><!--=small o, macron --> +<!ENTITY Omacr "Ō" ><!--=capital O, macron --> +<!ENTITY racute "ŕ" ><!--=small r, acute accent --> +<!ENTITY Racute "Ŕ" ><!--=capital R, acute accent --> +<!ENTITY rcaron "ř" ><!--=small r, caron --> +<!ENTITY Rcaron "Ř" ><!--=capital R, caron --> +<!ENTITY rcedil "ŗ" ><!--=small r, cedilla --> +<!ENTITY Rcedil "Ŗ" ><!--=capital R, cedilla --> +<!ENTITY sacute "ś" ><!--=small s, acute accent --> +<!ENTITY Sacute "Ś" ><!--=capital S, acute accent --> +<!ENTITY scaron "š" ><!--=small s, caron --> +<!ENTITY Scaron "Š" ><!--=capital S, caron --> +<!ENTITY scedil "ş" ><!--=small s, cedilla --> +<!ENTITY Scedil "Ş" ><!--=capital S, cedilla --> +<!ENTITY scirc "ŝ" ><!--=small s, circumflex accent --> +<!ENTITY Scirc "Ŝ" ><!--=capital S, circumflex accent --> +<!ENTITY tcaron "ť" ><!--=small t, caron --> +<!ENTITY Tcaron "Ť" ><!--=capital T, caron --> +<!ENTITY tcedil "ţ" ><!--=small t, cedilla --> +<!ENTITY Tcedil "Ţ" ><!--=capital T, cedilla --> +<!ENTITY tstrok "ŧ" ><!--=small t, stroke --> +<!ENTITY Tstrok "Ŧ" ><!--=capital T, stroke --> +<!ENTITY ubreve "ŭ" ><!--=small u, breve --> +<!ENTITY Ubreve "Ŭ" ><!--=capital U, breve --> +<!ENTITY udblac "ű" ><!--=small u, double acute accent --> +<!ENTITY Udblac "Ű" ><!--=capital U, double acute accent --> +<!ENTITY umacr "ū" ><!--=small u, macron --> +<!ENTITY Umacr "Ū" ><!--=capital U, macron --> +<!ENTITY uogon "ų" ><!--=small u, ogonek --> +<!ENTITY Uogon "Ų" ><!--=capital U, ogonek --> +<!ENTITY uring "ů" ><!--=small u, ring --> +<!ENTITY Uring "Ů" ><!--=capital U, ring --> +<!ENTITY utilde "ũ" ><!--=small u, tilde --> +<!ENTITY Utilde "Ũ" ><!--=capital U, tilde --> +<!ENTITY wcirc "ŵ" ><!--=small w, circumflex accent --> +<!ENTITY Wcirc "Ŵ" ><!--=capital W, circumflex accent --> +<!ENTITY ycirc "ŷ" ><!--=small y, circumflex accent --> +<!ENTITY Ycirc "Ŷ" ><!--=capital Y, circumflex accent --> +<!ENTITY Yuml "Ÿ" ><!--=capital Y, dieresis or umlaut mark --> +<!ENTITY zacute "ź" ><!--=small z, acute accent --> +<!ENTITY Zacute "Ź" ><!--=capital Z, acute accent --> +<!ENTITY zcaron "ž" ><!--=small z, caron --> +<!ENTITY Zcaron "Ž" ><!--=capital Z, caron --> +<!ENTITY zdot "ż" ><!--=small z, dot above --> +<!ENTITY Zdot "Ż" ><!--=capital Z, dot above --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isomfrk.ent b/docs/docbook/xslt/db2latex/mathml/ent/isomfrk.ent new file mode 100644 index 0000000000..397212a643 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isomfrk.ent @@ -0,0 +1,79 @@ + +<!-- + File isomfrk.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY afr "𝔞" ><!--/frak a, lower case a --> +<!ENTITY Afr "𝔄" ><!--/frak A, upper case a --> +<!ENTITY bfr "𝔟" ><!--/frak b, lower case b --> +<!ENTITY Bfr "𝔅" ><!--/frak B, upper case b --> +<!ENTITY cfr "𝔠" ><!--/frak c, lower case c --> +<!ENTITY Cfr "𝔆" ><!--/frak C, upper case c --> +<!ENTITY dfr "𝔡" ><!--/frak d, lower case d --> +<!ENTITY Dfr "𝔇" ><!--/frak D, upper case d --> +<!ENTITY efr "𝔢" ><!--/frak e, lower case e --> +<!ENTITY Efr "𝔈" ><!--/frak E, upper case e --> +<!ENTITY ffr "𝔣" ><!--/frak f, lower case f --> +<!ENTITY Ffr "𝔉" ><!--/frak F, upper case f --> +<!ENTITY gfr "𝔤" ><!--/frak g, lower case g --> +<!ENTITY Gfr "𝔊" ><!--/frak G, upper case g --> +<!ENTITY hfr "𝔥" ><!--/frak h, lower case h --> +<!ENTITY Hfr "𝔋" ><!--/frak H, upper case h --> +<!ENTITY ifr "𝔦" ><!--/frak i, lower case i --> +<!ENTITY Ifr "𝔌" ><!--/frak I, upper case i --> +<!ENTITY jfr "𝔧" ><!--/frak j, lower case j --> +<!ENTITY Jfr "𝔍" ><!--/frak J, upper case j --> +<!ENTITY kfr "𝔨" ><!--/frak k, lower case k --> +<!ENTITY Kfr "𝔎" ><!--/frak K, upper case k --> +<!ENTITY lfr "𝔩" ><!--/frak l, lower case l --> +<!ENTITY Lfr "𝔏" ><!--/frak L, upper case l --> +<!ENTITY mfr "𝔪" ><!--/frak m, lower case m --> +<!ENTITY Mfr "𝔐" ><!--/frak M, upper case m --> +<!ENTITY nfr "𝔫" ><!--/frak n, lower case n --> +<!ENTITY Nfr "𝔑" ><!--/frak N, upper case n --> +<!ENTITY ofr "𝔬" ><!--/frak o, lower case o --> +<!ENTITY Ofr "𝔒" ><!--/frak O, upper case o --> +<!ENTITY pfr "𝔭" ><!--/frak p, lower case p --> +<!ENTITY Pfr "𝔓" ><!--/frak P, upper case p --> +<!ENTITY qfr "𝔮" ><!--/frak q, lower case q --> +<!ENTITY Qfr "𝔔" ><!--/frak Q, upper case q --> +<!ENTITY rfr "𝔯" ><!--/frak r, lower case r --> +<!ENTITY Rfr "𝔕" ><!--/frak R, upper case r --> +<!ENTITY sfr "𝔰" ><!--/frak s, lower case s --> +<!ENTITY Sfr "𝔖" ><!--/frak S, upper case s --> +<!ENTITY tfr "𝔱" ><!--/frak t, lower case t --> +<!ENTITY Tfr "𝔗" ><!--/frak T, upper case t --> +<!ENTITY ufr "𝔲" ><!--/frak u, lower case u --> +<!ENTITY Ufr "𝔘" ><!--/frak U, upper case u --> +<!ENTITY vfr "𝔳" ><!--/frak v, lower case v --> +<!ENTITY Vfr "𝔙" ><!--/frak V, upper case v --> +<!ENTITY wfr "𝔴" ><!--/frak w, lower case w --> +<!ENTITY Wfr "𝔚" ><!--/frak W, upper case w --> +<!ENTITY xfr "𝔵" ><!--/frak x, lower case x --> +<!ENTITY Xfr "𝔛" ><!--/frak X, upper case x --> +<!ENTITY yfr "𝔶" ><!--/frak y, lower case y --> +<!ENTITY Yfr "𝔜" ><!--/frak Y, upper case y --> +<!ENTITY zfr "𝔷" ><!--/frak z, lower case z --> +<!ENTITY Zfr "𝔝" ><!--/frak Z, upper case z --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isomopf.ent b/docs/docbook/xslt/db2latex/mathml/ent/isomopf.ent new file mode 100644 index 0000000000..806b2fb4fe --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isomopf.ent @@ -0,0 +1,53 @@ + +<!-- + File isomopf.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY Aopf "𝔸" ><!--/Bbb A, open face A --> +<!ENTITY Bopf "𝔹" ><!--/Bbb B, open face B --> +<!ENTITY Copf "𝔺" ><!--/Bbb C, open face C --> +<!ENTITY Dopf "𝔻" ><!--/Bbb D, open face D --> +<!ENTITY Eopf "𝔼" ><!--/Bbb E, open face E --> +<!ENTITY Fopf "𝔽" ><!--/Bbb F, open face F --> +<!ENTITY Gopf "𝔾" ><!--/Bbb G, open face G --> +<!ENTITY Hopf "𝔿" ><!--/Bbb H, open face H --> +<!ENTITY Iopf "𝕀" ><!--/Bbb I, open face I --> +<!ENTITY Jopf "𝕁" ><!--/Bbb J, open face J --> +<!ENTITY Kopf "𝕂" ><!--/Bbb K, open face K --> +<!ENTITY Lopf "𝕃" ><!--/Bbb L, open face L --> +<!ENTITY Mopf "𝕄" ><!--/Bbb M, open face M --> +<!ENTITY Nopf "𝕅" ><!--/Bbb N, open face N --> +<!ENTITY Oopf "𝕆" ><!--/Bbb O, open face O --> +<!ENTITY Popf "𝕇" ><!--/Bbb P, open face P --> +<!ENTITY Qopf "𝕈" ><!--/Bbb Q, open face Q --> +<!ENTITY Ropf "𝕉" ><!--/Bbb R, open face R --> +<!ENTITY Sopf "𝕊" ><!--/Bbb S, open face S --> +<!ENTITY Topf "𝕋" ><!--/Bbb T, open face T --> +<!ENTITY Uopf "𝕌" ><!--/Bbb U, open face U --> +<!ENTITY Vopf "𝕍" ><!--/Bbb V, open face V --> +<!ENTITY Wopf "𝕎" ><!--/Bbb W, open face W --> +<!ENTITY Xopf "𝕏" ><!--/Bbb X, open face X --> +<!ENTITY Yopf "𝕐" ><!--/Bbb Y, open face Y --> +<!ENTITY Zopf "𝕑" ><!--/Bbb Z, open face Z --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isomscr.ent b/docs/docbook/xslt/db2latex/mathml/ent/isomscr.ent new file mode 100644 index 0000000000..a1bb39c36c --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isomscr.ent @@ -0,0 +1,79 @@ + +<!-- + File isomscr.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY ascr "𝒶" ><!--/scr a, script letter a --> +<!ENTITY Ascr "𝒜" ><!--/scr A, script letter A --> +<!ENTITY bscr "𝒷" ><!--/scr b, script letter b --> +<!ENTITY Bscr "𝒝" ><!--/scr B, script letter B --> +<!ENTITY cscr "𝒸" ><!--/scr c, script letter c --> +<!ENTITY Cscr "𝒞" ><!--/scr C, script letter C --> +<!ENTITY dscr "𝒹" ><!--/scr d, script letter d --> +<!ENTITY Dscr "𝒟" ><!--/scr D, script letter D --> +<!ENTITY escr "𝒺" ><!--/scr e, script letter e --> +<!ENTITY Escr "𝒠" ><!--/scr E, script letter E --> +<!ENTITY fscr "𝒻" ><!--/scr f, script letter f --> +<!ENTITY Fscr "𝒡" ><!--/scr F, script letter F --> +<!ENTITY gscr "𝒼" ><!--/scr g, script letter g --> +<!ENTITY Gscr "𝒢" ><!--/scr G, script letter G --> +<!ENTITY hscr "𝒽" ><!--/scr h, script letter h --> +<!ENTITY Hscr "𝒣" ><!--/scr H, script letter H --> +<!ENTITY iscr "𝒾" ><!--/scr i, script letter i --> +<!ENTITY Iscr "𝒤" ><!--/scr I, script letter I --> +<!ENTITY jscr "𝒿" ><!--/scr j, script letter j --> +<!ENTITY Jscr "𝒥" ><!--/scr J, script letter J --> +<!ENTITY kscr "𝓀" ><!--/scr k, script letter k --> +<!ENTITY Kscr "𝒦" ><!--/scr K, script letter K --> +<!ENTITY lscr "𝓁" ><!--/scr l, script letter l --> +<!ENTITY Lscr "𝒧" ><!--/scr L, script letter L --> +<!ENTITY mscr "𝓂" ><!--/scr m, script letter m --> +<!ENTITY Mscr "𝒨" ><!--/scr M, script letter M --> +<!ENTITY nscr "𝓃" ><!--/scr n, script letter n --> +<!ENTITY Nscr "𝒩" ><!--/scr N, script letter N --> +<!ENTITY oscr "𝓄" ><!--/scr o, script letter o --> +<!ENTITY Oscr "𝒪" ><!--/scr O, script letter O --> +<!ENTITY pscr "𝓅" ><!--/scr p, script letter p --> +<!ENTITY Pscr "𝒫" ><!--/scr P, script letter P --> +<!ENTITY qscr "𝓆" ><!--/scr q, script letter q --> +<!ENTITY Qscr "𝒬" ><!--/scr Q, script letter Q --> +<!ENTITY rscr "𝓇" ><!--/scr r, script letter r --> +<!ENTITY Rscr "𝒭" ><!--/scr R, script letter R --> +<!ENTITY sscr "𝓈" ><!--/scr s, script letter s --> +<!ENTITY Sscr "𝒮" ><!--/scr S, script letter S --> +<!ENTITY tscr "𝓉" ><!--/scr t, script letter t --> +<!ENTITY Tscr "𝒯" ><!--/scr T, script letter T --> +<!ENTITY uscr "𝓊" ><!--/scr u, script letter u --> +<!ENTITY Uscr "𝒰" ><!--/scr U, script letter U --> +<!ENTITY vscr "𝓋" ><!--/scr v, script letter v --> +<!ENTITY Vscr "𝒱" ><!--/scr V, script letter V --> +<!ENTITY wscr "𝓌" ><!--/scr w, script letter w --> +<!ENTITY Wscr "𝒲" ><!--/scr W, script letter W --> +<!ENTITY xscr "𝓍" ><!--/scr x, script letter x --> +<!ENTITY Xscr "𝒳" ><!--/scr X, script letter X --> +<!ENTITY yscr "𝓎" ><!--/scr y, script letter y --> +<!ENTITY Yscr "𝒴" ><!--/scr Y, script letter Y --> +<!ENTITY zscr "𝓏" ><!--/scr z, script letter z --> +<!ENTITY Zscr "𝒵" ><!--/scr Z, script letter Z --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isonum.ent b/docs/docbook/xslt/db2latex/mathml/ent/isonum.ent new file mode 100644 index 0000000000..e5a7002fb4 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isonum.ent @@ -0,0 +1,103 @@ + +<!-- + File isonum.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1986 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY amp "&&" ><!--=ampersand --> +<!ENTITY apos "'" ><!--=apostrophe --> +<!ENTITY ast "*" ><!--/ast B: =asterisk --> +<!ENTITY brvbar "¦" ><!--=broken (vertical) bar --> +<!ENTITY bsol "\" ><!--/backslash =reverse solidus --> +<!ENTITY cent "¢" ><!--=cent sign --> +<!ENTITY colon ":" ><!--/colon P: --> +<!ENTITY comma "," ><!--P: =comma --> +<!ENTITY commat "@" ><!--=commercial at --> +<!ENTITY copy "©" ><!--=copyright sign --> +<!ENTITY curren "¤" ><!--=general currency sign --> +<!ENTITY darr "↓" ><!--/downarrow A: =downward arrow --> +<!ENTITY deg "°" ><!--=degree sign --> +<!ENTITY divide "÷" ><!--/div B: =divide sign --> +<!ENTITY dollar "$" ><!--=dollar sign --> +<!ENTITY equals "=" ><!--=equals sign R: --> +<!ENTITY excl "!" ><!--=exclamation mark --> +<!ENTITY frac12 "½" ><!--=fraction one-half --> +<!ENTITY frac14 "¼" ><!--=fraction one-quarter --> +<!ENTITY frac18 "⅛" ><!--=fraction one-eighth --> +<!ENTITY frac34 "¾" ><!--=fraction three-quarters --> +<!ENTITY frac38 "⅜" ><!--=fraction three-eighths --> +<!ENTITY frac58 "⅝" ><!--=fraction five-eighths --> +<!ENTITY frac78 "⅞" ><!--=fraction seven-eighths --> +<!ENTITY gt ">" ><!--=greater-than sign R: --> +<!ENTITY half "½" ><!--=fraction one-half --> +<!ENTITY horbar "―" ><!--=horizontal bar --> +<!ENTITY hyphen "‐" ><!--=hyphen --> +<!ENTITY iexcl "¡" ><!--=inverted exclamation mark --> +<!ENTITY iquest "¿" ><!--=inverted question mark --> +<!ENTITY laquo "«" ><!--=angle quotation mark, left --> +<!ENTITY larr "←" ><!--/leftarrow /gets A: =leftward arrow --> +<!ENTITY lcub "{" ><!--/lbrace O: =left curly bracket --> +<!ENTITY ldquo "“" ><!--=double quotation mark, left --> +<!ENTITY lowbar "_" ><!--=low line --> +<!ENTITY lpar "(" ><!--O: =left parenthesis --> +<!ENTITY lsqb "[" ><!--/lbrack O: =left square bracket --> +<!ENTITY lsquo "‘" ><!--=single quotation mark, left --> +<!ENTITY lt "&<" ><!--=less-than sign R: --> +<!ENTITY micro "µ" ><!--=micro sign --> +<!ENTITY middot "·" ><!--/centerdot B: =middle dot --> +<!ENTITY nbsp " " ><!--=no break (required) space --> +<!ENTITY not "¬" ><!--/neg /lnot =not sign --> +<!ENTITY num "#" ><!--=number sign --> +<!ENTITY ohm "Ω" ><!--=ohm sign --> +<!ENTITY ordf "ª" ><!--=ordinal indicator, feminine --> +<!ENTITY ordm "º" ><!--=ordinal indicator, masculine --> +<!ENTITY para "¶" ><!--=pilcrow (paragraph sign) --> +<!ENTITY percnt "%" ><!--=percent sign --> +<!ENTITY period "." ><!--=full stop, period --> +<!ENTITY plus "+" ><!--=plus sign B: --> +<!ENTITY plusmn "±" ><!--/pm B: =plus-or-minus sign --> +<!ENTITY pound "£" ><!--=pound sign --> +<!ENTITY quest "?" ><!--=question mark --> +<!ENTITY quot """ ><!--=quotation mark --> +<!ENTITY raquo "»" ><!--=angle quotation mark, right --> +<!ENTITY rarr "→" ><!--/rightarrow /to A: =rightward arrow --> +<!ENTITY rcub "}" ><!--/rbrace C: =right curly bracket --> +<!ENTITY rdquo "”" ><!--=double quotation mark, right --> +<!ENTITY reg "®" ><!--/circledR =registered sign --> +<!ENTITY rpar ")" ><!--C: =right parenthesis --> +<!ENTITY rsqb "]" ><!--/rbrack C: =right square bracket --> +<!ENTITY rsquo "’" ><!--=single quotation mark, right --> +<!ENTITY sect "§" ><!--=section sign --> +<!ENTITY semi ";" ><!--=semicolon P: --> +<!ENTITY shy "­" ><!--=soft hyphen --> +<!ENTITY sol "/" ><!--=solidus --> +<!ENTITY sung "♪" ><!--=music note (sung text sign) --> +<!ENTITY sup1 "¹" ><!--=superscript one --> +<!ENTITY sup2 "²" ><!--=superscript two --> +<!ENTITY sup3 "³" ><!--=superscript three --> +<!ENTITY times "×" ><!--/times B: =multiply sign --> +<!ENTITY trade "™" ><!--=trade mark sign --> +<!ENTITY uarr "↑" ><!--/uparrow A: =upward arrow --> +<!ENTITY verbar "|" ><!--/vert =vertical bar --> +<!ENTITY yen "¥" ><!--/yen =yen sign --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isopub.ent b/docs/docbook/xslt/db2latex/mathml/ent/isopub.ent new file mode 100644 index 0000000000..5591fc390e --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isopub.ent @@ -0,0 +1,111 @@ + +<!-- + File isopub.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1986 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY blank "␣" ><!--=significant blank symbol --> +<!ENTITY blk12 "▒" ><!--=50% shaded block --> +<!ENTITY blk14 "░" ><!--=25% shaded block --> +<!ENTITY blk34 "▓" ><!--=75% shaded block --> +<!ENTITY block "█" ><!--=full block --> +<!ENTITY bull "•" ><!--/bullet B: =round bullet, filled --> +<!ENTITY caret "⁁" ><!--=caret (insertion mark) --> +<!ENTITY check "✓" ><!--/checkmark =tick, check mark --> +<!ENTITY cir "○" ><!--/circ B: =circle, open --> +<!ENTITY clubs "♣" ><!--/clubsuit =club suit symbol --> +<!ENTITY copysr "℗" ><!--=sound recording copyright sign --> +<!ENTITY cross "✗" ><!--=ballot cross --> +<!ENTITY dagger "†" ><!--/dagger B: =dagger --> +<!ENTITY Dagger "‡" ><!--/ddagger B: =double dagger --> +<!ENTITY dash "‐" ><!--=hyphen (true graphic) --> +<!ENTITY diams "♦" ><!--/diamondsuit =diamond suit symbol --> +<!ENTITY dlcrop "⌍" ><!--downward left crop mark --> +<!ENTITY drcrop "⌌" ><!--downward right crop mark --> +<!ENTITY dtri "▿" ><!--/triangledown =down triangle, open --> +<!ENTITY dtrif "▾" ><!--/blacktriangledown =dn tri, filled --> +<!ENTITY emsp " " ><!--=em space --> +<!ENTITY emsp13 " " ><!--=1/3-em space --> +<!ENTITY emsp14 " " ><!--=1/4-em space --> +<!ENTITY ensp " " ><!--=en space (1/2-em) --> +<!ENTITY female "♀" ><!--=female symbol --> +<!ENTITY ffilig "ffi" ><!--small ffi ligature --> +<!ENTITY fflig "ff" ><!--small ff ligature --> +<!ENTITY ffllig "ffl" ><!--small ffl ligature --> +<!ENTITY filig "fi" ><!--small fi ligature --> +<!ENTITY flat "♭" ><!--/flat =musical flat --> +<!ENTITY fllig "fl" ><!--small fl ligature --> +<!ENTITY frac13 "⅓" ><!--=fraction one-third --> +<!ENTITY frac15 "⅕" ><!--=fraction one-fifth --> +<!ENTITY frac16 "⅙" ><!--=fraction one-sixth --> +<!ENTITY frac23 "⅔" ><!--=fraction two-thirds --> +<!ENTITY frac25 "⅖" ><!--=fraction two-fifths --> +<!ENTITY frac35 "⅗" ><!--=fraction three-fifths --> +<!ENTITY frac45 "⅘" ><!--=fraction four-fifths --> +<!ENTITY frac56 "⅚" ><!--=fraction five-sixths --> +<!ENTITY hairsp " " ><!--=hair space --> +<!ENTITY hearts "♡" ><!--/heartsuit =heart suit symbol --> +<!ENTITY hellip "…" ><!--=ellipsis (horizontal) --> +<!ENTITY hybull "⁃" ><!--rectangle, filled (hyphen bullet) --> +<!ENTITY incare "℅" ><!--=in-care-of symbol --> +<!ENTITY ldquor "„" ><!--=rising dbl quote, left (low) --> +<!ENTITY lhblk "▄" ><!--=lower half block --> +<!ENTITY loz "◊" ><!--/lozenge - lozenge or total mark --> +<!ENTITY lozf "⧫" ><!--/blacklozenge - lozenge, filled --> +<!ENTITY lsquor "‚" ><!--=rising single quote, left (low) --> +<!ENTITY ltri "◃" ><!--/triangleleft B: l triangle, open --> +<!ENTITY ltrif "◂" ><!--/blacktriangleleft R: =l tri, filled --> +<!ENTITY male "♂" ><!--=male symbol --> +<!ENTITY malt "✠" ><!--/maltese =maltese cross --> +<!ENTITY marker "▮" ><!--=histogram marker --> +<!ENTITY mdash "—" ><!--=em dash --> +<!ENTITY mldr "…" ><!--em leader --> +<!ENTITY natur "♮" ><!--/natural - music natural --> +<!ENTITY ndash "–" ><!--=en dash --> +<!ENTITY nldr "‥" ><!--=double baseline dot (en leader) --> +<!ENTITY numsp " " ><!--=digit space (width of a number) --> +<!ENTITY phone "☎" ><!--=telephone symbol --> +<!ENTITY puncsp " " ><!--=punctuation space (width of comma) --> +<!ENTITY rdquor "”" ><!--rising dbl quote, right (high) --> +<!ENTITY rect "▭" ><!--=rectangle, open --> +<!ENTITY rsquor "’" ><!--rising single quote, right (high) --> +<!ENTITY rtri "▹" ><!--/triangleright B: r triangle, open --> +<!ENTITY rtrif "▸" ><!--/blacktriangleright R: =r tri, filled --> +<!ENTITY rx "℞" ><!--pharmaceutical prescription (Rx) --> +<!ENTITY sext "✶" ><!--sextile (6-pointed star) --> +<!ENTITY sharp "♯" ><!--/sharp =musical sharp --> +<!ENTITY spades "♠" ><!--/spadesuit =spades suit symbol --> +<!ENTITY squ "□" ><!--=square, open --> +<!ENTITY squf "▪" ><!--/blacksquare =sq bullet, filled --> +<!ENTITY star "⋆" ><!--=star, open --> +<!ENTITY starf "★" ><!--/bigstar - star, filled --> +<!ENTITY target "⌖" ><!--register mark or target --> +<!ENTITY telrec "⌕" ><!--=telephone recorder symbol --> +<!ENTITY thinsp " " ><!--=thin space (1/6-em) --> +<!ENTITY uhblk "▀" ><!--=upper half block --> +<!ENTITY ulcrop "⌏" ><!--upward left crop mark --> +<!ENTITY urcrop "⌎" ><!--upward right crop mark --> +<!ENTITY utri "▵" ><!--/triangle =up triangle, open --> +<!ENTITY utrif "▴" ><!--/blacktriangle =up tri, filled --> +<!ENTITY vellip "⋮" ><!--vertical ellipsis --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/isotech.ent b/docs/docbook/xslt/db2latex/mathml/ent/isotech.ent new file mode 100644 index 0000000000..dc1fc01354 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/isotech.ent @@ -0,0 +1,183 @@ + +<!-- + File isotech.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + + Entity names in this file are derived from files carrying the + following notice: + + (C) International Organization for Standardization 1991 + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +--> + +<!ENTITY acd "∿" ><!--ac current --> +<!ENTITY aleph "ℵ" ><!--/aleph aleph, Hebrew --> +<!ENTITY and "∧" ><!--/wedge /land B: logical and --> +<!ENTITY And "⩓" ><!--dbl logical and --> +<!ENTITY andand "⩕" ><!--two logical and --> +<!ENTITY andd "⩜" ><!--and, horizontal dash --> +<!ENTITY andslope "⩘" ><!--sloping large and --> +<!ENTITY andv "⩚" ><!--and with middle stem --> +<!ENTITY angrt "∟" ><!--right (90 degree) angle --> +<!ENTITY angsph "∢" ><!--/sphericalangle angle-spherical --> +<!ENTITY angst "Å" ><!--Angstrom capital A, ring --> +<!ENTITY ap "≈" ><!--/approx R: approximate --> +<!ENTITY apacir "⩯" ><!--approximate, circumflex accent --> +<!ENTITY awconint "∳" ><!--contour integral, anti-clockwise --> +<!ENTITY awint "⨑" ><!--anti clock-wise integration --> +<!ENTITY becaus "∵" ><!--/because R: because --> +<!ENTITY bernou "ℬ" ><!--Bernoulli function (script capital B) --> +<!ENTITY bne "=⃥" ><!--reverse not equal --> +<!ENTITY bnequiv "≡⃥" ><!--reverse not equivalent --> +<!ENTITY bnot "⌐" ><!--reverse not --> +<!ENTITY bNot "⫭" ><!--reverse not with two horizontal strokes --> +<!ENTITY bottom "⊥" ><!--/bot bottom --> +<!ENTITY cap "∩" ><!--/cap B: intersection --> +<!ENTITY Cconint "∰" ><!--triple contour integral operator --> +<!ENTITY cirfnint "⨐" ><!--circulation function --> +<!ENTITY compfn "∘" ><!--/circ B: composite function (small circle) --> +<!ENTITY cong "≅" ><!--/cong R: congruent with --> +<!ENTITY conint "∮" ><!--/oint L: contour integral operator --> +<!ENTITY Conint "∯" ><!--double contour integral operator --> +<!ENTITY ctdot "⋯" ><!--/cdots, three dots, centered --> +<!ENTITY cup "∪" ><!--/cup B: union or logical sum --> +<!ENTITY cwconint "∲" ><!--contour integral, clockwise --> +<!ENTITY cwint "∱" ><!--clockwise integral --> +<!ENTITY cylcty "⌭" ><!--cylindricity --> +<!ENTITY disin "⋲" ><!--set membership, long horizontal stroke --> +<!ENTITY Dot "¨" ><!--dieresis or umlaut mark --> +<!ENTITY DotDot "⃜" ><!--four dots above --> +<!ENTITY dsol "⁒" ><!--solidus, bar above --> +<!ENTITY dtdot "⋱" ><!--/ddots, three dots, descending --> +<!ENTITY dwangle "⦦" ><!--large downward pointing angle --> +<!ENTITY epar "⋕" ><!--parallel, equal; equal or parallel --> +<!ENTITY eparsl "⧣" ><!--parallel, slanted, equal; homothetically congruent to --> +<!ENTITY equiv "≡" ><!--/equiv R: identical with --> +<!ENTITY eqvparsl "⧥" ><!--equivalent, equal; congruent and parallel --> +<!ENTITY exist "∃" ><!--/exists at least one exists --> +<!ENTITY fnof "ƒ" ><!--function of (italic small f) --> +<!ENTITY forall "∀" ><!--/forall for all --> +<!ENTITY fpartint "⨍" ><!--finite part integral --> +<!ENTITY ge "≥" ><!--/geq /ge R: greater-than-or-equal --> +<!ENTITY hamilt "ℋ" ><!--Hamiltonian (script capital H) --> +<!ENTITY iff "⇔" ><!--/iff if and only if --> +<!ENTITY iinfin "⧜" ><!--infinity sign, incomplete --> +<!ENTITY imped "𝕃" ><!--impedance --> +<!ENTITY infin "∞" ><!--/infty infinity --> +<!ENTITY int "∫" ><!--/int L: integral operator --> +<!ENTITY Int "∬" ><!--double integral operator --> +<!ENTITY intlarhk "⨗" ><!--integral, left arrow with hook --> +<!ENTITY isin "∈" ><!--/in R: set membership --> +<!ENTITY isindot "⋵" ><!--set membership, dot above --> +<!ENTITY isinE "⋹" ><!--set membership, two horizontal strokes --> +<!ENTITY isins "⋴" ><!--set membership, vertical bar on horizontal stroke --> +<!ENTITY isinsv "⋳" ><!--large set membership, vertical bar on horizontal stroke --> +<!ENTITY isinv "∈" ><!--set membership, variant --> +<!ENTITY lagran "ℒ" ><!--Lagrangian (script capital L) --> +<!ENTITY lang "〈" ><!--/langle O: left angle bracket --> +<!ENTITY Lang "《" ><!--left angle bracket, double --> +<!ENTITY lArr "⇐" ><!--/Leftarrow A: is implied by --> +<!ENTITY lbbrk "〔" ><!--left broken bracket --> +<!ENTITY le "≤" ><!--/leq /le R: less-than-or-equal --> +<!ENTITY loang "〘" ><!--left open angular bracket --> +<!ENTITY lobrk "〚" ><!--left open bracket --> +<!ENTITY lopar "⦅" ><!--left open parenthesis --> +<!ENTITY lowast "∗" ><!--low asterisk --> +<!ENTITY minus "−" ><!--B: minus sign --> +<!ENTITY mnplus "∓" ><!--/mp B: minus-or-plus sign --> +<!ENTITY nabla "∇" ><!--/nabla del, Hamilton operator --> +<!ENTITY ne "≠" ><!--/ne /neq R: not equal --> +<!ENTITY nedot "≠⁣" ><!--not equal, dot --> +<!ENTITY nhpar "⫲" ><!--not, horizontal, parallel --> +<!ENTITY ni "∋" ><!--/ni /owns R: contains --> +<!ENTITY nis "⋼" ><!--contains, vertical bar on horizontal stroke --> +<!ENTITY nisd "⋺" ><!--contains, long horizontal stroke --> +<!ENTITY niv "∋" ><!--contains, variant --> +<!ENTITY Not "⫬" ><!--not with two horizontal strokes --> +<!ENTITY notin "∉" ><!--/notin N: negated set membership --> +<!ENTITY notindot "⋶⁣" ><!--negated set membership, dot above --> +<!ENTITY notinva "∉̸" ><!--negated set membership, variant --> +<!ENTITY notinvb "⋷" ><!--negated set membership, variant --> +<!ENTITY notinvc "⋶" ><!--negated set membership, variant --> +<!ENTITY notni "∌" ><!--negated contains --> +<!ENTITY notniva "∌" ><!--negated contains, variant --> +<!ENTITY notnivb "⋾" ><!--contains, variant --> +<!ENTITY notnivc "⋽" ><!--contains, variant --> +<!ENTITY nparsl "∥⁣⃥" ><!--not parallel, slanted --> +<!ENTITY npart "∂̸" ><!--not partial differential --> +<!ENTITY npolint "⨔" ><!--line integration, not including the pole --> +<!ENTITY nvinfin "⧞" ><!--not, vert, infinity --> +<!ENTITY olcross "⦻" ><!--circle, cross --> +<!ENTITY or "∨" ><!--/vee /lor B: logical or --> +<!ENTITY Or "⩔" ><!--dbl logical or --> +<!ENTITY ord "⩝" ><!--or, horizontal dash --> +<!ENTITY order "ℴ" ><!--order of (script small o) --> +<!ENTITY oror "⩖" ><!--two logical or --> +<!ENTITY orslope "⩗" ><!--sloping large or --> +<!ENTITY orv "⩛" ><!--or with middle stem --> +<!ENTITY par "∥" ><!--/parallel R: parallel --> +<!ENTITY parsl "∥⁣" ><!--parallel, slanted --> +<!ENTITY part "∂" ><!--/partial partial differential --> +<!ENTITY permil "‰" ><!--per thousand --> +<!ENTITY perp "⊥" ><!--/perp R: perpendicular --> +<!ENTITY pertenk "‱" ><!--per 10 thousand --> +<!ENTITY phmmat "ℳ" ><!--physics M-matrix (script capital M) --> +<!ENTITY pointint "⨕" ><!--integral around a point operator --> +<!ENTITY prime "′" ><!--/prime prime or minute --> +<!ENTITY Prime "″" ><!--double prime or second --> +<!ENTITY profalar "⌮" ><!--all-around profile --> +<!ENTITY profline "⌒" ><!--profile of a line --> +<!ENTITY profsurf "⌓" ><!--profile of a surface --> +<!ENTITY prop "∝" ><!--/propto R: is proportional to --> +<!ENTITY qint "⨌" ><!--/iiiint quadruple integral operator --> +<!ENTITY qprime "⁗" ><!--quadruple prime --> +<!ENTITY quatint "⨖" ><!--quaternion integral operator --> +<!ENTITY radic "√" ><!--/surd radical --> +<!ENTITY rang "〉" ><!--/rangle C: right angle bracket --> +<!ENTITY Rang "》" ><!--right angle bracket, double --> +<!ENTITY rArr "⇒" ><!--/Rightarrow A: implies --> +<!ENTITY rbbrk "〕" ><!--right broken bracket --> +<!ENTITY roang "〙" ><!--right open angular bracket --> +<!ENTITY robrk "〛" ><!--right open bracket --> +<!ENTITY ropar "⦆" ><!--right open parenthesis --> +<!ENTITY rppolint "⨒" ><!--line integration, rectangular path around pole --> +<!ENTITY scpolint "⨓" ><!--line integration, semi-circular path around pole --> +<!ENTITY sim "∼" ><!--/sim R: similar --> +<!ENTITY simdot "⩪" ><!--similar, dot --> +<!ENTITY sime "≃" ><!--/simeq R: similar, equals --> +<!ENTITY smeparsl "⧤" ><!--similar, parallel, slanted, equal --> +<!ENTITY square "□" ><!--/square, square --> +<!ENTITY squarf "▪" ><!--/blacksquare, square, filled --> +<!ENTITY sub "⊂" ><!--/subset R: subset or is implied by --> +<!ENTITY sube "⊆" ><!--/subseteq R: subset, equals --> +<!ENTITY sup "⊃" ><!--/supset R: superset or implies --> +<!ENTITY supe "⊇" ><!--/supseteq R: superset, equals --> +<!ENTITY tdot "⃛" ><!--three dots above --> +<!ENTITY there4 "∴" ><!--/therefore R: therefore --> +<!ENTITY tint "∭" ><!--/iiint triple integral operator --> +<!ENTITY top "⊤" ><!--/top top --> +<!ENTITY topbot "⌶" ><!--top and bottom --> +<!ENTITY topcir "⫱" ><!--top, circle below --> +<!ENTITY tprime "‴" ><!--triple prime --> +<!ENTITY utdot "⋰" ><!--three dots, ascending --> +<!ENTITY uwangle "⦧" ><!--large upward pointing angle --> +<!ENTITY vangrt "⊾" ><!--right angle, variant --> +<!ENTITY veeeq "≚" ><!--logical or, equals --> +<!ENTITY Verbar "‖" ><!--/Vert dbl vertical bar --> +<!ENTITY wedgeq "≙" ><!--/wedgeq R: corresponds to (wedge, equals) --> +<!ENTITY xnis "⋻" ><!--large contains, vertical bar on horizontal stroke --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/mmlalias.ent b/docs/docbook/xslt/db2latex/mathml/ent/mmlalias.ent new file mode 100644 index 0000000000..f5901b3846 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/mmlalias.ent @@ -0,0 +1,529 @@ + +<!-- + File mmlalias.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + +--> + +<!ENTITY angle "∠" ><!--alias ISOAMSO ang --> +<!ENTITY approx "≈" ><!--alias ISOTECH ap --> +<!ENTITY approxeq "≊" ><!--alias ISOAMSR ape --> +<!ENTITY backcong "≌" ><!--alias ISOAMSR bcong --> +<!ENTITY backepsilon "ℼ" ><!--alias ISOAMSR bepsi --> +<!ENTITY backprime "‵" ><!--alias ISOAMSO bprime --> +<!ENTITY backsim "∽" ><!--alias ISOAMSR bsim --> +<!ENTITY backsimeq "⋍" ><!--alias ISOAMSR bsime --> +<!ENTITY Backslash "∖" ><!--alias ISOAMSB setmn --> +<!ENTITY barwedge "⊼" ><!--alias ISOAMSB barwed --> +<!ENTITY because "∵" ><!--alias ISOTECH becaus --> +<!ENTITY Because "∵" ><!--alias ISOTECH becaus --> +<!ENTITY Bernoullis "ℬ" ><!--alias ISOTECH bernou --> +<!ENTITY between "≬" ><!--alias ISOAMSR twixt --> +<!ENTITY bigcap "⋂" ><!--alias ISOAMSB xcap --> +<!ENTITY bigcirc "◯" ><!--alias ISOAMSB xcirc --> +<!ENTITY bigcup "⋃" ><!--alias ISOAMSB xcup --> +<!ENTITY bigodot "⊙" ><!--alias ISOAMSB xodot --> +<!ENTITY bigoplus "⊕" ><!--alias ISOAMSB xoplus --> +<!ENTITY bigotimes "⊗" ><!--alias ISOAMSB xotime --> +<!ENTITY bigsqcup "⊔" ><!--alias ISOAMSB xsqcup --> +<!ENTITY bigstar "★" ><!--ISOPUB starf --> +<!ENTITY bigtriangledown "▽" ><!--alias ISOAMSB xdtri --> +<!ENTITY bigtriangleup "△" ><!--alias ISOAMSB xutri --> +<!ENTITY biguplus "⊎" ><!--alias ISOAMSB xuplus --> +<!ENTITY bigvee "⋁" ><!--alias ISOAMSB xvee --> +<!ENTITY bigwedge "⋀" ><!--alias ISOAMSB xwedge --> +<!ENTITY bkarow "⤍" ><!--alias ISOAMSA rbarr --> +<!ENTITY blacklozenge "⧫" ><!--alias ISOPUB lozf --> +<!ENTITY blacksquare "▪" ><!--ISOTECH squarf --> +<!ENTITY blacktriangle "▴" ><!--alias ISOPUB utrif --> +<!ENTITY blacktriangledown "▾" ><!--alias ISOPUB dtrif --> +<!ENTITY blacktriangleleft "◂" ><!--alias ISOPUB ltrif --> +<!ENTITY blacktriangleright "▸" ><!--alias ISOPUB rtrif --> +<!ENTITY bot "⊥" ><!--alias ISOTECH bottom --> +<!ENTITY boxminus "⊟" ><!--alias ISOAMSB minusb --> +<!ENTITY boxplus "⊞" ><!--alias ISOAMSB plusb --> +<!ENTITY boxtimes "⊠" ><!--alias ISOAMSB timesb --> +<!ENTITY Breve "˘" ><!--alias ISODIA breve --> +<!ENTITY bullet "•" ><!--alias ISOPUB bull --> +<!ENTITY bumpeq "≏" ><!--alias ISOAMSR bumpe --> +<!ENTITY Bumpeq "≎" ><!--alias ISOAMSR bump --> +<!ENTITY Cedilla "¸" ><!--alias ISODIA cedil --> +<!ENTITY centerdot "·" ><!--alias ISONUM middot --> +<!ENTITY CenterDot "·" ><!--alias ISONUM middot --> +<!ENTITY checkmark "✓" ><!--alias ISOPUB check --> +<!ENTITY circeq "≗" ><!--alias ISOAMSR cire --> +<!ENTITY circlearrowleft "↺" ><!--alias ISOAMSA olarr --> +<!ENTITY circlearrowright "↻" ><!--alias ISOAMSA orarr --> +<!ENTITY circledast "⊛" ><!--alias ISOAMSB oast --> +<!ENTITY circledcirc "⊚" ><!--alias ISOAMSB ocir --> +<!ENTITY circleddash "⊝" ><!--alias ISOAMSB odash --> +<!ENTITY CircleDot "⊙" ><!--alias ISOAMSB odot --> +<!ENTITY circledR "®" ><!--alias ISONUM reg --> +<!ENTITY circledS "Ⓢ" ><!--alias ISOAMSO oS --> +<!ENTITY CircleMinus "⊖" ><!--alias ISOAMSB ominus --> +<!ENTITY CirclePlus "⊕" ><!--alias ISOAMSB oplus --> +<!ENTITY CircleTimes "⊗" ><!--alias ISOAMSB otimes --> +<!ENTITY ClockwiseContourIntegral "∲" ><!--alias ISOTECH cwconint --> +<!ENTITY CloseCurlyDoubleQuote "”" ><!--alias ISONUM rdquo --> +<!ENTITY CloseCurlyQuote "’" ><!--alias ISONUM rsquo --> +<!ENTITY clubsuit "♣" ><!--ISOPUB clubs --> +<!ENTITY coloneq "≔" ><!--alias ISOAMSR colone --> +<!ENTITY complement "∁" ><!--alias ISOAMSO comp --> +<!ENTITY Congruent "≡" ><!--alias ISOTECH equiv --> +<!ENTITY ContourIntegral "∮" ><!--alias ISOTECH conint --> +<!ENTITY Coproduct "∐" ><!--alias ISOAMSB coprod --> +<!ENTITY CounterClockwiseContourIntegral "∳" ><!--alias ISOTECH awconint --> +<!ENTITY CupCap "≍" ><!--alias ISOAMSR asymp --> +<!ENTITY curlyeqprec "⋞" ><!--alias ISOAMSR cuepr --> +<!ENTITY curlyeqsucc "⋟" ><!--alias ISOAMSR cuesc --> +<!ENTITY curlyvee "⋎" ><!--alias ISOAMSB cuvee --> +<!ENTITY curlywedge "⋏" ><!--alias ISOAMSB cuwed --> +<!ENTITY curvearrowleft "↶" ><!--alias ISOAMSA cularr --> +<!ENTITY curvearrowright "↷" ><!--alias ISOAMSA curarr --> +<!ENTITY dbkarow "⤏" ><!--alias ISOAMSA rBarr --> +<!ENTITY ddagger "‡" ><!--alias ISOPUB Dagger --> +<!ENTITY ddotseq "⩷" ><!--alias ISOAMSR eDDot --> +<!ENTITY Del "∇" ><!--alias ISOTECH nabla --> +<!ENTITY DiacriticalAcute "´" ><!--alias ISODIA acute --> +<!ENTITY DiacriticalDot "˙" ><!--alias ISODIA dot --> +<!ENTITY DiacriticalDoubleAcute "˝" ><!--alias ISODIA dblac --> +<!ENTITY DiacriticalGrave "`" ><!--alias ISODIA grave --> +<!ENTITY DiacriticalTilde "˜" ><!--alias ISODIA tilde --> +<!ENTITY diamond "⋄" ><!--alias ISOAMSB diam --> +<!ENTITY Diamond "⋄" ><!--alias ISOAMSB diam --> +<!ENTITY diamondsuit "♦" ><!--ISOPUB diams --> +<!ENTITY digamma "Ϝ" ><!--alias ISOGRK3 gammad --> +<!ENTITY div "÷" ><!--alias ISONUM divide --> +<!ENTITY divideontimes "⋇" ><!--alias ISOAMSB divonx --> +<!ENTITY doteq "≐" ><!--alias ISOAMSR esdot --> +<!ENTITY doteqdot "≑" ><!--alias ISOAMSR eDot --> +<!ENTITY DotEqual "≐" ><!--alias ISOAMSR esdot --> +<!ENTITY dotminus "∸" ><!--alias ISOAMSB minusd --> +<!ENTITY dotplus "∔" ><!--alias ISOAMSB plusdo --> +<!ENTITY dotsquare "⊡" ><!--alias ISOAMSB sdotb --> +<!ENTITY doublebarwedge "⌆" ><!--alias ISOAMSB Barwed --> +<!ENTITY DoubleContourIntegral "∯" ><!--alias ISOTECH Conint --> +<!ENTITY DoubleDot "¨" ><!--alias ISODIA die --> +<!ENTITY DoubleDownArrow "⇓" ><!--alias ISOAMSA dArr --> +<!ENTITY DoubleLeftArrow "⇐" ><!--alias ISOTECH lArr --> +<!ENTITY DoubleLeftRightArrow "⇔" ><!--alias ISOAMSA hArr --> +<!ENTITY DoubleLeftTee "⫤" ><!--alias for ⫤ --> +<!ENTITY DoubleLongLeftArrow "⇐" ><!--alias ISOAMSA xlArr --> +<!ENTITY DoubleLongLeftRightArrow "⇔" ><!--alias ISOAMSA xhArr --> +<!ENTITY DoubleLongRightArrow "⇒" ><!--alias ISOAMSA xrArr --> +<!ENTITY DoubleRightArrow "⇒" ><!--alias ISOTECH rArr --> +<!ENTITY DoubleRightTee "⊨" ><!--alias ISOAMSR vDash --> +<!ENTITY DoubleUpArrow "⇑" ><!--alias ISOAMSA uArr --> +<!ENTITY DoubleUpDownArrow "⇕" ><!--alias ISOAMSA vArr --> +<!ENTITY DoubleVerticalBar "∥" ><!--alias ISOTECH par --> +<!ENTITY downarrow "↓" ><!--alias ISONUM darr --> +<!ENTITY Downarrow "⇓" ><!--alias ISOAMSA dArr --> +<!ENTITY DownArrow "↓" ><!--alias ISONUM darr --> +<!ENTITY DownArrowUpArrow "⇵" ><!--alias ISOAMSA duarr --> +<!ENTITY downdownarrows "⇊" ><!--alias ISOAMSA ddarr --> +<!ENTITY downharpoonleft "⇃" ><!--alias ISOAMSA dharl --> +<!ENTITY downharpoonright "⇂" ><!--alias ISOAMSA dharr --> +<!ENTITY DownLeftVector "↽" ><!--alias ISOAMSA lhard --> +<!ENTITY DownRightVector "⇁" ><!--alias ISOAMSA rhard --> +<!ENTITY DownTee "⊤" ><!--alias ISOTECH top --> +<!ENTITY drbkarow "⤐" ><!--alias ISOAMSA RBarr --> +<!ENTITY Element "∈" ><!--alias ISOTECH isinv --> +<!ENTITY emptyset "∅⁣" ><!--alias ISOAMSO empty --> +<!ENTITY eqcirc "≖" ><!--alias ISOAMSR ecir --> +<!ENTITY eqcolon "≕" ><!--alias ISOAMSR ecolon --> +<!ENTITY eqsim "≂" ><!--alias ISOAMSR esim --> +<!ENTITY eqslantgtr "⋝" ><!--alias ISOAMSR egs --> +<!ENTITY eqslantless "⋜" ><!--alias ISOAMSR els --> +<!ENTITY EqualTilde "≂" ><!--alias ISOAMSR esim --> +<!ENTITY Equilibrium "⇌" ><!--alias ISOAMSA rlhar --> +<!ENTITY Exists "∃" ><!--alias ISOTECH exist --> +<!ENTITY fallingdotseq "≒" ><!--alias ISOAMSR efDot --> +<!ENTITY ForAll "∀" ><!--alias ISOTECH forall --> +<!ENTITY geq "≥" ><!--alias ISOTECH ge --> +<!ENTITY geqq "≧" ><!--alias ISOAMSR gE --> +<!ENTITY geqslant "⩾" ><!--alias ISOAMSR ges --> +<!ENTITY gg "≫" ><!--alias ISOAMSR Gt --> +<!ENTITY ggg "⋙" ><!--alias ISOAMSR Gg --> +<!ENTITY gnapprox "⪊" ><!--alias ISOAMSN gnap --> +<!ENTITY gneq "≩" ><!--alias ISOAMSN gne --> +<!ENTITY gneqq "≩" ><!--alias ISOAMSN gnE --> +<!ENTITY GreaterEqual "≥" ><!--alias ISOTECH ge --> +<!ENTITY GreaterEqualLess "⋛" ><!--alias ISOAMSR gel --> +<!ENTITY GreaterFullEqual "≧" ><!--alias ISOAMSR gE --> +<!ENTITY GreaterLess "≷" ><!--alias ISOAMSR gl --> +<!ENTITY GreaterSlantEqual "⩾" ><!--alias ISOAMSR ges --> +<!ENTITY GreaterTilde "≳" ><!--alias ISOAMSR gsim --> +<!ENTITY gtrapprox "≳" ><!--alias ISOAMSR gap --> +<!ENTITY gtrdot "⋗" ><!--alias ISOAMSR gtdot --> +<!ENTITY gtreqless "⋛" ><!--alias ISOAMSR gel --> +<!ENTITY gtreqqless "⋛" ><!--alias ISOAMSR gEl --> +<!ENTITY gtrless "≷" ><!--alias ISOAMSR gl --> +<!ENTITY gtrsim "≳" ><!--alias ISOAMSR gsim --> +<!ENTITY gvertneqq "≩̸" ><!--alias ISOAMSN gvnE --> +<!ENTITY Hacek "ˇ" ><!--alias ISODIA caron --> +<!ENTITY Hat "̂" ><!--circumflex accent (circ in ISODIA) --> +<!ENTITY hbar "ℏ" ><!--alias ISOAMSO plank --> +<!ENTITY heartsuit "♡" ><!--ISOPUB hearts --> +<!ENTITY hksearow "⤥" ><!--alias ISOAMSA searhk --> +<!ENTITY hkswarow "⤦" ><!--alias ISOAMSA swarhk --> +<!ENTITY hookleftarrow "↩" ><!--alias ISOAMSA larrhk --> +<!ENTITY hookrightarrow "↪" ><!--alias ISOAMSA rarrhk --> +<!ENTITY hslash "ℏ" ><!--alias ISOAMSO plankv --> +<!ENTITY HumpDownHump "≎" ><!--alias ISOAMSR bump --> +<!ENTITY HumpEqual "≏" ><!--alias ISOAMSR bumpe --> +<!ENTITY iiiint "⨌" ><!--alias ISOTECH qint --> +<!ENTITY iiint "∭" ><!--alias ISOTECH tint --> +<!ENTITY Im "ℑ" ><!--alias ISOAMSO image --> +<!ENTITY imagpart "ℑ" ><!--alias ISOAMSO image --> +<!ENTITY Implies "⇒" ><!--alias ISOTECH rArr --> +<!ENTITY in "∈" ><!--ISOTECH isin --> +<!ENTITY Integral "∫" ><!--alias ISOTECH int --> +<!ENTITY intercal "⊺" ><!--alias ISOAMSB intcal --> +<!ENTITY Intersection "⋂" ><!--alias ISOAMSB xcap --> +<!ENTITY intprod "⨼" ><!--alias ISOAMSB iprod --> +<!ENTITY langle "〈" ><!--alias ISOTECH lang --> +<!ENTITY lbrace "{" ><!--alias ISONUM lcub --> +<!ENTITY lbrack "[" ><!--alias ISONUM lsqb --> +<!ENTITY LeftAngleBracket "〈" ><!--alias ISOTECH lang --> +<!ENTITY leftarrow "←" ><!--alias ISONUM larr --> +<!ENTITY Leftarrow "⇐" ><!--alias ISOTECH lArr --> +<!ENTITY LeftArrow "←" ><!--alias ISONUM larr --> +<!ENTITY LeftArrowRightArrow "⇆" ><!--alias ISOAMSA lrarr --> +<!ENTITY leftarrowtail "↢" ><!--alias ISOAMSA larrtl --> +<!ENTITY LeftCeiling "⌈" ><!--alias ISOAMSC lceil --> +<!ENTITY LeftDoubleBracket "〚" ><!--left double bracket delimiter --> +<!ENTITY LeftDownVector "⇃" ><!--alias ISOAMSA dharl --> +<!ENTITY LeftFloor "⌊" ><!--alias ISOAMSC lfloor --> +<!ENTITY leftharpoondown "↽" ><!--alias ISOAMSA lhard --> +<!ENTITY leftharpoonup "↼" ><!--alias ISOAMSA lharu --> +<!ENTITY leftleftarrows "⇇" ><!--alias ISOAMSA llarr --> +<!ENTITY leftrightarrow "↔" ><!--alias ISOAMSA harr --> +<!ENTITY Leftrightarrow "⇔" ><!--alias ISOAMSA hArr --> +<!ENTITY LeftRightArrow "↔" ><!--alias ISOAMSA harr --> +<!ENTITY leftrightarrows "⇆" ><!--alias ISOAMSA lrarr --> +<!ENTITY leftrightharpoons "⇋" ><!--alias ISOAMSA lrhar --> +<!ENTITY leftrightsquigarrow "↭" ><!--alias ISOAMSA harrw --> +<!ENTITY LeftTee "⊣" ><!--alias ISOAMSR dashv --> +<!ENTITY leftthreetimes "⋋" ><!--alias ISOAMSB lthree --> +<!ENTITY LeftTriangle "⊲" ><!--alias ISOAMSR vltri --> +<!ENTITY LeftTriangleEqual "⊴" ><!--alias ISOAMSR ltrie --> +<!ENTITY LeftUpVector "↿" ><!--alias ISOAMSA uharl --> +<!ENTITY LeftVector "↼" ><!--alias ISOAMSA lharu --> +<!ENTITY leq "≤" ><!--alias ISOTECH le --> +<!ENTITY leqq "≦" ><!--alias ISOAMSR lE --> +<!ENTITY leqslant "⩽" ><!--alias ISOAMSR les --> +<!ENTITY lessapprox "≲" ><!--alias ISOAMSR lap --> +<!ENTITY lessdot "⋖" ><!--alias ISOAMSR ltdot --> +<!ENTITY lesseqgtr "⋚" ><!--alias ISOAMSR leg --> +<!ENTITY lesseqqgtr "⋚" ><!--alias ISOAMSR lEg --> +<!ENTITY LessEqualGreater "⋚" ><!--alias ISOAMSR leg --> +<!ENTITY LessFullEqual "≦" ><!--alias ISOAMSR lE --> +<!ENTITY LessGreater "≶" ><!--alias ISOAMSR lg --> +<!ENTITY lessgtr "≶" ><!--alias ISOAMSR lg --> +<!ENTITY lesssim "≲" ><!--alias ISOAMSR lsim --> +<!ENTITY LessSlantEqual "⩽" ><!--alias ISOAMSR les --> +<!ENTITY LessTilde "≲" ><!--alias ISOAMSR lsim --> +<!ENTITY ll "≪" ><!--alias ISOAMSR Lt --> +<!ENTITY llcorner "⌞" ><!--alias ISOAMSC dlcorn --> +<!ENTITY Lleftarrow "⇚" ><!--alias ISOAMSA lAarr --> +<!ENTITY lmoustache "⦘" ><!--alias ISOAMSC lmoust --> +<!ENTITY lnapprox "⪉" ><!--alias ISOAMSN lnap --> +<!ENTITY lneq "≨" ><!--alias ISOAMSN lne --> +<!ENTITY lneqq "≨" ><!--alias ISOAMSN lnE --> +<!ENTITY longleftarrow "←" ><!--alias ISOAMSA xlarr --> +<!ENTITY Longleftarrow "⇐" ><!--alias ISOAMSA xlArr --> +<!ENTITY LongLeftArrow "←" ><!--alias ISOAMSA xlarr --> +<!ENTITY longleftrightarrow "↔" ><!--alias ISOAMSA xharr --> +<!ENTITY Longleftrightarrow "⇔" ><!--alias ISOAMSA xhArr --> +<!ENTITY LongLeftRightArrow "↔" ><!--alias ISOAMSA xharr --> +<!ENTITY longmapsto "↦" ><!--alias ISOAMSA xmap --> +<!ENTITY longrightarrow "→" ><!--alias ISOAMSA xrarr --> +<!ENTITY Longrightarrow "⇒" ><!--alias ISOAMSA xrArr --> +<!ENTITY LongRightArrow "→" ><!--alias ISOAMSA xrarr --> +<!ENTITY looparrowleft "↫" ><!--alias ISOAMSA larrlp --> +<!ENTITY looparrowright "↬" ><!--alias ISOAMSA rarrlp --> +<!ENTITY LowerLeftArrow "↙" ><!--alias ISOAMSA swarr --> +<!ENTITY LowerRightArrow "↘" ><!--alias ISOAMSA searr --> +<!ENTITY lozenge "◊" ><!--alias ISOPUB loz --> +<!ENTITY lrcorner "⌟" ><!--alias ISOAMSC drcorn --> +<!ENTITY Lsh "↰" ><!--alias ISOAMSA lsh --> +<!ENTITY lvertneqq "≨̸" ><!--alias ISOAMSN lvnE --> +<!ENTITY maltese "✠" ><!--alias ISOPUB malt --> +<!ENTITY mapsto "↦" ><!--alias ISOAMSA map --> +<!ENTITY measuredangle "∡" ><!--alias ISOAMSO angmsd --> +<!ENTITY MinusPlus "∓" ><!--alias ISOTECH mnplus --> +<!ENTITY mp "∓" ><!--alias ISOTECH mnplus --> +<!ENTITY multimap "⊸" ><!--alias ISOAMSA mumap --> +<!ENTITY napprox "≉" ><!--alias ISOAMSN nap --> +<!ENTITY natural "♮" ><!--alias ISOPUB natur --> +<!ENTITY nearrow "↗" ><!--alias ISOAMSA nearr --> +<!ENTITY NestedGreaterGreater "≫" ><!--alias ISOAMSR Gt --> +<!ENTITY NestedLessLess "≪" ><!--alias ISOAMSR Lt --> +<!ENTITY nexists "∄" ><!--alias ISOAMSO nexist --> +<!ENTITY ngeq "≱⃥" ><!--alias ISOAMSN nge --> +<!ENTITY ngeqq "≱" ><!--alias ISOAMSN ngE --> +<!ENTITY ngeqslant "≱" ><!--alias ISOAMSN nges --> +<!ENTITY ngtr "≯" ><!--alias ISOAMSN ngt --> +<!ENTITY nleftarrow "↚" ><!--alias ISOAMSA nlarr --> +<!ENTITY nLeftarrow "⇍" ><!--alias ISOAMSA nlArr --> +<!ENTITY nleftrightarrow "↮" ><!--alias ISOAMSA nharr --> +<!ENTITY nLeftrightarrow "⇎" ><!--alias ISOAMSA nhArr --> +<!ENTITY nleq "≰⃥" ><!--alias ISOAMSN nle --> +<!ENTITY nleqq "≰" ><!--alias ISOAMSN nlE --> +<!ENTITY nleqslant "≰" ><!--alias ISOAMSN nles --> +<!ENTITY nless "≮" ><!--alias ISOAMSN nlt --> +<!ENTITY NotCongruent "≢" ><!--alias ISOAMSN nequiv --> +<!ENTITY NotDoubleVerticalBar "∦" ><!--alias ISOAMSN npar --> +<!ENTITY NotElement "∉" ><!--alias ISOTECH notin --> +<!ENTITY NotEqual "≠" ><!--alias ISOTECH ne --> +<!ENTITY NotExists "∄" ><!--alias ISOAMSO nexist --> +<!ENTITY NotGreater "≯" ><!--alias ISOAMSN ngt --> +<!ENTITY NotGreaterEqual "≱⃥" ><!--alias ISOAMSN nge --> +<!ENTITY NotGreaterFullEqual "≰" ><!--alias ISOAMSN nlE --> +<!ENTITY NotGreaterGreater "≫̸⁣" ><!--alias ISOAMSN nGtv --> +<!ENTITY NotGreaterLess "≹" ><!--alias ISOAMSN ntvgl --> +<!ENTITY NotGreaterSlantEqual "≱" ><!--alias ISOAMSN nges --> +<!ENTITY NotGreaterTilde "≵" ><!--alias ISOAMSN ngsim --> +<!ENTITY NotLeftTriangle "⋪" ><!--alias ISOAMSN nltri --> +<!ENTITY NotLeftTriangleEqual "⋬" ><!--alias ISOAMSN nltrie --> +<!ENTITY NotLess "≮" ><!--alias ISOAMSN nlt --> +<!ENTITY NotLessEqual "≰⃥" ><!--alias ISOAMSN nle --> +<!ENTITY NotLessGreater "≸" ><!--alias ISOAMSN ntvlg --> +<!ENTITY NotLessLess "≪̸⁣" ><!--alias ISOAMSN nLtv --> +<!ENTITY NotLessSlantEqual "≰" ><!--alias ISOAMSN nles --> +<!ENTITY NotLessTilde "≴" ><!--alias ISOAMSN nlsim --> +<!ENTITY NotPrecedes "⊀" ><!--alias ISOAMSN npr --> +<!ENTITY NotPrecedesEqual "⪯̸" ><!--alias ISOAMSN npre --> +<!ENTITY NotPrecedesSlantEqual "⋠" ><!--alias ISOAMSN nprcue --> +<!ENTITY NotReverseElement "∌" ><!--alias ISOTECH notniva --> +<!ENTITY NotRightTriangle "⋫" ><!--alias ISOAMSN nrtri --> +<!ENTITY NotRightTriangleEqual "⋭" ><!--alias ISOAMSN nrtrie --> +<!ENTITY NotSquareSubsetEqual "⋢" ><!--alias ISOAMSN nsqsube --> +<!ENTITY NotSquareSupersetEqual "⋣" ><!--alias ISOAMSN nsqsupe --> +<!ENTITY NotSubset "⊄" ><!--alias ISOAMSN vnsub --> +<!ENTITY NotSubsetEqual "⊈" ><!--alias ISOAMSN nsube --> +<!ENTITY NotSucceeds "⊁" ><!--alias ISOAMSN nsc --> +<!ENTITY NotSucceedsEqual "⪰̸" ><!--alias ISOAMSN nsce --> +<!ENTITY NotSucceedsSlantEqual "⋡" ><!--alias ISOAMSN nsccue --> +<!ENTITY NotSuperset "⊅" ><!--alias ISOAMSN vnsup --> +<!ENTITY NotSupersetEqual "⊉" ><!--alias ISOAMSN nsupe --> +<!ENTITY NotTilde "≁" ><!--alias ISOAMSN nsim --> +<!ENTITY NotTildeEqual "≄" ><!--alias ISOAMSN nsime --> +<!ENTITY NotTildeFullEqual "≇" ><!--alias ISOAMSN ncong --> +<!ENTITY NotTildeTilde "≉" ><!--alias ISOAMSN nap --> +<!ENTITY NotVerticalBar "∤" ><!--alias ISOAMSN nmid --> +<!ENTITY nparallel "∦" ><!--alias ISOAMSN npar --> +<!ENTITY nprec "⊀" ><!--alias ISOAMSN npr --> +<!ENTITY npreceq "⪯̸" ><!--alias ISOAMSN npre --> +<!ENTITY nrightarrow "↛" ><!--alias ISOAMSA nrarr --> +<!ENTITY nRightarrow "⇏" ><!--alias ISOAMSA nrArr --> +<!ENTITY nshortmid "∤⁣" ><!--alias ISOAMSN nsmid --> +<!ENTITY nshortparallel "∦⁣" ><!--alias ISOAMSN nspar --> +<!ENTITY nsimeq "≄" ><!--alias ISOAMSN nsime --> +<!ENTITY nsubset "⊄" ><!--alias ISOAMSN vnsub --> +<!ENTITY nsubseteq "⊈" ><!--alias ISOAMSN nsube --> +<!ENTITY nsubseteqq "⊈" ><!--alias ISOAMSN nsubE --> +<!ENTITY nsucc "⊁" ><!--alias ISOAMSN nsc --> +<!ENTITY nsucceq "⪰̸" ><!--alias ISOAMSN nsce --> +<!ENTITY nsupset "⊅" ><!--alias ISOAMSN vnsup --> +<!ENTITY nsupseteq "⊉" ><!--alias ISOAMSN nsupe --> +<!ENTITY nsupseteqq "⊉" ><!--alias ISOAMSN nsupE --> +<!ENTITY ntriangleleft "⋪" ><!--alias ISOAMSN nltri --> +<!ENTITY ntrianglelefteq "⋬" ><!--alias ISOAMSN nltrie --> +<!ENTITY ntriangleright "⋫" ><!--alias ISOAMSN nrtri --> +<!ENTITY ntrianglerighteq "⋭" ><!--alias ISOAMSN nrtrie --> +<!ENTITY nwarrow "↖" ><!--alias ISOAMSA nwarr --> +<!ENTITY oint "∮" ><!--alias ISOTECH conint --> +<!ENTITY OpenCurlyDoubleQuote "“" ><!--alias ISONUM ldquo --> +<!ENTITY OpenCurlyQuote "‘" ><!--alias ISONUM lsquo --> +<!ENTITY orderof "ℴ" ><!--alias ISOTECH order --> +<!ENTITY parallel "∥" ><!--alias ISOTECH par --> +<!ENTITY PartialD "∂" ><!--alias ISOTECH part --> +<!ENTITY pitchfork "⋔" ><!--alias ISOAMSR fork --> +<!ENTITY PlusMinus "±" ><!--alias ISONUM plusmn --> +<!ENTITY pm "±" ><!--alias ISONUM plusmn --> +<!ENTITY prec "≺" ><!--alias ISOAMSR pr --> +<!ENTITY precapprox "≾" ><!--alias ISOAMSR prap --> +<!ENTITY preccurlyeq "≼" ><!--alias ISOAMSR prcue --> +<!ENTITY Precedes "≺" ><!--alias ISOAMSR pr --> +<!ENTITY PrecedesEqual "⪯" ><!--alias ISOAMSR pre --> +<!ENTITY PrecedesSlantEqual "≼" ><!--alias ISOAMSR prcue --> +<!ENTITY PrecedesTilde "≾" ><!--alias ISOAMSR prsim --> +<!ENTITY preceq "⪯" ><!--alias ISOAMSR pre --> +<!ENTITY precnapprox "⋨" ><!--alias ISOAMSN prnap --> +<!ENTITY precneqq "⪵" ><!--alias ISOAMSN prnE --> +<!ENTITY precnsim "⋨" ><!--alias ISOAMSN prnsim --> +<!ENTITY precsim "≾" ><!--alias ISOAMSR prsim --> +<!ENTITY Proportion "∷" ><!--alias ISOAMSR Colon --> +<!ENTITY Proportional "∝" ><!--alias ISOTECH prop --> +<!ENTITY propto "∝" ><!--alias ISOTECH prop --> +<!ENTITY questeq "≟" ><!--alias ISOAMSR equest --> +<!ENTITY rangle "〉" ><!--alias ISOTECH rang --> +<!ENTITY rbrace "}" ><!--alias ISONUM rcub --> +<!ENTITY rbrack "]" ><!--alias ISONUM rsqb --> +<!ENTITY Re "ℜ" ><!--alias ISOAMSO real --> +<!ENTITY realpart "ℜ" ><!--alias ISOAMSO real --> +<!ENTITY ReverseElement "∋" ><!--alias ISOTECH niv --> +<!ENTITY ReverseEquilibrium "⇋" ><!--alias ISOAMSA lrhar --> +<!ENTITY ReverseUpEquilibrium "⥯" ><!--alias ISOAMSA duhar --> +<!ENTITY RightAngleBracket "〉" ><!--alias ISOTECH rang --> +<!ENTITY rightarrow "→" ><!--alias ISONUM rarr --> +<!ENTITY Rightarrow "⇒" ><!--alias ISOTECH rArr --> +<!ENTITY RightArrow "→" ><!--alias ISONUM rarr --> +<!ENTITY RightArrowLeftArrow "⇄" ><!--alias ISOAMSA rlarr --> +<!ENTITY rightarrowtail "↣" ><!--alias ISOAMSA rarrtl --> +<!ENTITY RightCeiling "⌉" ><!--alias ISOAMSC rceil --> +<!ENTITY RightDoubleBracket "〛" ><!--right double bracket delimiter --> +<!ENTITY RightDownVector "⇂" ><!--alias ISOAMSA dharr --> +<!ENTITY RightFloor "⌋" ><!--alias ISOAMSC rfloor --> +<!ENTITY rightharpoondown "⇁" ><!--alias ISOAMSA rhard --> +<!ENTITY rightharpoonup "⇀" ><!--alias ISOAMSA rharu --> +<!ENTITY rightleftarrows "⇄" ><!--alias ISOAMSA rlarr --> +<!ENTITY rightleftharpoons "⇌" ><!--alias ISOAMSA rlhar --> +<!ENTITY rightrightarrows "⇉" ><!--alias ISOAMSA rrarr --> +<!ENTITY rightsquigarrow "⇝" ><!--alias ISOAMSA rarrw --> +<!ENTITY RightTee "⊢" ><!--alias ISOAMSR vdash --> +<!ENTITY RightTeeArrow "↦" ><!--alias ISOAMSA map --> +<!ENTITY rightthreetimes "⋌" ><!--alias ISOAMSB rthree --> +<!ENTITY RightTriangle "⊳" ><!--alias ISOAMSR vrtri --> +<!ENTITY RightTriangleEqual "⊵" ><!--alias ISOAMSR rtrie --> +<!ENTITY RightUpVector "↾" ><!--alias ISOAMSA uharr --> +<!ENTITY RightVector "⇀" ><!--alias ISOAMSA rharu --> +<!ENTITY risingdotseq "≓" ><!--alias ISOAMSR erDot --> +<!ENTITY rmoustache "⦗" ><!--alias ISOAMSC rmoust --> +<!ENTITY Rrightarrow "⇛" ><!--alias ISOAMSA rAarr --> +<!ENTITY Rsh "↱" ><!--alias ISOAMSA rsh --> +<!ENTITY searrow "↘" ><!--alias ISOAMSA searr --> +<!ENTITY setminus "∖" ><!--alias ISOAMSB setmn --> +<!ENTITY ShortLeftArrow "←⁣" ><!--alias ISOAMSA slarr --> +<!ENTITY shortmid "∣⁣" ><!--alias ISOAMSR smid --> +<!ENTITY shortparallel "∥⁣" ><!--alias ISOAMSR spar --> +<!ENTITY ShortRightArrow "→⁣" ><!--alias ISOAMSA srarr --> +<!ENTITY simeq "≃" ><!--alias ISOTECH sime --> +<!ENTITY SmallCircle "∘" ><!--alias ISOTECH compfn --> +<!ENTITY smallsetminus "∖" ><!--alias ISOAMSB ssetmn --> +<!ENTITY spadesuit "♠" ><!--ISOPUB spades --> +<!ENTITY Sqrt "√" ><!--alias ISOTECH radic --> +<!ENTITY sqsubset "⊏" ><!--alias ISOAMSR sqsub --> +<!ENTITY sqsubseteq "⊑" ><!--alias ISOAMSR sqsube --> +<!ENTITY sqsupset "⊐" ><!--alias ISOAMSR sqsup --> +<!ENTITY sqsupseteq "⊒" ><!--alias ISOAMSR sqsupe --> +<!ENTITY Square "□" ><!--alias for square --> +<!ENTITY SquareIntersection "⊓" ><!--alias ISOAMSB sqcap --> +<!ENTITY SquareSubset "⊏" ><!--alias ISOAMSR sqsub --> +<!ENTITY SquareSubsetEqual "⊑" ><!--alias ISOAMSR sqsube --> +<!ENTITY SquareSuperset "⊐" ><!--alias ISOAMSR sqsup --> +<!ENTITY SquareSupersetEqual "⊒" ><!--alias ISOAMSR sqsupe --> +<!ENTITY SquareUnion "⊔" ><!--alias ISOAMSB sqcup --> +<!ENTITY Star "⋆" ><!--alias ISOAMSB sstarf --> +<!ENTITY straightepsilon "ε" ><!--alias ISOGRK3 epsi --> +<!ENTITY straightphi "φ" ><!--alias ISOGRK3 phi --> +<!ENTITY subset "⊂" ><!--alias ISOTECH sub --> +<!ENTITY Subset "⋐" ><!--alias ISOAMSR Sub --> +<!ENTITY subseteq "⊆" ><!--alias ISOTECH sube --> +<!ENTITY subseteqq "⊆" ><!--alias ISOAMSR subE --> +<!ENTITY SubsetEqual "⊆" ><!--alias ISOTECH sube --> +<!ENTITY subsetneq "⊊" ><!--alias ISOAMSN subne --> +<!ENTITY subsetneqq "⊊" ><!--alias ISOAMSN subnE --> +<!ENTITY succ "≻" ><!--alias ISOAMSR sc --> +<!ENTITY succapprox "≿" ><!--alias ISOAMSR scap --> +<!ENTITY succcurlyeq "≽" ><!--alias ISOAMSR sccue --> +<!ENTITY Succeeds "≻" ><!--alias ISOAMSR sc --> +<!ENTITY SucceedsEqual "≽" ><!--alias ISOAMSR sce --> +<!ENTITY SucceedsSlantEqual "≽" ><!--alias ISOAMSR sccue --> +<!ENTITY SucceedsTilde "≿" ><!--alias ISOAMSR scsim --> +<!ENTITY succeq "≽" ><!--alias ISOAMSR sce --> +<!ENTITY succnapprox "⋩" ><!--alias ISOAMSN scnap --> +<!ENTITY succneqq "⪶" ><!--alias ISOAMSN scnE --> +<!ENTITY succnsim "⋩" ><!--alias ISOAMSN scnsim --> +<!ENTITY succsim "≿" ><!--alias ISOAMSR scsim --> +<!ENTITY SuchThat "∋" ><!--ISOTECH ni --> +<!ENTITY Sum "∑" ><!--alias ISOAMSB sum --> +<!ENTITY Superset "⊃" ><!--alias ISOTECH sup --> +<!ENTITY SupersetEqual "⊇" ><!--alias ISOTECH supe --> +<!ENTITY supset "⊃" ><!--alias ISOTECH sup --> +<!ENTITY Supset "⋑" ><!--alias ISOAMSR Sup --> +<!ENTITY supseteq "⊇" ><!--alias ISOTECH supe --> +<!ENTITY supseteqq "⊇" ><!--alias ISOAMSR supE --> +<!ENTITY supsetneq "⊋" ><!--alias ISOAMSN supne --> +<!ENTITY supsetneqq "⊋" ><!--alias ISOAMSN supnE --> +<!ENTITY swarrow "↙" ><!--alias ISOAMSA swarr --> +<!ENTITY therefore "∴" ><!--alias ISOTECH there4 --> +<!ENTITY Therefore "∴" ><!--alias ISOTECH there4 --> +<!ENTITY thickapprox "≈⁣" ><!--ISOAMSR thkap --> +<!ENTITY thicksim "∼" ><!--ISOAMSR thksim --> +<!ENTITY ThinSpace " " ><!--space of width 3/18 em alias ISOPUB thinsp --> +<!ENTITY Tilde "∼" ><!--alias ISOTECH sim --> +<!ENTITY TildeEqual "≃" ><!--alias ISOTECH sime --> +<!ENTITY TildeFullEqual "≅" ><!--alias ISOTECH cong --> +<!ENTITY TildeTilde "≈" ><!--alias ISOTECH ap --> +<!ENTITY toea "⤨" ><!--alias ISOAMSA nesear --> +<!ENTITY tosa "⤩" ><!--alias ISOAMSA seswar --> +<!ENTITY triangle "▵" ><!--alias ISOPUB utri --> +<!ENTITY triangledown "▿" ><!--alias ISOPUB dtri --> +<!ENTITY triangleleft "◃" ><!--alias ISOPUB ltri --> +<!ENTITY trianglelefteq "⊴" ><!--alias ISOAMSR ltrie --> +<!ENTITY triangleq "≜" ><!--alias ISOAMSR trie --> +<!ENTITY triangleright "▹" ><!--alias ISOPUB rtri --> +<!ENTITY trianglerighteq "⊵" ><!--alias ISOAMSR rtrie --> +<!ENTITY TripleDot "⃛" ><!--alias ISOTECH tdot --> +<!ENTITY twoheadleftarrow "↞" ><!--alias ISOAMSA Larr --> +<!ENTITY twoheadrightarrow "↠" ><!--alias ISOAMSA Rarr --> +<!ENTITY ulcorner "⌜" ><!--alias ISOAMSC ulcorn --> +<!ENTITY Union "⋃" ><!--alias ISOAMSB xcup --> +<!ENTITY UnionPlus "⊎" ><!--alias ISOAMSB uplus --> +<!ENTITY uparrow "↑" ><!--alias ISONUM uarr --> +<!ENTITY Uparrow "⇑" ><!--alias ISOAMSA uArr --> +<!ENTITY UpArrow "↑" ><!--alias ISONUM uarr --> +<!ENTITY UpArrowDownArrow "⇅" ><!--alias ISOAMSA udarr --> +<!ENTITY updownarrow "↕" ><!--alias ISOAMSA varr --> +<!ENTITY Updownarrow "⇕" ><!--alias ISOAMSA vArr --> +<!ENTITY UpDownArrow "↕" ><!--alias ISOAMSA varr --> +<!ENTITY UpEquilibrium "⥮" ><!--alias ISOAMSA udhar --> +<!ENTITY upharpoonleft "↿" ><!--alias ISOAMSA uharl --> +<!ENTITY upharpoonright "↾" ><!--alias ISOAMSA uharr --> +<!ENTITY UpperLeftArrow "↖" ><!--alias ISOAMSA nwarr --> +<!ENTITY UpperRightArrow "↗" ><!--alias ISOAMSA nearr --> +<!ENTITY upsilon "υ" ><!--alias ISOGRK3 upsi --> +<!ENTITY Upsilon "ϒ" ><!--alias ISOGRK3 Upsi --> +<!ENTITY UpTee "⊥" ><!--alias ISOTECH perp --> +<!ENTITY upuparrows "⇈" ><!--alias ISOAMSA uuarr --> +<!ENTITY urcorner "⌝" ><!--alias ISOAMSC urcorn --> +<!ENTITY varepsilon "ɛ" ><!--alias ISOGRK3 epsiv --> +<!ENTITY varkappa "ϰ" ><!--alias ISOGRK3 kappav --> +<!ENTITY varnothing "∅" ><!--alias ISOAMSO emptyv --> +<!ENTITY varphi "ϕ" ><!--alias ISOGRK3 phiv --> +<!ENTITY varpi "ϖ" ><!--alias ISOGRK3 piv --> +<!ENTITY varpropto "∝" ><!--alias ISOAMSR vprop --> +<!ENTITY varrho "ϱ" ><!--alias ISOGRK3 rhov --> +<!ENTITY varsigma "ς" ><!--alias ISOGRK3 sigmav --> +<!ENTITY varsubsetneq "⊊⁣" ><!--alias ISOAMSN vsubne --> +<!ENTITY varsubsetneqq "⊊⁣" ><!--alias ISOAMSN vsubnE --> +<!ENTITY varsupsetneq "⊋⁣" ><!--alias ISOAMSN vsupne --> +<!ENTITY varsupsetneqq "⊋⁣" ><!--alias ISOAMSN vsupnE --> +<!ENTITY vartheta "ϑ" ><!--alias ISOGRK3 thetav --> +<!ENTITY vartriangleleft "⊲" ><!--alias ISOAMSR vltri --> +<!ENTITY vartriangleright "⊳" ><!--alias ISOAMSR vrtri --> +<!ENTITY vee "∨" ><!--alias ISOTECH or --> +<!ENTITY Vee "⋁" ><!--alias ISOAMSB xvee --> +<!ENTITY vert "|" ><!--alias ISONUM verbar --> +<!ENTITY Vert "‖" ><!--alias ISOTECH Verbar --> +<!ENTITY VerticalBar "∣" ><!--alias ISOAMSR mid --> +<!ENTITY VerticalTilde "≀" ><!--alias ISOAMSB wreath --> +<!ENTITY VeryThinSpace " " ><!--space of width 1/18 em alias ISOPUB hairsp --> +<!ENTITY wedge "∧" ><!--alias ISOTECH and --> +<!ENTITY Wedge "⋀" ><!--alias ISOAMSB xwedge --> +<!ENTITY wp "℘" ><!--alias ISOAMSO weierp --> +<!ENTITY wr "≀" ><!--alias ISOAMSB wreath --> diff --git a/docs/docbook/xslt/db2latex/mathml/ent/mmlextra.ent b/docs/docbook/xslt/db2latex/mathml/ent/mmlextra.ent new file mode 100644 index 0000000000..e76de448cc --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/ent/mmlextra.ent @@ -0,0 +1,134 @@ + +<!-- + File mmlextra.ent produced by the XSL script mmldtd.xsl + from input data in unicode.xml. + + Please report any errors to + David Carlisle <davidc@nag.co.uk>. + + The numeric character values assigned to each entity + (should) match either official Unicode assignments + or assignments provisionally allocated by the + Unicode Consortium based on the characters in the `STIX' + propsal for mathematics. Note that these assignments + have not been ratified by the corresponding ISO + committee and thus should be considered liable to + change. + +--> + +<!ENTITY af "⁡" ><!--short form of ⁡ --> +<!ENTITY ApplyFunction "⁡" ><!--character showing function application in presentation tagging --> +<!ENTITY Assign "≔" ><!--assignment operator --> +<!ENTITY CapitalDifferentialD "ⅅ" ><!--D for use in differentials, e.g., within integrals --> +<!ENTITY Cayleys "ℭ" ><!--the non-associative ring of octonions or Cayley numbers --> +<!ENTITY complexes "ℂ" ><!--the field of complex numbers --> +<!ENTITY Cross "⨯" ><!--cross or vector product --> +<!ENTITY dd "ⅆ" ><!--short form of ⅆ --> +<!ENTITY DD "ⅅ" ><!--short form of CapitalDifferentialD --> +<!ENTITY DifferentialD "ⅆ" ><!--d for use in differentials, e.g., within integrals --> +<!ENTITY DownArrowBar "⤓" ><!--down arrow to bar --> +<!ENTITY DownBreve "̑" ><!--breve, inverted (non-spacing) --> +<!ENTITY DownLeftRightVector "⥐" ><!--left-down-right-down harpoon --> +<!ENTITY DownLeftTeeVector "⥞" ><!--left-down harpoon from bar --> +<!ENTITY DownLeftVectorBar "⥖" ><!--left-down harpoon to bar --> +<!ENTITY DownRightTeeVector "⥟" ><!--right-down harpoon from bar --> +<!ENTITY DownRightVectorBar "⥗" ><!--right-down harpoon to bar --> +<!ENTITY DownTeeArrow "↧" ><!--alias for mapstodown --> +<!ENTITY ee "ⅇ" ><!--short form of ⅇ --> +<!ENTITY EmptySmallSquare "◽" ><!--empty small square --> +<!ENTITY EmptyVerySmallSquare "◽" ><!--empty small square --> +<!ENTITY Equal "⩵" ><!--two consecutive equal signs --> +<!ENTITY expectation "ℰ" ><!--expectation (operator) --> +<!ENTITY exponentiale "ℯ" ><!--base of the Napierian logarithms --> +<!ENTITY ExponentialE "ⅇ" ><!--e use for the exponential base of the natural logarithms --> +<!ENTITY FilledSmallSquare "◾" ><!--filled small square --> +<!ENTITY FilledVerySmallSquare "◾" ><!--filled very small square --> +<!ENTITY Fouriertrf "ℱ" ><!--Fourier transform --> +<!ENTITY GreaterGreater "⪢" ><!--alias for GT --> +<!ENTITY HilbertSpace "ℋ" ><!--Hilbert space --> +<!ENTITY HorizontalLine "─" ><!--short horizontal line --> +<!ENTITY ic "​" ><!--short form of ⁣ --> +<!ENTITY ii "ⅈ" ><!--short form of ⅈ --> +<!ENTITY ImaginaryI "ⅈ" ><!--i for use as a square root of -1 --> +<!ENTITY imagline "ℐ" ><!--the geometric imaginary line --> +<!ENTITY integers "ℤ" ><!--the ring of integers --> +<!ENTITY InvisibleComma "​" ><!--used as a separator, e.g., in indices --> +<!ENTITY InvisibleTimes "⁢" ><!--marks multiplication when it is understood without a mark --> +<!ENTITY it "⁢" ><!--short form of ⁢ --> +<!ENTITY Laplacetrf "ℒ" ><!--Laplace transform --> +<!ENTITY larrb "⇤" ><!--leftwards arrow to bar --> +<!ENTITY LeftArrowBar "⇤" ><!--alias for larrb --> +<!ENTITY LeftDownTeeVector "⥡" ><!--down-left harpoon from bar --> +<!ENTITY LeftDownVectorBar "⥙" ><!--down-left harpoon to bar --> +<!ENTITY LeftRightVector "⥎" ><!--left-up-right-up harpoon --> +<!ENTITY LeftTeeArrow "↤" ><!--alias for mapstoleft --> +<!ENTITY LeftTeeVector "⥚" ><!--left-up harpoon from bar --> +<!ENTITY LeftTriangleBar "⧏" ><!--not left triangle, vertical bar --> +<!ENTITY LeftUpDownVector "⥑" ><!--up-left-down-left harpoon --> +<!ENTITY LeftUpTeeVector "⥠" ><!--up-left harpoon from bar --> +<!ENTITY LeftUpVectorBar "⥘" ><!--up-left harpoon to bar --> +<!ENTITY LeftVectorBar "⥒" ><!--left-up harpoon to bar --> +<!ENTITY LessLess "⪡" ><!--alias for Lt --> +<!ENTITY mapstodown "↧" ><!--downwards arrow from bar --> +<!ENTITY mapstoleft "↤" ><!--leftwards arrow from bar --> +<!ENTITY mapstoup "↥" ><!--upwards arrow from bar --> +<!ENTITY Mellintrf "ℳ" ><!--Mellin transform --> +<!ENTITY naturals "ℕ" ><!--the semi-ring of natural numbers --> +<!ENTITY nbump "≎̸" ><!--not bumpy equals --> +<!ENTITY nbumpe "≏̸" ><!--not bumpy single equals --> +<!ENTITY NegativeMediumSpace " ⁣" ><!--space of width -4/18 em --> +<!ENTITY NegativeThickSpace " ⁣" ><!--space of width -5/18 em --> +<!ENTITY NegativeThinSpace " ⁣" ><!--space of width -3/18 em --> +<!ENTITY NegativeVeryThinSpace " ⁣" ><!--space of width -1/18 em --> +<!ENTITY nesim "≂̸" ><!--not equal or similar --> +<!ENTITY NewLine "
" ><!--force a line break; line feed --> +<!ENTITY NoBreak "" ><!--never break line here --> +<!ENTITY NotCupCap "≭" ><!--alias for &nasymp; --> +<!ENTITY NotEqualTilde "≂̸" ><!--alias for ≂̸ --> +<!ENTITY NotHumpDownHump "≎̸" ><!--alias for ≎̸ --> +<!ENTITY NotHumpEqual "≏̸" ><!--alias for ≏̸ --> +<!ENTITY NotLeftTriangleBar "⧏̸" ><!--not left triangle, vertical bar --> +<!ENTITY NotNestedGreaterGreater "⒢̸" ><!--not double greater-than sign --> +<!ENTITY NotNestedLessLess "⒡̸" ><!--not double less-than sign --> +<!ENTITY NotRightTriangleBar "⧐̸" ><!--not vertical bar, right triangle --> +<!ENTITY NotSquareSubset "⊏̸" ><!--square not subset --> +<!ENTITY NotSquareSuperset "⊐̸" ><!--negated set-like partial order operator --> +<!ENTITY NotSucceedsTilde "≿̸" ><!--not succeeds or similar --> +<!ENTITY OverBar "¯" ><!--over bar --> +<!ENTITY OverBrace "︷" ><!--over brace --> +<!ENTITY OverBracket "⎴" ><!--over bracket --> +<!ENTITY OverParenthesis "︵" ><!--over parenthesis --> +<!ENTITY planckh "ℎ" ><!--the ring (skew field) of quaternions --> +<!ENTITY Poincareplane "ℌ" ><!--the Poincare upper half-plane --> +<!ENTITY primes "ℙ" ><!--the prime natural numbers --> +<!ENTITY Product "∏" ><!--alias for &prod --> +<!ENTITY quaternions "ℍ" ><!--the ring (skew field) of quaternions --> +<!ENTITY rarrb "⇥" ><!--leftwards arrow to bar --> +<!ENTITY rationals "ℚ" ><!--the field of rational numbers --> +<!ENTITY realine "ℛ" ><!--the geometric real line --> +<!ENTITY reals "ℝ" ><!--the field of real numbers --> +<!ENTITY RightArrowBar "⇥" ><!--alias for rarrb --> +<!ENTITY RightDownTeeVector "⥝" ><!--down-right harpoon from bar --> +<!ENTITY RightDownVectorBar "⥕" ><!--down-right harpoon to bar --> +<!ENTITY RightTeeVector "⥛" ><!--right-up harpoon from bar --> +<!ENTITY RightTriangleBar "⧐" ><!--vertical bar, right triangle --> +<!ENTITY RightUpDownVector "⥏" ><!--up-right-down-right harpoon --> +<!ENTITY RightUpTeeVector "⥜" ><!--up-right harpoon from bar --> +<!ENTITY RightUpVectorBar "⥔" ><!--up-right harpoon to bar --> +<!ENTITY RightVectorBar "⥓" ><!--up-right harpoon to bar --> +<!ENTITY RoundImplies "⥰" ><!--round implies --> +<!ENTITY RuleDelayed "⧴" ><!--rule-delayed (colon right arrow) --> +<!ENTITY ShortDownArrow "⌄⁣" ><!--short down arrow --> +<!ENTITY ShortUpArrow "⌃⁣" ><!--short up arrow --> +<!ENTITY Tab "	" ><!--tabulator stop; horizontal tabulation --> +<!ENTITY ThickSpace " " ><!--space of width 5/18 em --> +<!ENTITY UnderBar "̲" ><!--combining low line --> +<!ENTITY UnderBrace "︸" ><!--under brace --> +<!ENTITY UnderBracket "⎵" ><!--under bracket --> +<!ENTITY UpArrowBar "⤒" ><!--up arrow to bar --> +<!ENTITY UpTeeArrow "↥" ><!--Alias mapstoup --> +<!ENTITY VerticalLine "❘" ><!--short vertical line --> +<!ENTITY VerticalSeparator "❘" ><!--vertical separating operator --> +<!ENTITY zeetrf "ℨ" ><!--zee transform --> +<!ENTITY ZeroWidthSpace "​" ><!--zero width space --> diff --git a/docs/docbook/xslt/db2latex/mathml/latex.entities.dtd b/docs/docbook/xslt/db2latex/mathml/latex.entities.dtd new file mode 100644 index 0000000000..7ec703e2c7 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/latex.entities.dtd @@ -0,0 +1,7 @@ +<!ELEMENT character (#PCDATA)> + +<!ATTLIST character +entity CDATA #REQUIRED +arguments CDATA #IMPLIED +> + diff --git a/docs/docbook/xslt/db2latex/mathml/latex.entities.xml b/docs/docbook/xslt/db2latex/mathml/latex.entities.xml new file mode 100644 index 0000000000..e5290aba10 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/latex.entities.xml @@ -0,0 +1,12 @@ +<?xml version='1.0'?> +<!DOCTYPE latex SYSTEM "latex.entities.dtd" []> + +<latex> + <character entity="δ">\delta</character> + <character entity="κ">\kappa</character> + <character entity="π">\pi</character> + <character entity="−">-</character> + <character entity="β">\beta</character> + <character entity="̂">\sphat</character><!-- superscript=""--> + <character entity="̂" arguments="1">\hat</character> +</latex> diff --git a/docs/docbook/xslt/db2latex/mathml/mathml.content.constsymb.mod.xsl b/docs/docbook/xslt/db2latex/mathml/mathml.content.constsymb.mod.xsl new file mode 100644 index 0000000000..1317c483a7 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/mathml.content.constsymb.mod.xsl @@ -0,0 +1,101 @@ +<?xml version='1.0'?> +<!DOCTYPE xsl:stylesheet +[ + <!ENTITY % mmlalias PUBLIC "MathML alias" "ent/mmlalias.ent"> %mmlalias; + <!ENTITY % mmlextra PUBLIC "MathML extra" "ent/mmlextra.ent"> %mmlextra; +]> +<!--############################################################################# + | $Id: mathml.content.constsymb.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: MathML content markup, constants and symbols, 4.4.12. + | MathML namespace used -> mml + + ############################################################################## --> + +<xsl:stylesheet version='1.0' + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns="http://www.w3.org/1998/Math/MathML"> + +<!-- integer numbers --> +<xsl:template match="mml:integers"> + <xsl:text>\bbold Z </xsl:text> +</xsl:template> + +<!-- real numbers --> +<xsl:template match="mml:reals"> + <xsl:text>\bbold R </xsl:text> +</xsl:template> + +<!-- rational numbers --> +<xsl:template match="mml:rationals"> + <xsl:text>\bbold Q </xsl:text> +</xsl:template> + +<!-- natural numbers --> +<xsl:template match="mml:naturalnumbers"> + <xsl:text>\bbold N </xsl:text> +</xsl:template> + +<!-- complex numbers --> +<xsl:template match="mml:complexes"> + <xsl:text>\bbold C </xsl:text> +</xsl:template> + +<!-- prime numbers --> +<xsl:template match="mml:primes"> + <xsl:text>\bbold P </xsl:text> + <mi><xsl:text disable-output-escaping='yes'>&#x1D547;</xsl:text></mi> <!-- open face P --> <!-- UNICODE char does not work --> +</xsl:template> + + + + + + + +<!-- exponential base --> +<xsl:template match="mml:exponentiale"> + <xsl:text>\textrm{e} </xsl:text> +</xsl:template> + +<!-- square root of -1 --> +<xsl:template match="mml:imaginaryi"> + <xsl:text>\textrm{i} </xsl:text> +</xsl:template> + +<xsl:template match="mml:notanumber"> + <xsl:text>\NaN </xsl:text> +</xsl:template> + +<!-- logical constant for truth --> +<xsl:template match="mml:true"> + <xsl:text>true</xsl:text> +</xsl:template> + +<!-- logical constant for falsehood --> +<xsl:template match="mml:false"> + <xsl:text>false</xsl:text> +</xsl:template> + +<!-- empty set --> +<xsl:template match="mml:emptyset"> + <xsl:text>\empty</xsl:text> +</xsl:template> + +<!-- ratio of a circle's circumference to its diameter --> +<xsl:template match="mml:pi"> + <xsl:text>\pi</xsl:text> +</xsl:template> + +<!-- Euler's constant --> +<xsl:template match="mml:eulergamma"> + <xsl:text>\Gamma</xsl:text> +</xsl:template> + +<!-- Infinity --> +<xsl:template match="mml:infinity"> + <xsl:text>\infty</xsl:text> +</xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/mathml/mathml.content.functions.mod.xsl b/docs/docbook/xslt/db2latex/mathml/mathml.content.functions.mod.xsl new file mode 100644 index 0000000000..a317fc018b --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/mathml.content.functions.mod.xsl @@ -0,0 +1,725 @@ +<?xml version='1.0'?> +<!DOCTYPE xsl:stylesheet +[ + <!ENTITY % mmlalias PUBLIC "MathML alias" "ent/mmlalias.ent"> %mmlalias; + <!ENTITY % mmlextra PUBLIC "MathML extra" "ent/mmlextra.ent"> %mmlextra; +]> +<!--############################################################################# + | $Id: mathml.content.functions.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: MathML content markup. + | Note: these elements are not part of the DocBook DTD. I have extended + | the docbook DTD in order to support this tags, so that's why I have these + | templates here. + | + | MathML namespace used -> mml + + ############################################################################## --> + +<xsl:stylesheet version='1.0' + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns="http://www.w3.org/1998/Math/MathML"> + +<xsl:template match="mml:fn"> +</xsl:template> + +<!-- +<xsl:template match="mml:apply/lowlimit"> +<xsl:variable name="first" select="../child::*[1]"/> +</xsl:template> + +<xsl:template match="mml:apply/uplimit"> +<xsl:variable name="first" select="../child::*[1]"/> +</xsl:template> + +<xsl:template match="mml:apply/degree"> +<xsl:variable name="first" select="../child::*[1]"/> +</xsl:template> +--> + + +<!-- conditions --> +<!-- no support for deprecated reln--> +<xsl:template match="mml:condition"> + <xsl:text>{</xsl:text><xsl:apply-templates/><xsl:text>}</xsl:text> +</xsl:template> + + + + + + +<!--UNARY + unary arithmetic exp, factorial, minus, abs, conjugate, arg, real, imaginary + unary logical not + unary functional inverse, ident + unary elementary classical + functions sin, cos, tan, sec, csc, cot, sinh, cosh, tanh, sech, csch, coth, arcsin, + arccos, arctan, arccosh, arccot, arccoth, arccsc, arccsch, arcsec, arcsech, arcsinh, + arctanh, exp, ln, log + unary linear algebra determinant, transpose + unary calculus and vector calculus + divergence, grad, curl, laplacian + unary set-theoretic card +--> + +<!-- BINARY + binary arithmetic quotient, divide, minus, power, rem + binary logical implies, equivalent, approx + binary set operators setdiff + binary linear algebra vectorproduct, scalarproduct, outerproduct +--> + +<!-- N-ARY and OTHER + n-ary statistical mean, sdev, variance, median, mode + n-ary logical and, or, xor + n-ary linear algebra selector + n-ary set operator union, intersect + n-ary functional fn, compose + integral, sum, product operators int, sum, product + differential operator diff, partialdiff + quantifier forall, exists +--> +<!-- Get the first child (operator), and check if its name is a fn , or operator--> +<!-- Is the operator taking qualifiers? --> +<!-- Operators : int, sum, product, root, diff, partialdiff, limit, log, moment, min, max, forall, exists --> +<!-- Qualifiers : lowlimit, uplimit, bvar, degree, logbase, interval, condition --> + + +<!-- apply/apply --> +<xsl:template match="mml:apply[mml:apply]"> <!-- when the function itself is defined by other functions: (F+G)(x) --> + <xsl:choose> + <xsl:when test="count(child::*)>=2"> + <xsl:text>{</xsl:text><xsl:apply-templates select="child::*[position()=1]"/><xsl:text>}</xsl:text> + <xsl:text>{</xsl:text><xsl:apply-templates select="child::*[position()!=1]"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> <!-- apply only contains apply, no operand--> + <xsl:text>{</xsl:text><xsl:apply-templates select="child::*"/><xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + +<!-- force function or operator MathML 1.0 deprecated--> +<!-- partial support for func/operators defined using presentation markup--> +<xsl:template match="mml:apply[mml:fn]"> +<mrow> +<xsl:choose> +<xsl:when test="*[position()=1 and self::mml:fn]/mml:mo/mml:mchar/@name='PlusMinus'"> + <!--if operator is infix (we assume this to be the default when we have mchars(for instance PlusMinus); perhaps we should test further the name attribute)--> + <xsl:choose> + <xsl:when test="count(child::*)>=3"> + <mrow> + <xsl:for-each select="child::*[position()!=last() and position()!=1]"> + <xsl:apply-templates select="."/><xsl:copy-of select="preceding-sibling::mml:fn/*"/> + </xsl:for-each> + <xsl:apply-templates select="child::*[position()!=1 and position()=last()]"/> + </mrow> + </xsl:when> + <xsl:when test="count(child::*)=2"> + <mrow><xsl:copy-of select="child::mml:fn[position()=1]/*"/><xsl:apply-templates select="child::*[position()=2]"/></mrow> + </xsl:when> + <xsl:otherwise> <!-- apply only contains fn, no operand--> + <mrow><xsl:apply-templates select="child::mml:fn/*"/></mrow> + </xsl:otherwise> + </xsl:choose> +</xsl:when> +<xsl:otherwise> <!-- if operator is prefix (common case)--> + <xsl:choose> + <xsl:when test="name(mml:fn/*[position()=1])='apply'"> <!-- fn definition is complex, surround with brackets, but only one child--> + <mfenced separators=""><mrow><xsl:apply-templates select="mml:fn/*"/></mrow></mfenced> + </xsl:when> + <xsl:otherwise> + <mi><xsl:apply-templates select="mml:fn/*"/></mi> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="count(*)>1"> <!-- if no operands, don't put empty parentheses--> + <mo><mchar name="ApplyFunction"/></mo> + <mfenced> + <xsl:apply-templates select="*[position()!=1]"/> + </mfenced> + </xsl:if> +</xsl:otherwise> +</xsl:choose> +</mrow> +</xsl:template> + + + + +<!-- quotient --> +<xsl:template match="mml:apply[mml:quotient]"> + <mrow> <!-- the third notation uses UNICODE chars x0230A and x0230B --> + <mo>integer part of</mo> + <mrow> + <xsl:choose> <!-- surround with brackets if operands are composed--> + <xsl:when test="child::*[position()=2] and name()='mml:apply'"> + <mfenced separators=""><xsl:apply-templates select="*[position()=2]"/></mfenced> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="*[position()=2]"/> + </xsl:otherwise> + </xsl:choose> + <mo>/</mo> + <xsl:choose> + <xsl:when test="child::*[position()=3] and name()='mml:apply'"> + <mfenced separators=""><xsl:apply-templates select="*[position()=3]"/></mfenced> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="*[position()=3]"/> + </xsl:otherwise> + </xsl:choose> + </mrow> + </mrow> +</xsl:template> + + +<!-- factorial --> +<xsl:template match="mml:apply[mml:factorial]"> + <xsl:text>{</xsl:text> + <xsl:choose> + <xsl:when test="name(*[position()=2])='mml:apply'"> + <xsl:text>{</xsl:text><xsl:apply-templates select="*[position()=2]"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="*[position()=2]"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text>!(fact)</xsl:text> + <xsl:text>}</xsl:text> +</xsl:template> + + +<!-- divide --> +<xsl:template match="mml:apply[mml:divide]"> + <xsl:text>{ \frac</xsl:text> + <xsl:text>{ </xsl:text> + <xsl:apply-templates select="child::*[position()=2]"/> + <xsl:text>}</xsl:text> + <xsl:text>{ </xsl:text> + <xsl:apply-templates select="child::*[position()=3]"/> + <xsl:text>}</xsl:text> + <xsl:text>}</xsl:text> +</xsl:template> + + +<!-- APPLY CONTAINING MAX --> +<xsl:template match="mml:apply/mml:max"/> +<xsl:template match="mml:apply[mml:max]"> + <xsl:text>{</xsl:text> + <xsl:choose> + <xsl:when test="mml:bvar"> <!-- if there are bvars--> + <xsl:text>\max_{</xsl:text> + <!-- Select every bvar except the last one (position() only counts bvars, not the other siblings)--> + <xsl:for-each select="mml:bvar[position()!=last()]"> + <xsl:apply-templates select="."/><xsl:text>,</xsl:text> + </xsl:for-each> + <xsl:apply-templates select="mml:bvar[position()=last()]"/> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> <!-- No bvars, no underscore... --> + <xsl:text>\max</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:text>\left\{</xsl:text> + <xsl:for-each select="child::*[name()!='mml:condition' and name()!='mml:bvar' and name()!='mml:max' and position()!=last()]"> + <xsl:apply-templates select="."/><xsl:text>,</xsl:text> + <xsl:message>RCAS: MathML mml:apply[mml:min] Applying templates to <xsl:copy-of select="name(.)"/></xsl:message> + </xsl:for-each> + <xsl:apply-templates select="child::*[name()!='mml:condition' and name()!='mml:bvar' and name()!='mml:max' and position()=last()]"/> + <!-- If there is a condition, do not close... --> + <xsl:if test="mml:condition"> + <xsl:text>|</xsl:text><xsl:apply-templates select="mml:condition"/> + </xsl:if> + <xsl:text>\right\}</xsl:text> + <xsl:text>}</xsl:text> +</xsl:template> + + +<!-- APPLY CONTAINING MIN --> +<xsl:template match="mml:apply/mml:min"/> +<xsl:template match="mml:apply[mml:min]"> + <xsl:text>{</xsl:text> + <xsl:choose> + <xsl:when test="mml:bvar"> <!-- if there are bvars--> + <xsl:text>\min_{</xsl:text> + <!-- Select every bvar except the last one (position() only counts bvars, not the other siblings)--> + <xsl:for-each select="mml:bvar[position()!=last()]"> + <xsl:apply-templates select="."/><xsl:text>,</xsl:text> + </xsl:for-each> + <xsl:apply-templates select="mml:bvar[position()=last()]"/> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> <!-- No bvars, no underscore... --> + <xsl:text>\min</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:text>\left\{</xsl:text> + <xsl:for-each select="child::*[name()!='mml:condition' and name()!='mml:bvar' and name()!='mml:min' and position()!=last()]"> + <xsl:message>RCAS: MathML mml:apply[mml:min] Applying templates to <xsl:copy-of select="name(.)"/></xsl:message> + <xsl:apply-templates select="."/> + <xsl:text>,</xsl:text> + </xsl:for-each> + <xsl:apply-templates select="child::*[name()!='mml:condition' and name()!='mml:bvar' and name()!='mml:min' and position()=last()]"/> + <!-- If there is a condition, do not close... --> + <xsl:if test="mml:condition"> + <xsl:text>|</xsl:text><xsl:apply-templates select="mml:condition"/> + </xsl:if> + <xsl:text>\right\}</xsl:text> + <xsl:text>}</xsl:text> +</xsl:template> + + + + + + + + +<!-- APPLY CONTAINING substraction(minus) --> +<!-- unary or binary operator --> +<xsl:template match="mml:apply[mml:minus]"> +<xsl:text>{</xsl:text> +<xsl:choose> <!-- binary --> + <xsl:when test="count(child::*)=3"> + <xsl:apply-templates select="child::*[position()=2]"/> + <xsl:text>-</xsl:text> + <xsl:choose> + <xsl:when test="((name(*[position()=3])='mml:ci' or name(*[position()=3])='mml:cn') and contains(*[position()=3]/text(),'-')) or (name(*[position()=3])='mml:apply')"> + <xsl:text>\left(</xsl:text> <xsl:apply-templates select="*[position()=3]"/><xsl:text>\right)</xsl:text> + <!-- surround negative or complex things with brackets --> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="*[position()=3]"/> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> <!-- unary --> + <xsl:text>-</xsl:text> + <xsl:choose> + <xsl:when test= + "((name(*[position()=2])='mml:ci' or name(*[position()=2])='mml:cn') and contains(*[position()=2]/text(),'-')) or (name(*[position()=2])='mml:apply')"> + <xsl:text>\left(</xsl:text> + <xsl:apply-templates select="child::*[position()=last()]"/> + <xsl:text>\right)</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="child::*[position()=last()]"/> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> +</xsl:choose> +<xsl:text>}</xsl:text> +</xsl:template> + + +<!-- addition --> +<xsl:template match="mml:apply[mml:plus]"> + <xsl:choose> + <xsl:when test="count(child::*)>=3"> + <mrow> + <xsl:choose> + <xsl:when test="((name(*[position()=2])='mml:ci' or name(*[position()=2])='mml:cn') and contains(*[position()=2]/text(),'-')) or (*[position()=2 and self::mml:apply and child::mml:minus])"> + <mfenced separators=""><xsl:apply-templates select="*[position()=2]"/></mfenced> <!-- surround negative things with brackets --> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="*[position()=2]"/> + </xsl:otherwise> + </xsl:choose> + <xsl:for-each select="child::*[position()!=1 and position()!=2]"> + <xsl:choose> + <xsl:when test="((name(.)='mml:ci' or name(.)='mml:cn') and contains(./text(),'-')) or (self::mml:apply and child::mml:minus)"> <!-- surround negative things with brackets --> + <mo>+</mo><mfenced separators=""><xsl:apply-templates select="."/></mfenced> + </xsl:when> + <xsl:otherwise> + <mo>+</mo><xsl:apply-templates select="."/> + </xsl:otherwise> + </xsl:choose> + </xsl:for-each> + </mrow> + </xsl:when> + <xsl:when test="count(child::*)=2"> + <mrow> + <mo>+</mo><xsl:apply-templates select="child::*[position()=2]"/> + </mrow> + </xsl:when> + <xsl:otherwise> + <mo>+</mo> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<!-- power --> +<xsl:template match="mml:apply[mml:power]"> + <xsl:text> {</xsl:text> + <xsl:choose> + <xsl:when test="name(*[position()=2])='mml:apply'"> + <xsl:text>\left(</xsl:text> + <xsl:apply-templates select="child::*[position()=2]"/> + <xsl:text>\rigth)</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="child::*[position()=2]"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text>}^{</xsl:text> + <xsl:apply-templates select="child::*[position()=3]"/> + <xsl:text>} </xsl:text> +</xsl:template> + +<!-- remainder --> +<xsl:template match="mml:apply[mml:rem]"> + <mrow> + <xsl:choose> <!-- surround with brackets if operands are composed--> + <xsl:when test="name(*[position()=2])='mml:apply'"> + <mfenced separators=""><xsl:apply-templates select="*[position()=2]"/></mfenced> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="*[position()=2]"/> + </xsl:otherwise> + </xsl:choose> + <mo>mod</mo> + <xsl:choose> + <xsl:when test="name(*[position()=3])='mml:apply'"> + <mfenced separators=""><xsl:apply-templates select="*[position()=3]"/></mfenced> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="*[position()=3]"/> + </xsl:otherwise> + </xsl:choose> + </mrow> +</xsl:template> + +<!-- multiplication --> +<xsl:template match="mml:apply[mml:times]"> +<xsl:choose> +<xsl:when test="count(child::*)>=3"> + <mrow> + <xsl:for-each select="child::*[position()!=last() and position()!=1]"> + <xsl:choose> + <xsl:when test="mml:plus"> <!--add brackets around + children for priority purpose--> + <mfenced separators=""><xsl:apply-templates select="."/></mfenced><mo><mchar name="InvisibleTimes"/></mo> + </xsl:when> + <xsl:when test="mml:minus"> <!--add brackets around - children for priority purpose--> + <mfenced separators=""><xsl:apply-templates select="."/></mfenced><mo><mchar name="InvisibleTimes"/></mo> + </xsl:when> + <xsl:when test="(name(.)='mml:ci' or name(.)='mml:cn') and contains(text(),'-')"> <!-- have to do it using contains because starts-with doesn't seem to work well in XT--> + <mfenced separators=""><xsl:apply-templates select="."/></mfenced><mo><mchar name="InvisibleTimes"/></mo> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="."/><mo><mchar name="InvisibleTimes"/></mo> + </xsl:otherwise> + </xsl:choose> + </xsl:for-each> + <xsl:for-each select="child::*[position()=last()]"> + <xsl:choose> + <xsl:when test="mml:plus"> + <mfenced separators=""><xsl:apply-templates select="."/></mfenced> + </xsl:when> + <xsl:when test="mml:minus"> + <mfenced separators=""><xsl:apply-templates select="."/></mfenced> + </xsl:when> + <xsl:when test="(name(.)='mml:ci' or name(.)='mml:cn') and contains(text(),'-')"> <!-- have to do it using contains because starts-with doesn't seem to work well in XT--> + <mfenced separators=""><xsl:apply-templates select="."/></mfenced> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="."/> + </xsl:otherwise> + </xsl:choose> + </xsl:for-each> + </mrow> +</xsl:when> +<xsl:when test="count(child::*)=2"> <!-- unary --> + <mrow> + <mo><mchar name="InvisibleTimes"/></mo> + <xsl:choose> + <xsl:when test="mml:plus"> + <mfenced separators=""><xsl:apply-templates select="*[position()=2]"/></mfenced> + </xsl:when> + <xsl:when test="mml:minus"> + <mfenced separators=""><xsl:apply-templates select="*[position()=2]"/></mfenced> + </xsl:when> + <xsl:when test="(*[position()=2 and self::mml:ci] or *[position()=2 and self::mml:cn]) and contains(*[position()=2]/text(),'-')"> + <mfenced separators=""><xsl:apply-templates select="*[position()=2]"/></mfenced> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="*[position()=2]"/> + </xsl:otherwise> + </xsl:choose> + </mrow> +</xsl:when> +<xsl:otherwise> <!-- no operand --> + <mo><mchar name="InvisibleTimes"/></mo> +</xsl:otherwise> +</xsl:choose> +</xsl:template> + +<!-- root --> +<xsl:template match="mml:apply[mml:root]"> + <xsl:choose> + <xsl:when test="mml:degree"> + <xsl:choose> + <xsl:when test="mml:degree/mml:cn/text()='2'"> <!--if degree=2 display a standard square root--> + <msqrt> + <xsl:apply-templates select="child::*[position()=3]"/> + </msqrt> + </xsl:when> + <xsl:otherwise> + <mroot> + <xsl:apply-templates select="child::*[position()=3]"/> + <mrow><xsl:apply-templates select="mml:degree/*"/></mrow> + </mroot> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> <!-- no degree specified--> + <msqrt> + <xsl:apply-templates select="child::*[position()=2]"/> + </msqrt> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<!-- greatest common divisor --> +<xsl:template match="mml:apply[mml:gcd]"> + <mrow> + <mi>gcd</mi><mo><mchar name="ApplyFunction"/></mo> + <mfenced> + <xsl:apply-templates select="child::*[position()!=1]"/> + </mfenced> + </mrow> +</xsl:template> + +<!-- AND --> +<xsl:template match="mml:apply[mml:and]"> +<mrow> + <xsl:choose> + <xsl:when test="count(*)>=3"> <!-- at least two operands (common case)--> + <xsl:for-each select="child::*[position()!=last() and position()!=1]"> + <xsl:choose> + <xsl:when test="mml:or"> <!--add brackets around OR children for priority purpose--> + <mfenced separators=""><xsl:apply-templates select="."/></mfenced><mo><mchar name="And"/></mo> + </xsl:when> + <xsl:when test="mml:xor"> <!--add brackets around XOR children for priority purpose--> + <mfenced separators=""><xsl:apply-templates select="."/></mfenced><mo><mchar name="And"/></mo> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="."/><mo><mchar name="And"/></mo> + </xsl:otherwise> + </xsl:choose> + </xsl:for-each> + <xsl:for-each select="child::*[position()=last()]"> + <xsl:choose> + <xsl:when test="mml:or"> + <mfenced separators=""><xsl:apply-templates select="."/></mfenced> + </xsl:when> + <xsl:when test="mml:xor"> + <mfenced separators=""><xsl:apply-templates select="."/></mfenced> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="."/> + </xsl:otherwise> + </xsl:choose> + </xsl:for-each> + </xsl:when> + <xsl:when test="count(*)=2"> + <mo><mchar name="And"/></mo><xsl:apply-templates select="*[position()=last()]"/> + </xsl:when> + <xsl:otherwise> + <mo><mchar name="And"/></mo> + </xsl:otherwise> + </xsl:choose> +</mrow> +</xsl:template> + +<!-- OR --> +<xsl:template match="mml:apply[mml:or]"> +<mrow> + <xsl:choose> + <xsl:when test="count(*)>=3"> + <xsl:for-each select="child::*[position()!=last() and position()!=1]"> + <xsl:apply-templates select="."/><mo><mchar name="Or"/></mo> + </xsl:for-each> + <xsl:apply-templates select="child::*[position()=last()]"/> + </xsl:when> + <xsl:when test="count(*)=2"> + <mo><mchar name="Or"/></mo><xsl:apply-templates select="*[position()=last()]"/> + </xsl:when> + <xsl:otherwise> + <mo><mchar name="Or"/></mo> + </xsl:otherwise> + </xsl:choose> +</mrow> +</xsl:template> + +<!-- XOR --> +<xsl:template match="mml:apply[mml:xor]"> +<mrow> + <xsl:choose> + <xsl:when test="count(*)>=3"> + <xsl:for-each select="child::*[position()!=last() and position()!=1]"> + <xsl:apply-templates select="."/><mo>xor</mo> + </xsl:for-each> + <xsl:apply-templates select="child::*[position()=last()]"/> + </xsl:when> + <xsl:when test="count(*)=2"> + <mo>xor</mo><xsl:apply-templates select="*[position()=last()]"/> + </xsl:when> + <xsl:otherwise> + <mo>xor</mo> + </xsl:otherwise> + </xsl:choose> +</mrow> +</xsl:template> + +<!-- NOT --> +<xsl:template match="mml:apply[mml:not]"> + <mrow> + <mo><mchar name="Not"/></mo> + <xsl:choose> + <xsl:when test="child::mml:apply"><!--add brackets around OR,AND,XOR children for priority purpose--> + <mfenced separators=""> + <xsl:apply-templates select="child::*[position()=2]"/> + </mfenced> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="child::*[position()=2]"/> + </xsl:otherwise> + </xsl:choose> + </mrow> +</xsl:template> + +<!-- implies --> +<xsl:template match="mml:apply[mml:implies]"> + <mrow> + <xsl:apply-templates select="child::*[position()=2]"/> + <mo><mchar name="DoubleRightArrow"/></mo> + <xsl:apply-templates select="child::*[position()=3]"/> + </mrow> +</xsl:template> + +<xsl:template match="mml:reln[mml:implies]"> + <mrow> + <xsl:apply-templates select="child::*[position()=2]"/> + <mo><mchar name="DoubleRightArrow"/></mo> + <xsl:apply-templates select="child::*[position()=3]"/> + </mrow> +</xsl:template> + +<!-- for all--> +<xsl:template match="mml:apply[mml:forall]"> + <mrow> + <mo><mchar name="ForAll"/></mo> + <mrow> + <xsl:for-each select="mml:bvar[position()!=last()]"> + <xsl:apply-templates select="."/><mo>,</mo> + </xsl:for-each> + <xsl:apply-templates select="mml:bvar[position()=last()]"/> + </mrow> + <xsl:if test="mml:condition"> + <mrow><mo>,</mo><xsl:apply-templates select="mml:condition"/></mrow> + </xsl:if> + <xsl:choose> + <xsl:when test="mml:apply"> + <mo>:</mo><xsl:apply-templates select="mml:apply"/> + </xsl:when> + <xsl:when test="mml:reln"> + <mo>:</mo><xsl:apply-templates select="mml:reln"/> + </xsl:when> + </xsl:choose> + </mrow> +</xsl:template> + +<!-- in --> +<xsl:template match="mml:apply[mml:in]"> + <xsl:text>{</xsl:text> + <xsl:apply-templates select="child::*[position()=2]"/> + <xsl:text>\in</xsl:text> + <xsl:apply-templates select="child::*[position()=3]"/> + <xsl:text>}</xsl:text> +</xsl:template> + +<!-- notin --> +<xsl:template match="mml:apply[mml:notin]"> + <xsl:text>{</xsl:text> + <xsl:apply-templates select="child::*[position()=2]"/> + <xsl:text>\notin</xsl:text> + <xsl:apply-templates select="child::*[position()=3]"/> + <xsl:text>}</xsl:text> +</xsl:template> + +<!-- exist--> +<xsl:template match="mml:apply[mml:exists]"> + <mrow> + <mo><mchar name="Exists"/></mo> + <mrow> + <xsl:for-each select="mml:bvar[position()!=last()]"> + <xsl:apply-templates select="."/><mo>,</mo> + </xsl:for-each> + <xsl:apply-templates select="mml:bvar[position()=last()]"/> + </mrow> + <xsl:if test="mml:condition"> + <mrow><mo>,</mo><xsl:apply-templates select="mml:condition"/></mrow> + </xsl:if> + <xsl:choose> + <xsl:when test="mml:apply"> + <mo>:</mo><xsl:apply-templates select="mml:apply"/> + </xsl:when> + <xsl:when test="mml:reln"> + <mo>:</mo><xsl:apply-templates select="mml:reln"/> + </xsl:when> + </xsl:choose> + </mrow> +</xsl:template> + +<!-- absolute value --> +<xsl:template match="mml:apply[mml:abs]"> + <mrow><mo>|</mo><xsl:apply-templates select="child::*[position()=last()]"/><mo>|</mo></mrow> +</xsl:template> + +<!-- conjugate --> +<xsl:template match="mml:apply[mml:conjugate]"> + <mover> + <xsl:apply-templates select="child::*[position()=2]"/> + <mo><mchar name="ovbar"/></mo> <!-- does not work, UNICODE x0233D or perhaps OverBar--> + </mover> +</xsl:template> + +<!-- argument of complex number --> +<xsl:template match="mml:apply[mml:arg]"> + <mrow> + <mi>arg</mi><mo><mchar name="ApplyFunction"/></mo><mfenced separators=""><xsl:apply-templates select="child::*[position()=2]"/></mfenced> + </mrow> +</xsl:template> + +<!-- real part of complex number --> +<xsl:template match="mml:apply[mml:real]"> + <mrow> + <mi><xsl:text disable-output-escaping='yes'>&#x0211C;</xsl:text><!-- mchar Re or realpart should work--></mi> + <mo><mchar name="ApplyFunction"/></mo> + <mfenced separators=""><xsl:apply-templates select="child::*[position()=2]"/></mfenced> + </mrow> +</xsl:template> + +<!-- imaginary part of complex number --> +<xsl:template match="mml:apply[mml:imaginary]"> + <mrow> + <mi><xsl:text disable-output-escaping='yes'>&#x02111;</xsl:text><!-- mchar Im or impart should work--></mi> + <mo><mchar name="ApplyFunction"/></mo> + <mfenced separators=""><xsl:apply-templates select="child::*[position()=2]"/></mfenced> + </mrow> +</xsl:template> + +<!-- lowest common multiple --> +<xsl:template match="mml:apply[mml:lcm]"> + <mrow> + <mi>lcm</mi><mo><mchar name="ApplyFunction"/></mo> + <mfenced> + <xsl:apply-templates select="child::*[position()!=1]"/> + </mfenced> + </mrow> +</xsl:template> + + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/mathml/mathml.content.mod.xsl b/docs/docbook/xslt/db2latex/mathml/mathml.content.mod.xsl new file mode 100644 index 0000000000..ded65f4a9c --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/mathml.content.mod.xsl @@ -0,0 +1,99 @@ +<?xml version='1.0'?> +<!DOCTYPE xsl:stylesheet +[ + <!ENTITY % mmlalias PUBLIC "MathML alias" "ent/mmlalias.ent"> %mmlalias; + <!ENTITY % mmlextra PUBLIC "MathML extra" "ent/mmlextra.ent"> %mmlextra; +]> +<!--############################################################################# + | $Id: mathml.content.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: MathML content markup. + | Note: these elements are not part of the DocBook DTD. I have extended + | the docbook DTD in order to support this tags, so that's why I have these + | templates here. + | + | MathML namespace used -> mml + + ############################################################################## --> + +<xsl:stylesheet version='1.0' + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns="http://www.w3.org/1998/Math/MathML"> + +<xsl:template match="mml:semantics"> +</xsl:template> + + +<xsl:template match="mml:set|mml:list"> +</xsl:template> + + +<xsl:template match="mml:matrix"> +</xsl:template> + +<xsl:template match="mml:reln"> +</xsl:template> + +<xsl:template match="mml:lambda"> +</xsl:template> + + + + + + +<!-- Interval --> +<!-- att. closure : open, closed, open-closed, or closed-open, with a default value of closed. --> +<xsl:template match="mml:interval"> +<xsl:choose> + <xsl:when test="@closure = 'open'"> + <xsl:call-template name="interval.render"> + <xsl:with-param name="node" select="."/> + <xsl:with-param name="fst">\left( </xsl:with-param> + <xsl:with-param name="scd">\right) </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="@closure = 'open-closed'"> + <xsl:call-template name="interval.render"> + <xsl:with-param name="node" select="."/> + <xsl:with-param name="fst">\left( </xsl:with-param> + <xsl:with-param name="scd">\right] </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="@closure = 'closed-open'"> + <xsl:call-template name="interval.render"> + <xsl:with-param name="node" select="."/> + <xsl:with-param name="fst">\left[ </xsl:with-param> + <xsl:with-param name="scd">\right) </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="interval.render"> + <xsl:with-param name="node" select="."/> + <xsl:with-param name="fst">\left[ </xsl:with-param> + <xsl:with-param name="scd">\right] </xsl:with-param> + </xsl:call-template> + </xsl:otherwise> +</xsl:choose> +</xsl:template> + +<xsl:template name="interval.render"> +<xsl:param name="node"/> +<xsl:param name="fst"/> +<xsl:param name="scd"/> +<xsl:choose> + <!-- Two real numbers define the interval --> + <xsl:when test="count(child::*) = 2"> + <xsl:value-of select="$fst"/> + <xsl:apply-templates select="$node/child::*[1]"/> + <xsl:text> , </xsl:text> + <xsl:apply-templates select="$node/child::*[2]"/> + <xsl:value-of select="$scd"/> + </xsl:when> + <!-- A condition defines the interval --> + <xsl:otherwise> </xsl:otherwise> +</xsl:choose> +</xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/mathml/mathml.content.token.mod.xsl b/docs/docbook/xslt/db2latex/mathml/mathml.content.token.mod.xsl new file mode 100644 index 0000000000..cad72c5139 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/mathml.content.token.mod.xsl @@ -0,0 +1,232 @@ +<?xml version='1.0'?> +<!DOCTYPE xsl:stylesheet +[ + <!ENTITY % mmlalias PUBLIC "MathML alias" "ent/mmlalias.ent"> %mmlalias; + <!ENTITY % mmlextra PUBLIC "MathML extra" "ent/mmlextra.ent"> %mmlextra; +]> +<!--############################################################################# + | $Id: mathml.content.token.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: MathML Content Markup, tokens (ci, cn, csymbol) + | MathML namespace used -> mml + + ############################################################################## --> + +<xsl:stylesheet version='1.0' + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns="http://www.w3.org/1998/Math/MathML"> + +<xsl:strip-space elements="mml:math mml:mrow"/> + + +<!-- Content Number --> +<!-- support for bases and types--> +<xsl:template match="mml:cn"> + <xsl:text>{</xsl:text> + <xsl:text>{</xsl:text> + <xsl:choose> + <xsl:when test="./@type='complex-cartesian' or ./@type='complex'"> + <mn><xsl:value-of select="text()[position()=1]"/></mn> + <xsl:choose> + <xsl:when test="contains(text()[position()=2],'-')"> + <xsl:text>-</xsl:text><xsl:value-of select="substring-after(text()[position()=2],'-')"/> + <!-- substring-after does not seem to work well in XT : + if imaginary part is expressed with at least one space char + before the minus sign, then it does not work (we end up with + two minus sign since the one in the text is kept)--> + </xsl:when> + <xsl:otherwise> + <xsl:text>+</xsl:text> <xsl:value-of select="text()[position()=2]"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text>\dot\textrm{i}</xsl:text> + </xsl:when> + <xsl:when test="./@type='complex-polar'"> + <xsl:text>\textrm{Polar}(</xsl:text><xsl:value-of select="text()[position()=1]"/><xsl:text>,</xsl:text> + <xsl:value-of select="text()[position()=2]"/> + <xsl:text>)</xsl:text> + </xsl:when> + <xsl:when test="./@type='rational'"> + <xsl:text>\frac{</xsl:text><xsl:value-of select="text()[position()=1]"/><xsl:text>}{</xsl:text> + <xsl:value-of select="text()[position()=2]"/> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="."/> + </xsl:otherwise> + </xsl:choose> + <xsl:text>}</xsl:text> + <xsl:if test="@base and @base!=10"> <!-- base specified and different from 10 ; if base = 10 we do not display it --> + <xsl:text>_{</xsl:text><xsl:value-of select="@base"/><xsl:text>}</xsl:text> + </xsl:if> + <xsl:text>}</xsl:text> +</xsl:template> + + + +<!-- Content Identifier --> +<!-- identifier --> +<!--support for presentation markup--> +<xsl:template match="mml:ci"> +<xsl:choose> +<xsl:when test="./@type='complex-cartesian' or ./@type='complex'"> + <xsl:choose> + <xsl:when test="count(*)>0"> <!--if identifier is composed of real+imag parts--> + <xsl:text>{</xsl:text> + <xsl:choose> + <xsl:when test="*[self::mml:mchar and position()=1]"> <!-- if real part is an mchar --> + <xsl:text>\textrm{</xsl:text><xsl:copy-of select="*[position()=1]"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> <!-- if real part is simple text --> + <xsl:text>\textrm{</xsl:text><xsl:copy-of select="*[position()=1]"/><xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:choose> <!-- im part is negative--> + <xsl:when test="contains(text()[preceding-sibling::*[position()=1 and self::mml:sep]],'-')"> + <xsl:text>-\textrm{</xsl:text> + <xsl:choose> + <xsl:when test="mml:mchar[preceding-sibling::*[self::mml:sep]]"><!-- if im part is an mchar --> + <xsl:copy-of select="mml:mchar[preceding-sibling::*[self::mml:sep]]"/> + </xsl:when> + <xsl:otherwise><!-- if im part is simple text --> + <xsl:value-of select="substring-after(text()[preceding-sibling::*[position()=1 and self::mml:sep]],'-')"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text>}</xsl:text> + <xsl:text>\dot\textrm{i}</xsl:text> + </xsl:when> + <xsl:otherwise> <!-- im part is not negative--> + <xsl:text>+\textrm{</xsl:text> + <xsl:choose><!-- if im part is an mchar --> + <xsl:when test="mml:mchar[preceding-sibling::*[self::mml:sep]]"> + <xsl:copy-of select="mml:mchar[preceding-sibling::*[self::mml:sep]]"/> + </xsl:when> + <xsl:otherwise><!-- if im part is simple text --> + <xsl:value-of select="text()[preceding-sibling::*[position()=1 and self::mml:sep]]"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text>}</xsl:text> + <xsl:text>\dot\textrm{i}</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> <!-- if identifier is composed only of one text child--> + <xsl:text>\dot\textrm{</xsl:text><xsl:value-of select="."/><xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:when> +<xsl:when test="./@type='complex-polar'"> + <xsl:choose> + <xsl:when test="count(*)>0"> <!--if identifier is composed of real+imag parts--> + <xsl:text>{</xsl:text> + <mi>Polar</mi> + <mfenced><mi> + <xsl:value-of select="text()[following-sibling::*[self::mml:sep]]"/> + <xsl:if test="mml:mchar[following-sibling::*[self::mml:sep]]"> + <xsl:copy-of select="mml:mchar[following-sibling::*[self::mml:sep]]"/> + </xsl:if> + </mi> + <mi> + <xsl:value-of select="text()[preceding-sibling::*[self::mml:sep]]"/> + <xsl:if test="mml:mchar[preceding-sibling::*[self::mml:sep]]"> + <xsl:copy-of select="mml:mchar[preceding-sibling::*[self::mml:sep]]"/> + </xsl:if> + </mi></mfenced> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> <!-- if identifier is composed only of one text child--> + <mi><xsl:value-of select="."/></mi> + </xsl:otherwise> + </xsl:choose> +</xsl:when> +<xsl:when test="./@type='rational'"> + <xsl:choose> + <xsl:when test="count(*)>0"> <!--if identifier is composed of two parts--> + <xsl:text>{</xsl:text><mi> + <xsl:value-of select="text()[following-sibling::*[self::mml:sep]]"/> + <xsl:if test="mml:mchar[following-sibling::*[self::mml:sep]]"> + <xsl:copy-of select="mml:mchar[following-sibling::*[self::mml:sep]]"/> + </xsl:if> + </mi> + <mo>/</mo> + <mi> + <xsl:value-of select="text()[preceding-sibling::*[self::mml:sep]]"/> + <xsl:if test="mml:mchar[preceding-sibling::*[self::mml:sep]]"> + <xsl:copy-of select="mml:mchar[preceding-sibling::*[self::mml:sep]]"/> + </xsl:if> + </mi><xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> <!-- if identifier is composed only of one text child--> + <mi><xsl:value-of select="."/></mi> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:when test="./@type='vector'"> + <mi fontweight="bold"> + <xsl:value-of select="text()"/> + <xsl:if test="mml:mchar"> + <xsl:copy-of select="mml:mchar"/> + </xsl:if> + </mi> +</xsl:when> + <!-- type 'set' seems to be deprecated (use 4.4.12 instead); besides, there is no easy way to translate set identifiers to chars in ISOMOPF --> +<xsl:otherwise> <!-- no type attribute provided --> + <xsl:choose> + <xsl:when test="mml:mchar"> <!-- test if identifier is expressed using mchar nodes --> + <mi><xsl:value-of select="text()"/><xsl:copy-of select="mml:mchar"/></mi> + </xsl:when> + <xsl:when test="count(node()) != count(text())"> + <!--test if children are not all text nodes, meaning there is markup assumed + to be presentation markup (the case where there are mchar nodes has been tested just before)--> + <xsl:text>{</xsl:text><xsl:copy-of select="child::*"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> <!-- common case --> + <mi><xsl:value-of select="."/></mi> + </xsl:otherwise> + </xsl:choose> +</xsl:otherwise> +</xsl:choose> +</xsl:template> + + + + + + +<!-- externally defined symbols--> +<xsl:template match="mml:apply[mml:csymbol]"> + <xsl:text>{</xsl:text> + <xsl:apply-templates select="mml:csymbol[position()=1]"/> + <xsl:text>\left(</xsl:text> + <xsl:for-each select="child::*[position()!=1]"> + <xsl:apply-templates select="."/> + </xsl:for-each> + <xsl:text>\right)</xsl:text> + <xsl:text>}</xsl:text> +</xsl:template> + + +<xsl:template match="mml:csymbol"> +<xsl:choose> + <!--test if children are not all text nodes, meaning there is markup assumed to be presentation markup--> + <!--perhaps it would be sufficient to test if there is more than one node or text node--> + <xsl:when test="count(node()) != count(text())"> + <xsl:text>{</xsl:text> <xsl:copy-of select="child::*"/> <xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\textrm{</xsl:text> <xsl:copy-of select="."/> <xsl:text>}</xsl:text> + </xsl:otherwise> +</xsl:choose> +</xsl:template> + +<xsl:template match="mml:mchar"> + <xsl:copy-of select="."/> +</xsl:template> +<!-- +<xsl:template match="mml:mtext"> + <xsl:copy-of select="."/> +</xsl:template> +--> +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/mathml/mathml.mod.xsl b/docs/docbook/xslt/db2latex/mathml/mathml.mod.xsl new file mode 100644 index 0000000000..c87b4ef7f6 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/mathml.mod.xsl @@ -0,0 +1,51 @@ +<?xml version='1.0'?> +<!DOCTYPE xsl:stylesheet +[ + <!ENTITY % mmlalias PUBLIC "MathML alias" "ent/mmlalias.ent"> %mmlalias; + <!ENTITY % mmlextra PUBLIC "MathML extra" "ent/mmlextra.ent"> %mmlextra; +]> +<!--############################################################################# + | $Id: mathml.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: MathML presentation and content markup. + | Note: these elements are not part of the DocBook DTD. I have extended + | the docbook DTD in order to support this tags, so that's why I have these + | templates here. + | + | MathML namespace used -> mml + + ############################################################################## --> + +<xsl:stylesheet version='1.0' + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns="http://www.w3.org/1998/Math/MathML"> + +<xsl:strip-space elements="mml:math mml:mrow"/> + + +<xsl:template match="mml:math"> + <xsl:text>
\begin{displaymath}
</xsl:text> + <xsl:apply-templates/> + <xsl:text>
\end{displaymath}
</xsl:text> +</xsl:template> + +<xsl:template match="mml:math[@mode='inline']"> + <xsl:text> \begin{math} </xsl:text> + <xsl:apply-templates/> + <xsl:text> \end{math} </xsl:text> +</xsl:template> + +<xsl:template match="mml:math[@mode='display']"> + <xsl:text>
\begin{displaymath}
</xsl:text> + <xsl:apply-templates/> + <xsl:text>
\end{displaymath}
</xsl:text> +</xsl:template> + + +<xsl:template match="p"> + <xsl:text>\section{</xsl:text> <xsl:value-of select="normalize-space(.)"/> <xsl:text>}
</xsl:text> +</xsl:template> + + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/mathml/mathml.presentation.mod.xsl b/docs/docbook/xslt/db2latex/mathml/mathml.presentation.mod.xsl new file mode 100644 index 0000000000..6e8bb83f30 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mathml/mathml.presentation.mod.xsl @@ -0,0 +1,493 @@ +<?xml version='1.0'?> +<!DOCTYPE xsl:stylesheet +[ + <!ENTITY % mmlalias PUBLIC "MathML alias" "ent/mmlalias.ent"> %mmlalias; + <!ENTITY % mmlextra PUBLIC "MathML extra" "ent/mmlextra.ent"> %mmlextra; +]> +<!--############################################################################# + | $Id: mathml.presentation.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: MathML presentation markup. + | Note: these elements are not part of the DocBook DTD. I have extended + | the docbook DTD in order to support this tags, so that's why I have these + | templates here. + | + | MathML namespace used -> mml + + ############################################################################## --> + +<xsl:stylesheet version='1.0' + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns="http://www.w3.org/1998/Math/MathML"> + +<xsl:template match="mml:mrow"> + <xsl:text>{</xsl:text> <xsl:apply-templates/> <xsl:text>}</xsl:text> +</xsl:template> + +<xsl:variable name="latex.entities.xml" select="document('latex.entities.xml')"/> + + +<!-- TOKENS --> +<!-- Math Identifier --> +<xsl:template match="mml:mi"> + <xsl:variable name="fontstyle" select="@fontstyle"/> + <xsl:variable name="identifier" select="normalize-space(.)"/> + <xsl:variable name="equivalent"> + <xsl:if test="string-length($identifier)=1"> + <xsl:value-of select="$latex.entities.xml/latex/character[@entity=$identifier]"/> + </xsl:if> + </xsl:variable> + <xsl:choose> + <xsl:when test="$identifier='ⅇ'"> + <xsl:text>\textrm{e}</xsl:text> + </xsl:when> + <xsl:when test="$identifier='ⅈ'"> + <xsl:text>\textrm{i}</xsl:text> + </xsl:when> + <xsl:when test="$identifier='∞'"><!--/infty infinity --> + <xsl:text>\infty</xsl:text> + </xsl:when> + <!-- currently tries to map single-character identifiers only --> + <xsl:when test="$equivalent!=''"> + <xsl:text>{</xsl:text> + <xsl:copy-of select="$equivalent"/> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:if test="$fontstyle='normal' or string-length($identifier)>1"> + <xsl:text>\textrm</xsl:text> + </xsl:if> + <xsl:text>{</xsl:text> + <xsl:copy-of select="$identifier"/> + <xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<!-- Math Number --> +<xsl:template match="mml:mn"> + <xsl:copy-of select="normalize-space(.)"/> +</xsl:template> + +<!-- Math Phantom --> +<xsl:template match="mml:mphantom"> + <xsl:apply-templates/> +</xsl:template> + +<!-- Empty unless $character is a single character --> +<xsl:template name="generate.equivalent"> + <xsl:param name="arguments" select="0"/> + <xsl:param name="character"/> + <xsl:if test="string-length($character)=1"> + <xsl:choose> + <xsl:when test="$arguments>0"> + <xsl:value-of select="$latex.entities.xml/latex/character[@entity=$character and @arguments=$arguments]"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$latex.entities.xml/latex/character[@entity=$character and @arguments='']"/> + </xsl:otherwise> + </xsl:choose> + </xsl:if> +</xsl:template> + +<!-- Math Operator --> +<xsl:template match="mml:mo"> + <xsl:variable name="operator" select="normalize-space(.)"/> + <xsl:variable name="equivalent"> + <xsl:call-template name="generate.equivalent"> + <xsl:with-param name="character" select="$operator"/> + </xsl:call-template> + </xsl:variable> + <xsl:choose> + <xsl:when test="$operator='⁡'"> + <xsl:text></xsl:text> + </xsl:when> + <xsl:when test="$operator='⁣'"> + <xsl:text>\thinspace</xsl:text> + </xsl:when> + <xsl:when test="$operator='⁢'"> + <xsl:text>\thinspace</xsl:text> + </xsl:when> + <xsl:when test="$operator='∫'"> + <xsl:text>\int</xsl:text> + </xsl:when> + <xsl:when test="$operator='∏'"> + <xsl:text>\prod</xsl:text> + </xsl:when> + <xsl:when test="$operator='∑'"> + <xsl:text>\sum</xsl:text> + </xsl:when> + <xsl:when test="$operator='^'"> + <xsl:text>\sphat</xsl:text> + </xsl:when> + <xsl:when test="$operator='→'"> + <xsl:text>\longrightarrow</xsl:text> + </xsl:when> + <xsl:when test="$operator='∈'"> + <xsl:text>\in</xsl:text> + </xsl:when> + <xsl:when test="$operator='∣'"> + <xsl:text>|</xsl:text> + </xsl:when> + <xsl:when test="$operator='ⅆ'"> + <xsl:text>\textrm{d}</xsl:text> + </xsl:when> + <xsl:when test="$operator='('"> + <xsl:text> {\left( </xsl:text> + </xsl:when> + <xsl:when test="$operator=')'"> + <xsl:text> \right)} </xsl:text> + </xsl:when> + <xsl:when test="$operator='{'"> + <xsl:text> {\left\{ </xsl:text> + </xsl:when> + <xsl:when test="$operator='}'"> + <xsl:text> \right\}} </xsl:text> + </xsl:when> + <xsl:when test="$operator='['"> + <xsl:text> {\left[ </xsl:text> + </xsl:when> + <xsl:when test="$operator=']'"> + <xsl:text> \right]} </xsl:text> + </xsl:when> + <xsl:when test="$operator='max'"> + <xsl:text> \max </xsl:text> + </xsl:when> + <xsl:when test="$operator='min'"> + <xsl:text> \min </xsl:text> + </xsl:when> + <xsl:when test="$operator='+' or $operator='-' or $operator='/' or $operator='*'"> + <xsl:value-of select="$operator"/> + </xsl:when> + <xsl:when test="$equivalent"> + <xsl:value-of select="$equivalent"/> + </xsl:when> + <xsl:otherwise> + <xsl:text>\operatorname{</xsl:text> + <xsl:value-of select="$operator" /> + <xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<!-- Math String --> +<xsl:template match="mml:ms"> + <xsl:text>\textrm{</xsl:text> + <xsl:copy-of select="normalize-space(.)" /> + <xsl:text>}</xsl:text> +</xsl:template> + +<!-- Math Text --> +<xsl:template match="mml:mtext"> + <xsl:message>RCAS mtext, <xsl:copy-of select="."/> </xsl:message> + <xsl:text>\textrm{</xsl:text> + <xsl:copy-of select="." /> + <xsl:text>}</xsl:text> +</xsl:template> + +<!-- Math Space --> +<xsl:template match="mml:mspace"> + <xsl:if test="@width!='' and not(contains(@width,'%'))"> + <xsl:text>\textrm{\hspace{</xsl:text><!-- kludge! --> + <xsl:value-of select="@width"/> + <xsl:text>}}</xsl:text> + </xsl:if> + <xsl:if test="@height!='' or @depth!=''"> + <xsl:message>Warning: mspace support does not include height or depth.</xsl:message> + </xsl:if> +</xsl:template> + + + + + +<xsl:template match="mml:msup"> + <xsl:apply-templates select="*[1]"/> + <xsl:text>^{</xsl:text><xsl:apply-templates select="*[2]"/><xsl:text>}</xsl:text> +</xsl:template> + +<xsl:template match="mml:msub"> + <xsl:apply-templates select="*[1]"/> + <xsl:text>_{</xsl:text><xsl:apply-templates select="*[2]"/><xsl:text>}</xsl:text> +</xsl:template> + +<xsl:template match="mml:msubsup"> +<xsl:choose> + <xsl:when test="name(*[1])='mo'"> + <xsl:apply-templates select="*[1]"/> + <!-- sub --> + <xsl:text>_{</xsl:text><xsl:apply-templates select="*[2]"/><xsl:text>}</xsl:text> + <!-- super --> + <xsl:text>^{</xsl:text><xsl:apply-templates select="*[3]"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> + <!-- base --> + <xsl:text>{</xsl:text><xsl:apply-templates select="*[1]"/><xsl:text>}</xsl:text> + <!-- sub --> + <xsl:text>_{</xsl:text><xsl:apply-templates select="*[2]"/><xsl:text>}</xsl:text> + <!-- super --> + <xsl:text>^{</xsl:text><xsl:apply-templates select="*[3]"/><xsl:text>}</xsl:text> + </xsl:otherwise> +</xsl:choose> +</xsl:template> + +<xsl:template match="mml:mmultiscripts"> +</xsl:template> + +<xsl:template match="mml:munder"> +<!-- +<xsl:choose> + <xsl:when test="*[2] = ̲"> + <xsl:text>\underline{</xsl:text><xsl:apply-templates select="*[1]"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:when test="normalize-space(*[2]) = ︸"> + <xsl:text>\underbrace{</xsl:text><xsl:apply-templates select="*[1]"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:when test="normalize-space(*[2]) = ⎵"> + <xsl:text>\underbrace{</xsl:text><xsl:apply-templates select="*[1]"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\underset{</xsl:text> + <xsl:apply-templates select="*[2]"/> + <xsl:text>}{</xsl:text> + <xsl:apply-templates select="*[1]"/> + <xsl:text>}</xsl:text> +--> + <xsl:text>{</xsl:text> + <xsl:apply-templates select="*[1]"/> + <xsl:text>_{</xsl:text> + <xsl:apply-templates select="*[2]"/> + <xsl:text>}}</xsl:text> +<!-- + </xsl:otherwise> +</xsl:choose> +--> +</xsl:template> +<xsl:template match="mml:mover"> +<!--<xsl:choose> + <xsl:when test="normalize-space(*[2]) = ¯"> + <xsl:text>\overline{</xsl:text><xsl:apply-templates select="*[1]"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:when test="normalize-space(*[2]) = ︷"> + <xsl:text>\overbrace{</xsl:text><xsl:apply-templates select="*[1]"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:when test="normalize-space(*[2]) = ︵"> + <xsl:text>\widehat{</xsl:text><xsl:apply-templates select="*[1]"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:when test="normalize-space(*[2]) = ⎴"> + <xsl:text>\widehat{</xsl:text><xsl:apply-templates select="*[1]"/><xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> + </xsl:otherwise> +</xsl:choose>--> + <xsl:choose> + <xsl:when test="@accent='true' or ( local-name(*[2])='mo' and not(@accent='false'))"> + <xsl:variable name="equivalent"> + <xsl:call-template name="generate.equivalent"> + <xsl:with-param name="arguments" select="1"/> + <xsl:with-param name="character" select="normalize-space(*[2])"/> + </xsl:call-template> + </xsl:variable> + <xsl:choose> + <xsl:when test="$equivalent!=''"> + <xsl:text>{</xsl:text> + <xsl:value-of select="$equivalent"/> + <xsl:text>{</xsl:text> + <xsl:apply-templates select="*[1]"/> + <xsl:text>}}</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>{</xsl:text> + <xsl:apply-templates select="*[1]"/> + <xsl:text>^{</xsl:text> + <xsl:apply-templates select="*[2]"/> + <xsl:text>}}</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:text>{</xsl:text> + <xsl:apply-templates select="*[1]"/> + <xsl:text>^{</xsl:text> + <xsl:apply-templates select="*[2]"/> + <xsl:text>}}</xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + +<!-- Math UnderOver --> +<xsl:template match="mml:munderover"> + <xsl:text>{</xsl:text> + <xsl:apply-templates select="*[1]"/> + <xsl:text>_{</xsl:text> + <xsl:apply-templates select="*[2]"/> + <xsl:text>}</xsl:text> + <xsl:text>^{</xsl:text> + <xsl:apply-templates select="*[3]"/> + <xsl:text>}}</xsl:text> + <!-- + <xsl:text>\overset{</xsl:text> + <xsl:apply-templates select="*[3]"/> + <xsl:text>}{\underset{</xsl:text> + <xsl:apply-templates select="*[2]"/> + <xsl:text>}{</xsl:text> + <xsl:apply-templates select="*[1]"/> + <xsl:text>}}</xsl:text> + --> +</xsl:template> + + + +<!-- Math Fenced --> +<xsl:template match="mml:mfenced"> +<!-- get open,close, separators att --> + <xsl:choose> + <xsl:when test="@open='('"> + <xsl:text> {\left( </xsl:text> + </xsl:when> + <xsl:when test="@open='{'"> + <xsl:text> {\left\{ </xsl:text> + </xsl:when> + <xsl:when test="@open='['"> + <xsl:text> {\left[\, </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text> {\left( </xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:apply-templates select="*[1]"/> + <xsl:choose> + <xsl:when test="@close=')'"> + <xsl:text> \right)} </xsl:text> + </xsl:when> + <xsl:when test="@close='}'"> + <xsl:text> \right\}} </xsl:text> + </xsl:when> + <xsl:when test="@close=']'"> + <xsl:text> \,\right]} </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text> \right)} </xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + +<!-- Math frac --> +<xsl:template match="mml:mfrac"> +<xsl:choose> +<xsl:when test="@linethickness"> + <xsl:choose> + <xsl:when test="@linethickness='thin'"> + <xsl:text> \frac[1pt]{ </xsl:text> + </xsl:when> + <xsl:when test="@linethickness='medium'"> + <xsl:text> \frac[1.1pt]{ </xsl:text> + </xsl:when> + <xsl:when test="@linethickness='thick'"> + <xsl:text> \frac[1.2pt]{ </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text> \frac[</xsl:text><xsl:value-of select="@linethickness"/><xsl:text>]{ </xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:when> +<xsl:otherwise> + <xsl:text> \frac{ </xsl:text> +</xsl:otherwise> +</xsl:choose> +<!-- <xsl:value-of select="*[1]"/> --> +<xsl:apply-templates select="*[1]"/> +<xsl:text> }{ </xsl:text> +<!-- <xsl:value-of select="*[2]"/> --> +<xsl:apply-templates select="*[2]"/> +<xsl:text> }</xsl:text> +</xsl:template> + + +<!-- Math msqrt --> +<xsl:template match="mml:msqrt"> + <xsl:text> \sqrt{ </xsl:text> + <xsl:apply-templates/> + <xsl:text> }</xsl:text> +</xsl:template> + + +<!-- Math mroot --> +<xsl:template match="mml:mroot"> + <xsl:text> \sqrt[</xsl:text><xsl:apply-templates select="*[1]"/><xsl:text>]{</xsl:text> + <xsl:apply-templates select="*[2]"/><xsl:text> }</xsl:text> +</xsl:template> + + + +<xsl:template name="mtable.format.tabular"> + <xsl:param name="cols" select="1"/> + <xsl:param name="i" select="1"/> + <xsl:choose> + <!-- Out of the recursive iteration --> + <xsl:when test="$i > $cols"></xsl:when> + <!-- There are still columns to count --> + <xsl:otherwise> + <xsl:text>c</xsl:text> + <!-- Recursive for next column --> + <xsl:call-template name="mtable.format.tabular"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + +<xsl:template match="mml:mtable"> +<xsl:variable name="rows" select="mml:mtr"/> +\begin{array}{<xsl:text></xsl:text> +<xsl:call-template name="mtable.format.tabular"><xsl:with-param name="cols" select="count($rows)"/></xsl:call-template> +<xsl:text>}\hline </xsl:text> + <xsl:apply-templates/> +<xsl:text>\end{array} </xsl:text> +</xsl:template> + +<xsl:template match="mml:mtr"> +<!-- Row starts here --> +<xsl:apply-templates/> +<!-- End Row here --> +</xsl:template> + +<xsl:template match="mml:mtd"> + <xsl:apply-templates/><xsl:text> & </xsl:text> +</xsl:template> + +<xsl:template match="mml:mtd[position()=last()]"> + <xsl:apply-templates/>\\ \hline +</xsl:template> + +<xsl:template match="mml:mtd[position()=last()]"> + <xsl:apply-templates/>\\ \hline +</xsl:template> + +<xsl:template match="mml:mphantom"> + <xsl:apply-templates mode="phantom"/> +</xsl:template> + +<xsl:template match="mml:mi" mode="phantom"> + <xsl:variable name="fontstyle" select="@fontstyle"/> + <xsl:variable name="identifier" select="normalize-space(.)"/> + <xsl:choose> + <xsl:when test="$identifier='ⅇ'"> + <xsl:text>\textrm{e}</xsl:text> + </xsl:when> + <xsl:when test="$identifier='ⅈ'"> + <xsl:text>\textrm{i}</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\textrm{</xsl:text> <xsl:copy-of select="$identifier"/> <xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:template> +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/mediaobject.mod.xsl b/docs/docbook/xslt/db2latex/mediaobject.mod.xsl new file mode 100644 index 0000000000..dc1685b480 --- /dev/null +++ b/docs/docbook/xslt/db2latex/mediaobject.mod.xsl @@ -0,0 +1,227 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: mediaobject.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: Manage Imageobject related tags. ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="mediaobject" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: mediaobject.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>MediaObjects <filename>mediaobject.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + <xsl:template match="videoobject"> + <xsl:apply-templates select="videodata"/> + </xsl:template> + <xsl:template match="audioobject"> + <xsl:apply-templates select="audiodata"/> + </xsl:template> + <xsl:template match="textobject"> + <!-- TODO if mixed in with imageobjects, use subfigure (if appropriate) --> + <xsl:apply-templates/> + </xsl:template> + + + <xsl:template match="mediaobject"> + <xsl:if test="local-name(preceding-sibling::*[1])!='mediaobject'"> + <xsl:text> </xsl:text> + </xsl:if> + <xsl:call-template name="mediacontent"/> + <xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="inlinemediaobject"> + <xsl:call-template name="mediacontent"/> + </xsl:template> + + <xsl:template name="mediacontent"> + <xsl:choose> + <xsl:when test="count(imageobject)<1"> + <xsl:apply-templates select="textobject[1]"/> + </xsl:when> + <xsl:when test="$use.role.for.mediaobject='1' and $preferred.mediaobject.role!='' and count(imageobject[@role='$preferred.mediaobject.role'])!=0"> + <xsl:apply-templates select="imageobject[@role=$preferred.mediaobject.role]"/> + </xsl:when> + <xsl:when test="$use.role.for.mediaobject='1' and count(imageobject[@role='latex'])!=0"> + <xsl:apply-templates select="imageobject[@role='latex']"/> + </xsl:when> + <xsl:when test="$use.role.for.mediaobject='1' and count(imageobject[@role='tex'])!=0"> + <xsl:apply-templates select="imageobject[@role='tex']"/> + </xsl:when> + <xsl:when test="$latex.graphics.formats!='' and count(imageobject/imagedata[@format!=''])!=0"> + <!-- this is not really the right method: formats to the left of $latex.graphics.formats + should be given higher 'priority' than those to the right in a command-separated list --> + <xsl:variable name="formats" select="concat(',',$latex.graphics.formats,',')"/> + <xsl:variable name="candidates" select="imageobject/imagedata[contains($formats,concat(',',@format,','))]"/> + <xsl:choose> + <xsl:when test="count($candidates)!=0"> + <xsl:apply-templates select="$candidates[1]"/> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="fallbacks" select="imageobject/imagedata[@format='']"/> + <xsl:choose> + <xsl:when test="count($fallbacks)!=0"> + <xsl:apply-templates select="$fallbacks[1]"/> + </xsl:when> + <xsl:when test="count(textobject)!=0"> + <xsl:apply-templates select="textobject[1]"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="imageobject[1]"/> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="imageobject[1]"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="imageobject"> + <xsl:apply-templates select="imagedata"/> + </xsl:template> + + + + + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="imagedata" xmlns=""> + <refpurpose>XSL template for images.</refpurpose> + <refdescription> + <para></para> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + <listitem><para>If both <literal>@width</literal> and <literal>@scale</literal> are given but <literal>@scalefit='0'</literal>, whitespace is added to the left and right in order to match the specified width.</para></listitem> + <listitem><para>If <literal>@width</literal> is given and either <literal>@scalefit=1</literal> or no <literal>@scale</literal> is given, then the image is scale to <literal>@width</literal>. Otherwise, <literal>@scale</literal> is used, if it is present.</para></listitem> + <listitem><para>If this is not the only <literal>imagedata</literal> within the figure, this will be rendered as a 'subfigure', including the <literal>caption</literal> of its enclosing <literal>mediaobject</literal>.</para></listitem> + </itemizedlist> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + <xsl:template match="imagedata"> + <xsl:variable name="filename" select="@fileref"/> + <xsl:variable name="ext"> + <xsl:call-template name="filename-extension"> + <xsl:with-param name="filename" select="$filename"/> + </xsl:call-template> + </xsl:variable> + <xsl:variable name="imageobjectscnt" select="count(../../..//imageobject)"/> + <xsl:variable name="width"> + <xsl:choose> + <xsl:when test="contains(@width, '%') and substring-after(@width, '%')=''"> + <xsl:value-of select="number(substring-before(@width, '%')) div 100"/> + <xsl:text>\textwidth</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="@width"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:if test="$width!='' and (@scalefit='0' or count(@scale)>0)"> + <xsl:text>\makebox[</xsl:text><xsl:value-of select='$width' /><xsl:text>]</xsl:text> + </xsl:if> + <xsl:text>{</xsl:text> + <!-- TODO this logic actually needs to make decisions based on the ALLOWED imagedata, + not all the imagedata present in the source file. --> + <xsl:if test="$imageobjectscnt > 1 and $latex.use.subfigure='1' and count(ancestor::figure) > 0"> + <xsl:text>\subfigure[</xsl:text> + <xsl:if test="count(../../..//caption)>1"> + <xsl:value-of select="../../caption"/> + </xsl:if> + <xsl:text>]</xsl:text> + </xsl:if> + <xsl:text>{\includegraphics[</xsl:text> + <xsl:choose> + <xsl:when test="@scale"> + <xsl:text>scale=</xsl:text> + <xsl:value-of select="number(@scale) div 100"/> + </xsl:when> + <xsl:when test="$width!='' and @scalefit='1'"> + <xsl:text>width=</xsl:text><xsl:value-of select="normalize-space($width)"/> + </xsl:when> + <xsl:when test="@depth!='' and @scalefit='1'"> + <xsl:text>height=</xsl:text><xsl:value-of select="normalize-space(@depth)"/> + </xsl:when> + </xsl:choose> + <xsl:choose> + <xsl:when test="@format = 'PRN'"><xsl:text>,angle=270</xsl:text></xsl:when> + </xsl:choose> + <xsl:text>]{</xsl:text> + <xsl:choose><!-- package graphicx and DeclareGraphicExtensions will take care of this --> + <xsl:when test="$ext != ''"> + <xsl:value-of select="$filename"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$filename"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text>}}}</xsl:text> + </xsl:template> + + + + <xsl:template match="videodata"> + <xsl:variable name="filename"> + <xsl:call-template name="mediaobject.filename"><xsl:with-param name="object" select=".."/> + </xsl:call-template> + </xsl:variable> + <xsl:variable name="alt"> + <xsl:apply-templates select="(../../textobject/phrase)[1]"/> + </xsl:variable> + </xsl:template> + + <xsl:template match="audiodata"> + <xsl:variable name="filename"> + <xsl:call-template name="mediaobject.filename"><xsl:with-param name="object" select=".."/> + </xsl:call-template> + </xsl:variable> + <xsl:variable name="alt"> + <xsl:apply-templates select="(../../textobject/phrase)[1]"/> + </xsl:variable> + </xsl:template> + + + <xsl:template match="caption"> + <xsl:apply-templates/> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/msgset.mod.xsl b/docs/docbook/xslt/db2latex/msgset.mod.xsl new file mode 100644 index 0000000000..aef046f665 --- /dev/null +++ b/docs/docbook/xslt/db2latex/msgset.mod.xsl @@ -0,0 +1,78 @@ +<?xml version='1.0'?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version='1.0'> + <!--############################################################################# + | $Id: msgset.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: + + ############################################################################## --> + + + <xsl:template match="msgset"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="msgentry"> + <xsl:call-template name="block.object"/> + </xsl:template> + + <xsl:template match="simplemsgentry"> + <xsl:call-template name="block.object"/> + </xsl:template> + + <xsl:template match="msg"> + <xsl:call-template name="block.object"/> + </xsl:template> + + <xsl:template match="msgmain"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="msgmain/title"> + <b><xsl:apply-templates/></b> + </xsl:template> + + <xsl:template match="msgsub"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="msgsub/title"> + <b><xsl:apply-templates/></b> + </xsl:template> + + <xsl:template match="msgrel"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="msgrel/title"> + <b><xsl:apply-templates/></b> + </xsl:template> + + <xsl:template match="msgtext"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="msginfo"> + <xsl:call-template name="block.object"/> + </xsl:template> + + <xsl:template match="msglevel|msgorig|msgaud"> + <p> + <b> + <xsl:call-template name="gentext.element.name"/> + <xsl:text>: </xsl:text> + </b> + <xsl:apply-templates/> + </p> + </xsl:template> + + <xsl:template match="msgexplan"> + <xsl:call-template name="block.object"/> + </xsl:template> + + <xsl:template match="msgexplan/title"> + <xsl:apply-templates/> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/normalize-scape.mod.xsl b/docs/docbook/xslt/db2latex/normalize-scape.mod.xsl new file mode 100644 index 0000000000..15e2e94e25 --- /dev/null +++ b/docs/docbook/xslt/db2latex/normalize-scape.mod.xsl @@ -0,0 +1,401 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: normalize-scape.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: +| Escape LaTeX and normalize-space templates. +| < > # $ % & ~ _ ^ \ { } ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="normalize-scape" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: normalize-scape.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright><year>2000</year><year>2001</year><year>2002</year><year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>Normalize and Scape strings.</title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + <!--############################################################################# --> + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template name="normalize-scape" xmlns=""> + <refpurpose> Abstract XSL template. </refpurpose> + <refdescription> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="text()"> + <xsl:call-template name="trim-outer"> + <xsl:with-param name="string"> + <xsl:choose> + <xsl:when test="ancestor::literal|ancestor::email|ancestor::sgmltag"> + <xsl:call-template name="scape-verbatim"> + <xsl:with-param name="string" select="."/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="scape"> + <xsl:with-param name="string" select="."/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template match="text()" mode="xref.text"> + <xsl:call-template name="trim-outer"> + <xsl:with-param name="string"> + <xsl:call-template name="scape"> + <xsl:with-param name="string" select="."/> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template match="text()" mode="xref-to"> + <xsl:call-template name="trim-outer"> + <xsl:with-param name="string"> + <xsl:call-template name="scape"> + <xsl:with-param name="string" select="."/> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template match="text()" mode="latex.verbatim"> + <!-- + <xsl:call-template name="trim-outer"> + <xsl:with-param name="string"> + --> + <xsl:value-of select="."/> + <!-- + </xsl:with-param> + </xsl:call-template> + --> + </xsl:template> + + <!-- this template is noly used by xref.mod.xsl and only when + $latex.hyphenation.tttricks != 1. --> + <xsl:template match="text()" mode="slash.hyphen"> + <xsl:call-template name="trim-outer"> + <xsl:with-param name="string"> + <xsl:call-template name="scape.slash.hyphen"> + <xsl:with-param name="string" select="." /> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template name="trim-outer"> + <xsl:param name="string"/> + <xsl:variable name="trimleft" select="position()=1"/> + <xsl:variable name="trimright" select="position()=last()"/> + <xsl:choose> + <xsl:when test="$trimleft and not($trimright)"> + <xsl:value-of select="substring-before(normalize-space(concat($string,'$$')),'$$')"/> + </xsl:when> + <xsl:when test="$trimright and not($trimleft)"> + <xsl:value-of select="substring-after(normalize-space(concat('$$',$string)),'$$')"/> + </xsl:when> + <xsl:when test="$trimleft and $trimright"> + <xsl:value-of select="normalize-space($string)"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$string"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="scape.slash.hyphen"> + <xsl:param name="string" /> + <xsl:choose> + <xsl:when test="contains($string,'://')"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">/\-</xsl:with-param> + <xsl:with-param name="from">/</xsl:with-param> + <xsl:with-param name="string"> + <xsl:value-of select="substring-before($string,'://')"/> + <xsl:value-of select="'://'"/> + <xsl:call-template name="scape"> + <xsl:with-param name="string" select="substring-after($string,'://')"/> + </xsl:call-template></xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">/\-</xsl:with-param> + <xsl:with-param name="from">/</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="scape"> + <xsl:with-param name="string" select="$string"/> + </xsl:call-template></xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="normalize-scape" > + <xsl:param name="string"/> + <xsl:variable name="result"> + <xsl:call-template name="scape"><xsl:with-param name="string" select="$string"/></xsl:call-template> + </xsl:variable> + <xsl:value-of select="normalize-space($result)"/> + </xsl:template> + + + <xsl:template name="scape" > + <xsl:param name="string"/> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\textless{}</xsl:with-param> + <xsl:with-param name="from"><</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\textgreater{}</xsl:with-param> + <xsl:with-param name="from">></xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\textasciitilde{}</xsl:with-param> + <xsl:with-param name="from">~</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\^{}</xsl:with-param> + <xsl:with-param name="from">^</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\&</xsl:with-param> + <xsl:with-param name="from">&</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\#</xsl:with-param> + <xsl:with-param name="from">#</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\_</xsl:with-param> + <xsl:with-param name="from">_</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\$</xsl:with-param> + <xsl:with-param name="from">$</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\%</xsl:with-param> + <xsl:with-param name="from">%</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\{</xsl:with-param> + <xsl:with-param name="from">{</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\}</xsl:with-param> + <xsl:with-param name="from">}</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\textbackslash \ </xsl:with-param> + <xsl:with-param name="from">\textbackslash </xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\textbackslash </xsl:with-param> + <xsl:with-param name="from">\</xsl:with-param> + <xsl:with-param name="string" select="$string"></xsl:with-param> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template name="scape-verbatim" > + <xsl:param name="string"/> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\textasciitilde{}</xsl:with-param> + <xsl:with-param name="from">~</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\^{}</xsl:with-param> + <xsl:with-param name="from">^</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\&</xsl:with-param> + <xsl:with-param name="from">&</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\#</xsl:with-param> + <xsl:with-param name="from">#</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\_</xsl:with-param> + <xsl:with-param name="from">_</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\$</xsl:with-param> + <xsl:with-param name="from">$</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\%</xsl:with-param> + <xsl:with-param name="from">%</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\docbooktolatexgobble\string\{</xsl:with-param> + <xsl:with-param name="from">{</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\docbooktolatexgobble\string\}</xsl:with-param> + <xsl:with-param name="from">}</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\docbooktolatexgobble\string\\</xsl:with-param> + <xsl:with-param name="from">\</xsl:with-param> + <xsl:with-param name="string" select="$string"/> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template></xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template name="scape-href" > + <xsl:param name="string"/> + <!-- maybe we should warn when there are invalid characters --> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\&</xsl:with-param> + <xsl:with-param name="from">&</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\%</xsl:with-param> + <xsl:with-param name="from">%</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\{</xsl:with-param> + <xsl:with-param name="from">{</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\{</xsl:with-param> + <xsl:with-param name="from">{</xsl:with-param> + <xsl:with-param name="string"> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">\docbooktolatexgobble\string\\</xsl:with-param> + <xsl:with-param name="from">\</xsl:with-param> + <xsl:with-param name="string" select="$string"/> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:template> + + <doc:template name="scape-optionalarg" xmlns=""> + <refpurpose> Escape the ] character in LaTeX optional arguments (experimental) </refpurpose> + <refdescription> + </refdescription> + </doc:template> + <xsl:template name="scape-optionalarg" > + <xsl:param name="string"/> + <xsl:call-template name="string-replace"> + <xsl:with-param name="to">{\rbrack}</xsl:with-param> + <xsl:with-param name="from">]</xsl:with-param> + <xsl:with-param name="string" select="$string"/> + </xsl:call-template> + </xsl:template> + + + + + <xsl:template name="string-replace"> + <xsl:param name="string"/> + <xsl:param name="from"/> + <xsl:param name="to"/> + + <xsl:choose> + <xsl:when test="contains($string, $from)"> + + <xsl:variable name="before" select="substring-before($string, $from)"/> + <xsl:variable name="after" select="substring-after($string, $from)"/> + <xsl:variable name="prefix" select="concat($before, $to)"/> + + <xsl:value-of select="$before"/> + <xsl:value-of select="$to"/> + <xsl:call-template name="string-replace"> + <xsl:with-param name="string" select="$after"/> + <xsl:with-param name="from" select="$from"/> + <xsl:with-param name="to" select="$to"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$string"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + + <!-- + (c) David Carlisle + replace all occurences of the character(s) `from' + by the string `to' in the string `string'. + <xsl:template name="string-replace" > + <xsl:param name="string"/> + <xsl:param name="from"/> + <xsl:param name="to"/> + <xsl:choose> + <xsl:when test="contains($string,$from)"> + <xsl:value-of select="substring-before($string,$from)"/> + <xsl:value-of select="$to"/> + <xsl:call-template name="string-replace"> + <xsl:with-param name="string" select="substring-after($string,$from)"/> + <xsl:with-param name="from" select="$from"/> + <xsl:with-param name="to" select="$to"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$string"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + --> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/para.mod.xsl b/docs/docbook/xslt/db2latex/para.mod.xsl new file mode 100644 index 0000000000..64d6d8f01d --- /dev/null +++ b/docs/docbook/xslt/db2latex/para.mod.xsl @@ -0,0 +1,74 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: para.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="para" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: para.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>Paragraphs <filename>para.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <xsl:template match="para"> + <xsl:text> </xsl:text> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="simpara"> + <xsl:text> </xsl:text> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="formalpara"> + <xsl:text> \textbf{</xsl:text> + <xsl:call-template name="normalize-scape"><xsl:with-param name="string" select="title"/></xsl:call-template> + <xsl:text>} </xsl:text> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + <xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="formalpara/title"/> + + <!--========================================================================== + | Especial Cases Do not add Linefeed + +============================================================================--> + + <xsl:template match="textobject/para"> <xsl:apply-templates/> </xsl:template> + <xsl:template match="step/para"> <xsl:apply-templates/> </xsl:template> + <xsl:template match="entry/para"> <xsl:apply-templates/> </xsl:template> + <xsl:template match="question/para"> <xsl:apply-templates/> </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/part-chap-app.mod.xsl b/docs/docbook/xslt/db2latex/part-chap-app.mod.xsl new file mode 100644 index 0000000000..376b2b82e6 --- /dev/null +++ b/docs/docbook/xslt/db2latex/part-chap-app.mod.xsl @@ -0,0 +1,139 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: part-chap-app.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: Part ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="part-chap-app" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: part-chap-app.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>Parts, Chapters and Appendixes <filename>part-chap-app.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + <!--############################################################################# --> + + + + + <xsl:template match="part"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="part/docinfo"/> + <xsl:template match="part/title"/> + <xsl:template match="part/subtitle"/> + <xsl:template match="partintro"/> + <xsl:template match="partintro/title"/> + <xsl:template match="partintro/subtitle"/> + <xsl:template match="partintro/titleabbrev"/> + + + <!--############################################################################# + | $Id: part-chap-app.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: Chapter + + ############################################################################## --> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="chapter" xmlns=""> + <refpurpose> XSL template for Chapters.</refpurpose> + <refdescription> + <para> This is the main entry point for a <sgmltag class="start">chapter</sgmltag> subtree. + This template processes any chapter. Outputs <literal>\chapter{title}</literal>, calls + templates and apply-templates. Since chapters only apply in books, + some assumptions could be done in order to optimize the stylesheet behaviour.</para> + + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + <listitem><para> + EMPTY templates: chapter/title, + chapter/titleabbrev, + chapter/subtitle, + chapter/docinfo|chapterinfo.</para></listitem> + </itemizedlist> + </formalpara> + + <formalpara><title>Affected by</title> map. + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="chapter"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + <xsl:call-template name="map.end"/> + </xsl:template> + + <xsl:template match="chapter/title"/> + <xsl:template match="chapter/titleabbrev"/> + <xsl:template match="chapter/subtitle"/> + <xsl:template match="chapter/docinfo|chapterinfo"/> + + + <!--############################################################################# + | $Id: part-chap-app.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: + + ############################################################################## --> + + <xsl:template match="appendix"> + <xsl:if test="not (preceding-sibling::appendix)"> + <xsl:text> </xsl:text> + <xsl:choose> + <xsl:when test="local-name(..)='book' or local-name(..)='part'"> + <xsl:text>\newcommand{\dbappendix}[1]{\chapter{#1}}% </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\newcommand{\dbappendix}[1]{\section{#1}}% </xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword">appendixes</xsl:with-param> + </xsl:call-template> + </xsl:if> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + <xsl:call-template name="map.end"/> + </xsl:template> + + + <xsl:template match="appendix/title"/> + <xsl:template match="appendix/titleabbrev"/> + <xsl:template match="appendix/subtitle"/> + <xsl:template match="appendix/docinfo|appendixinfo"/> +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/pi.mod.xsl b/docs/docbook/xslt/db2latex/pi.mod.xsl new file mode 100644 index 0000000000..fe84aa446e --- /dev/null +++ b/docs/docbook/xslt/db2latex/pi.mod.xsl @@ -0,0 +1,184 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: pi.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="abstract" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: pi.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year><year>2002</year><year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Processing Instructions</title> + + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + <doc:template match="processing-instruction()" xmlns=""> + <refpurpose> Processing Instruction XSL template. </refpurpose> + <refdescription> + </refdescription> + </doc:template> + + + <xsl:template match="processing-instruction()"> + </xsl:template> + + <xsl:template match="processing-instruction('rcas')"> + <xsl:processing-instruction name="dbhtml"> + <xsl:value-of select="."/> + </xsl:processing-instruction> + </xsl:template> + + <xsl:template match="processing-instruction('db2latex')"> + </xsl:template> + + + + + <xsl:template name="process.cmdsynopsis.list"> + <xsl:param name="cmdsynopses"/><!-- empty node list by default --> + <xsl:param name="count" select="1"/> + + <xsl:choose> + <xsl:when test="$count>count($cmdsynopses)"></xsl:when> + <xsl:otherwise> + <xsl:variable name="cmdsyn" select="$cmdsynopses[$count]"/> + + <dt> + <a> + <xsl:attribute name="href"> + <xsl:call-template name="label.id"> + <xsl:with-param name="object" select="$cmdsyn"/> + </xsl:call-template> + </xsl:attribute> + + <xsl:choose> + <xsl:when test="$cmdsyn/@xreflabel"> + <xsl:call-template name="xref.xreflabel"> + <xsl:with-param name="target" select="$cmdsyn"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <!-- RCAS Fixme + <xsl:call-template name="xref.cmdsynopsis"> + <xsl:with-param name="target" select="$cmdsyn"/> + </xsl:call-template>--> + </xsl:otherwise> + </xsl:choose> + </a> + </dt> + + <xsl:call-template name="process.cmdsynopsis.list"> + <xsl:with-param name="cmdsynopses" select="$cmdsynopses"/> + <xsl:with-param name="count" select="$count+1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="processing-instruction('dbcmdlist')"> + <xsl:variable name="cmdsynopses" select="..//cmdsynopsis"/> + + <xsl:if test="count($cmdsynopses)<1"> + <xsl:message><xsl:text>No cmdsynopsis elements matched dbcmdlist PI, perhaps it's nested too deep?</xsl:text> + </xsl:message> + </xsl:if> + + <dl> + <xsl:call-template name="process.cmdsynopsis.list"> + <xsl:with-param name="cmdsynopses" select="$cmdsynopses"/> + </xsl:call-template> + </dl> + </xsl:template> + + <!-- ==================================================================== --> + + <xsl:template name="process.funcsynopsis.list"> + <xsl:param name="funcsynopses"/><!-- empty node list by default --> + <xsl:param name="count" select="1"/> + + <xsl:choose> + <xsl:when test="$count>count($funcsynopses)"></xsl:when> + <xsl:otherwise> + <xsl:variable name="cmdsyn" select="$funcsynopses[$count]"/> + + <dt> + <a> + <xsl:attribute name="href"> + <xsl:call-template name="label.id"> + <xsl:with-param name="object" select="$cmdsyn"/> + </xsl:call-template> + </xsl:attribute> + + <xsl:choose> + <xsl:when test="$cmdsyn/@xreflabel"> + <xsl:call-template name="xref.xreflabel"> + <xsl:with-param name="target" select="$cmdsyn"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <!-- RCAS Fixme + <xsl:call-template name="xref.funcsynopsis"> + <xsl:with-param name="target" select="$cmdsyn"/> + </xsl:call-template> + --> + </xsl:otherwise> + </xsl:choose> + </a> + </dt> + + <xsl:call-template name="process.funcsynopsis.list"> + <xsl:with-param name="funcsynopses" select="$funcsynopses"/> + <xsl:with-param name="count" select="$count+1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="processing-instruction('dbfunclist')"> + <xsl:variable name="funcsynopses" select="..//funcsynopsis"/> + + <xsl:if test="count($funcsynopses)<1"> + <xsl:message><xsl:text>No funcsynopsis elements matched dbfunclist PI, perhaps it's nested too deep?</xsl:text> + </xsl:message> + </xsl:if> + + <dl> + <xsl:call-template name="process.funcsynopsis.list"> + <xsl:with-param name="funcsynopses" select="$funcsynopses"/> + </xsl:call-template> + </dl> + </xsl:template> + + <!-- ==================================================================== --> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/preamble.mod.xsl b/docs/docbook/xslt/db2latex/preamble.mod.xsl new file mode 100644 index 0000000000..3e66f33c16 --- /dev/null +++ b/docs/docbook/xslt/db2latex/preamble.mod.xsl @@ -0,0 +1,813 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: preamble.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: Variables and templates to manage LaTeX preamble. ++ ############################################################################## --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <doc:reference id="preamble" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: preamble.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright><year>2000</year><year>2001</year><year>2002</year><year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Variables and Templates used in LaTeX Preamble Generation</title> + + <partintro> + <section><title>Introduction</title> + <para> This section described the variables and templates that are used in the generation of + the outtput LaTeX preamble. Basically, the LaTeX preamble depends on the XML document, that is, + on whether it is an article or a book.</para> + </section> + + <section><title>Flow</title> + <section><title>Articles</title> + <para></para> + </section> + <section><title>Books</title> + <para></para> + </section> + </section> + </partintro> + </doc:reference> + + + + <!--############################################################################# + | generate.latex.article.preamble and generate.latex.book.preamble + |- ############################################################################# + | Top-level named templates. + | LaTeX Preamble. + | + + ############################################################################## --> + + <!-- DOCUMENTATION --> + <doc:template name="generate.latex.article.preamble" xmlns=""> + <refpurpose> Top level template, called by article template, + responsible of generating the LaTeX preamble according to user + XSL variables and templates. + </refpurpose> + <refdescription> + <formalpara><title>Overview</title> + If the xsl:variable <literal>latex.override</literal> + is empty, the template outputs <literal>latex.article.preamblestart</literal> + and calls <literal>generate.latex.common.preamble</literal>. Otherwise, + it outputs the value of <literal>latex.override</literal> and + exists. + </formalpara> + </refdescription> + <refauthor>Ramon Casellas <email>casellas@aist.enst.fr</email></refauthor> + </doc:template> + + <!-- TEMPLATE --> + <xsl:template name="generate.latex.article.preamble"> + <xsl:choose> + <xsl:when test="$latex.override = ''"> + <xsl:value-of select="$latex.article.preamblestart"/> + <xsl:value-of select="$latex.article.preamble.pre"/> + <xsl:call-template name="label.id"/> + <xsl:call-template name="generate.latex.common.preamble"/> + <xsl:call-template name="generate.latex.essential.preamble"/> + <xsl:value-of select="$latex.article.preamble.post"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$latex.override"/> + <xsl:call-template name="generate.latex.essential.preamble"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <!-- DOCUMENTATION --> + <doc:template name="generate.latex.book.preamble" xmlns=""> + <refpurpose> Top level template, called by book template, + responsible of generating the LaTeX preamble according to user + XSL variables and templates. + </refpurpose> + <refdescription> + <formalpara><title>Overview</title> + If the xsl:variable <literal>latex.override</literal> + is empty, the template outputs <literal>latex.book.preamblestart</literal> + and calls <literal>generate.latex.common.preamble</literal>. Otherwise, + it outputs the value of <literal>latex.override</literal> and + exists. + </formalpara> + </refdescription> + <refauthor>Ramon Casellas <email>casellas@aist.enst.fr</email></refauthor> + </doc:template> + + <!-- TEMPLATE --> + <xsl:template name="generate.latex.book.preamble"> + <xsl:choose> + <xsl:when test="$latex.override = ''"> + <xsl:value-of select="$latex.book.preamblestart"/> + <xsl:value-of select="$latex.book.preamble.pre"/> + <xsl:call-template name="label.id"/> + <xsl:call-template name="generate.latex.common.preamble"/> + <xsl:call-template name="generate.latex.essential.preamble"/> + <xsl:value-of select="$latex.book.preamble.post"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$latex.override"/> + <xsl:call-template name="generate.latex.essential.preamble"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + + + + <!--############################################################################# + | latex.article.preamblestart and latex.book.preamblestart + |- ############################################################################# + | + + ############################################################################## --> + + <doc:variable name="latex.article.preamblestart" xmlns=""> + <refpurpose> Generated Document class for articles. </refpurpose> + <refdescription> + </refdescription> + <refreturn> + <screen> + % -------------------------------------------- + % Autogenerated LaTeX file for articles + % -------------------------------------------- + \ifx\pdfoutput\undefined + \documentclass[spanish,french,english,a4paper,10pt,twoside,twocolumn]{article} + \else + \documentclass[pdftex,spanish,french,english,a4paper,10pt,twoside,twocolumn]{article} + \fi + </screen> + </refreturn> + </doc:variable> + + <xsl:variable name="latex.article.preamblestart"> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>% Autogenerated LaTeX file for articles </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>\ifx\pdfoutput\undefined </xsl:text> + <xsl:text>\documentclass[</xsl:text> + <xsl:value-of select='$latex.documentclass.common' /> + <xsl:text>,</xsl:text> + <xsl:value-of select='$latex.documentclass.article' /> + <xsl:text>,</xsl:text> + <xsl:value-of select='$latex.documentclass.pdftex' /> + <xsl:text>]{</xsl:text> + <xsl:choose> + <xsl:when test="$latex.documentclass!=''"><xsl:value-of select="$latex.documentclass" /></xsl:when> + <xsl:otherwise><xsl:text>article</xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:text>} </xsl:text> + <xsl:text>\else </xsl:text> + <xsl:text>\documentclass[pdftex,</xsl:text> + <xsl:value-of select='$latex.documentclass.common' /> + <xsl:text>,</xsl:text> + <xsl:value-of select='$latex.documentclass.article' /> + <xsl:text>,</xsl:text> + <xsl:value-of select='$latex.documentclass.dvips' /> + <xsl:text>]{</xsl:text> + <xsl:choose> + <xsl:when test="$latex.documentclass!=''"><xsl:value-of select="$latex.documentclass" /></xsl:when> + <xsl:otherwise><xsl:text>article</xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:text>} </xsl:text> + <xsl:text>\fi </xsl:text> + </xsl:variable> + + <doc:variable name="latex.book.preamblestart" xmlns=""> + <refpurpose>Generated Document class for books. </refpurpose> + <refdescription> + </refdescription> + <refreturn> + <screen> + % ------------------------------------------------------------ + % Autogenerated LaTeX file for books + % ------------------------------------------------------------ + \ifx\pdfoutput\undefined + \documentclass[spanish,french,english,a4paper,twoside,openright,10pt,final]{report} + \else + \documentclass[pdftex,spanish,french,english,a4paper,twoside,openright,10pt,final]{report} + \fi + </screen> + </refreturn> + </doc:variable> + + <xsl:variable name="latex.book.preamblestart"> + <xsl:text>% ------------------------------------------------------------ </xsl:text> + <xsl:text>% Autogenerated LaTeX file for books </xsl:text> + <xsl:text>% ------------------------------------------------------------ </xsl:text> + <xsl:text>\ifx\pdfoutput\undefined </xsl:text> + <xsl:text>\documentclass[</xsl:text> + <xsl:value-of select='$latex.documentclass.common' /> + <xsl:text>,</xsl:text> + <xsl:value-of select='$latex.documentclass.book' /> + <xsl:text>,</xsl:text> + <xsl:value-of select='$latex.documentclass.pdftex' /> + <xsl:text>]{</xsl:text> + <xsl:choose> + <xsl:when test="$latex.documentclass!=''"><xsl:value-of select="$latex.documentclass" /></xsl:when> + <xsl:otherwise><xsl:text>report</xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:text>} </xsl:text> + <xsl:text>\else </xsl:text> + <xsl:text>\documentclass[pdftex,</xsl:text> + <xsl:value-of select='$latex.documentclass.common' /> + <xsl:text>,</xsl:text> + <xsl:value-of select='$latex.documentclass.book' /> + <xsl:text>,</xsl:text> + <xsl:value-of select='$latex.documentclass.dvips' /> + <xsl:text>]{</xsl:text> + <xsl:choose> + <xsl:when test="$latex.documentclass!=''"><xsl:value-of select="$latex.documentclass" /></xsl:when> + <xsl:otherwise><xsl:text>report</xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:text>} </xsl:text> + <xsl:text>\fi </xsl:text> + </xsl:variable> + + <!--############################################################################# + | generate.latex.common.preamble + |- ############################################################################# + | + + ############################################################################## --> + + <doc:variable name="generate.latex.common.preamble" xmlns=""> + <refpurpose> Common LaTeX preamble shared by articles and books, and other + document classes. Most of the packages and package options are managed here </refpurpose> + <refdescription> + </refdescription> + <refreturn> + The LaTeX preamble, after the document class and before the <literal>\begin{document}</literal> + command. + </refreturn> + </doc:variable> + + + + <xsl:template name="generate.latex.common.preamble"> + <xsl:choose> + <xsl:when test="$latex.pdf.support=1"><xsl:value-of select="$latex.pdf.preamble"/></xsl:when> + <xsl:otherwise><xsl:text>\usepackage{graphicx} </xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:if test="local-name(.)='article'"> + <xsl:value-of select="$latex.article.varsets"/> + </xsl:if> + <xsl:if test="local-name(.)='book'"> + <xsl:value-of select="$latex.book.varsets"/> + </xsl:if> + <xsl:if test="$latex.use.fancyhdr=1"> + <xsl:text>\usepackage{fancyhdr} </xsl:text> + <xsl:call-template name="generate.latex.pagestyle"/> + <!-- + Add dollar... + <xsl:if test="latex.fancyhdr.lh !=''"><xsl:text>\lhead{</xsl:text><xsl:value-of select="$latex.fancyhdr.lh"/><xsl:text>} </xsl:text></xsl:if> + <xsl:if test="latex.fancyhdr.ch !=''"><xsl:text>\chead{</xsl:text><xsl:value-of select="$latex.fancyhdr.ch"/><xsl:text>} </xsl:text></xsl:if> + <xsl:if test="latex.fancyhdr.rh !=''"><xsl:text>\rhead{</xsl:text><xsl:value-of select="$latex.fancyhdr.rh"/><xsl:text>} </xsl:text></xsl:if> + <xsl:if test="latex.fancyhdr.lf !=''"><xsl:text>\lfoot{</xsl:text><xsl:value-of select="$latex.fancyhdr.lf"/><xsl:text>} </xsl:text></xsl:if> + <xsl:if test="latex.fancyhdr.cf !=''"><xsl:text>\cfoot{</xsl:text><xsl:value-of select="$latex.fancyhdr.cf"/><xsl:text>} </xsl:text></xsl:if> + <xsl:if test="latex.fancyhdr.rf !=''"><xsl:text>\rfoot{</xsl:text><xsl:value-of select="$latex.fancyhdr.rf"/><xsl:text>} </xsl:text></xsl:if> + --> + + <xsl:text>\renewcommand{\headrulewidth}{0.4pt} </xsl:text> + <xsl:text>\renewcommand{\footrulewidth}{0.4pt} </xsl:text> + </xsl:if> + + <xsl:text>% ---------------------- </xsl:text> + <xsl:text>% Most Common Packages </xsl:text> + <xsl:text>% ---------------------- </xsl:text> + <xsl:if test="$latex.use.makeidx=1"><xsl:text>\usepackage{makeidx} </xsl:text></xsl:if> + <xsl:text>\usepackage{varioref} </xsl:text> + <xsl:text>\usepackage{latexsym} </xsl:text> + <xsl:text>\usepackage{enumerate} </xsl:text> + <xsl:if test="$latex.use.fancybox=1"> + <!-- must be before \usepackage{fancyvrb} --> + <xsl:text>\usepackage{fancybox} </xsl:text> + </xsl:if> + <xsl:text>\usepackage{float} </xsl:text> + <xsl:text>\usepackage{ragged2e} </xsl:text> + <xsl:if test="$latex.babel.language!=''"> + <xsl:text>\usepackage[</xsl:text><xsl:value-of select="$latex.babel.language" /><xsl:text>]{babel} </xsl:text> + </xsl:if> + <xsl:if test="$latex.use.fancyvrb=1"> + <!-- must be after \usepackage{fancybox} --> + <xsl:text>\usepackage{fancyvrb} </xsl:text> + <xsl:text>\makeatletter\@namedef{FV@fontfamily@default}{\def\FV@FontScanPrep{}\def\FV@FontFamily{}}\makeatother </xsl:text> + <xsl:if test="$latex.fancyvrb.tabsize!=''"> + <xsl:text>\fvset{obeytabs=true,tabsize=</xsl:text> + <xsl:value-of select="$latex.fancyvrb.tabsize"/> + <xsl:text>} </xsl:text> + </xsl:if> + </xsl:if> + <xsl:if test="$latex.use.isolatin1=1"><xsl:text>\usepackage{isolatin1} </xsl:text></xsl:if> + <xsl:if test="$latex.use.parskip=1"><xsl:text>\usepackage{parskip} </xsl:text></xsl:if> + <xsl:if test="$latex.use.rotating=1"><xsl:text>\usepackage{rotating} </xsl:text></xsl:if> + <xsl:if test="$latex.use.subfigure=1"><xsl:text>\usepackage{subfigure} </xsl:text></xsl:if> + <xsl:if test="$latex.use.tabularx=1"><xsl:text>\usepackage{tabularx} </xsl:text></xsl:if> + <xsl:if test="$latex.use.umoline=1"><xsl:text>\usepackage{umoline} </xsl:text></xsl:if> + <xsl:if test="$latex.use.url=1"><xsl:text>\usepackage{url} </xsl:text></xsl:if> + + <!-- Configure document font. --> + <xsl:if test="$latex.document.font != 'default'"> + <xsl:text>% --------------- </xsl:text> + <xsl:text>% Document Font </xsl:text> + <xsl:text>% --------------- </xsl:text> + <xsl:text>\usepackage{</xsl:text><xsl:value-of select="$latex.document.font"/><xsl:text>} </xsl:text> + </xsl:if> + <!-- Support for keywords. --> + <xsl:text> \def\keywords{\vspace{-.3em} </xsl:text> + <xsl:text> \if@twocolumn </xsl:text> + <xsl:text> \small{\itshape </xsl:text> + <xsl:call-template name="gentext"> + <xsl:with-param name="key">keywords</xsl:with-param> + </xsl:call-template> + <xsl:text> }\/\bfseries---$\!$% </xsl:text> + <xsl:text> \else </xsl:text> + <xsl:text> \begin{center}\small\bfseries </xsl:text> + <xsl:call-template name="gentext"> + <xsl:with-param name="key">keywords</xsl:with-param> + </xsl:call-template> + <xsl:text> \end{center}\quotation\small </xsl:text> + <xsl:text> \fi} </xsl:text> + <xsl:text> \def\endkeywords{\vspace{0.6em}\par\if@twocolumn\else\endquotation\fi </xsl:text> + <xsl:text> \normalsize\rmfamily} </xsl:text> + + <xsl:if test="$latex.math.support=1"><xsl:value-of select="$latex.math.preamble"/></xsl:if> + <xsl:if test="$latex.use.hyperref=1"> + <xsl:call-template name="latex.hyperref.preamble"/> + </xsl:if> + <xsl:value-of select="$latex.admonition.environment"/> + <xsl:call-template name="latex.float.preamble"/> + <xsl:call-template name="latex.graphicext"/> + <xsl:choose> + <xsl:when test='$latex.caption.swapskip=1'> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>% $latex.caption.swapskip enabled for $formal.title.placement support </xsl:text> + <xsl:text>\newlength{\docbooktolatextempskip} </xsl:text> + <xsl:text>\newcommand{\captionswapskip}{\setlength{\docbooktolatextempskip}{\abovecaptionskip}</xsl:text> + <xsl:text>\setlength{\abovecaptionskip}{\belowcaptionskip}</xsl:text> + <xsl:text>\setlength{\belowcaptionskip}{\docbooktolatextempskip}} </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\newcommand{\captionswapskip}{} </xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:if test='$latex.hyphenation.tttricks=1'> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>% Better linebreaks </xsl:text> + <xsl:text>\newcommand{\docbookhyphenatedot}[1]{{\hyphenchar\font=`\.\relax #1\hyphenchar\font=`\-}} </xsl:text> + <xsl:text>\newcommand{\docbookhyphenatefilename}[1]{{\hyphenchar\font=`\.\relax #1\hyphenchar\font=`\-}} </xsl:text> + <xsl:text>\newcommand{\docbookhyphenateurl}[1]{{\hyphenchar\font=`\/\relax #1\hyphenchar\font=`\-}} </xsl:text> + </xsl:if> + </xsl:template> + + <doc:variable name="generate.latex.essential.preamble" xmlns=""> + <refpurpose> Unavoidable LaTeX preamble shared by articles and books </refpurpose> + <refdescription> + <para>Contains custom commands <emphasis>that you just can't get rid of!</emphasis></para> + </refdescription> + </doc:variable> + <xsl:template name="generate.latex.essential.preamble"> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>\makeatletter </xsl:text> + <xsl:if test="$latex.use.hyperref!='1'"> + <xsl:text>\newcommand{\href}[1]{{}} </xsl:text> + <xsl:text>\newcommand{\hyperlink}[1]{{}} </xsl:text> + <xsl:text>\newcommand{\hypertarget}[2]{#2} </xsl:text> + </xsl:if> + <xsl:if test="$latex.use.ucs='1'"> + <xsl:text>\usepackage[</xsl:text> + <xsl:value-of select="$latex.ucs.options"/> + <xsl:text>]{ucs} </xsl:text> + </xsl:if> + <xsl:if test="$latex.entities='catcode'"> + <xsl:text>\catcode`\&=\active\def&{\@ifnextchar##{\@docbooktolatexunicode\@gobble}{\&}} </xsl:text> + <xsl:if test="$latex.use.ucs!='1'"> + <xsl:text><![CDATA[ +% A few example Unicode characters. +% For full support, use the unicode pacakge from Dominique Unruh/CTAN. +\newcommand{\unichar}[1]{% + \ifnum#1=8212---% + \else\&\##1;\fi% +} +]]></xsl:text> + </xsl:if> + <xsl:text>\def\@docbooktolatexunicode#1;{\edef\@dbtemp{#1}\unichar{\@dbtemp}} </xsl:text> + </xsl:if> + <xsl:if test="$latex.entities='unicode'"> + <xsl:text>\usepackage[utf8]{inputenc} </xsl:text> + </xsl:if> + <xsl:text><![CDATA[ +\def\docbooktolatexgobble{\expandafter\@gobble} +% Facilitate use of \cite with \label +\newcommand{\docbooktolatexbibaux}[2]{% + \protected@write\@auxout{}{\string\global\string\@namedef{docbooktolatexcite@#1}{#2}} +} +\newcommand{\docbooktolatexcite}[2]{% + \@ifundefined{docbooktolatexcite@#1}% + {\cite{#1}}% + {\def\@docbooktolatextemp{#2}\ifx\@docbooktolatextemp\@empty% + \cite{\@nameuse{docbooktolatexcite@#1}}% + \else\cite[#2]{\@nameuse{docbooktolatexcite@#1}}% + \fi% + }% +} +\newcommand{\docbooktolatexbackcite}[1]{% + \ifx\Hy@backout\@undefined\else% + \@ifundefined{docbooktolatexcite@#1}{% + % emit warning? + }{% + \ifBR@verbose% + \PackageInfo{backref}{back cite \string`#1\string' as \string`\@nameuse{docbooktolatexcite@#1}\string'}% + \fi% + \Hy@backout{\@nameuse{docbooktolatexcite@#1}}% + }% + \fi% +} +% -------------------------------------------- +% A way to honour <footnoteref>s +% Blame j-devenish (at) users.sourceforge.net +% In any other LaTeX context, this would probably go into a style file. +\newcommand{\docbooktolatexusefootnoteref}[1]{\@ifundefined{@fn@label@#1}% + {\hbox{\@textsuperscript{\normalfont ?}}% + \@latex@warning{Footnote label `#1' was not defined}}% + {\@nameuse{@fn@label@#1}}} +\newcommand{\docbooktolatexmakefootnoteref}[1]{% + \protected@write\@auxout{}% + {\global\string\@namedef{@fn@label@#1}{\@makefnmark}}% + \@namedef{@fn@label@#1}{\hbox{\@textsuperscript{\normalfont ?}}}% + } +% -------------------------------------------- +% Hacks for honouring row/entry/@align +% (\hspace not effective when in paragraph mode) +% Naming convention for these macros is: +% 'docbooktolatex' 'align' {alignment-type} {position-within-entry} +% where r = right, l = left, c = centre +\newcommand{\docbooktolatexalignrl}{\protect\ifvmode\raggedleft\else\hfill\fi} +\newcommand{\docbooktolatexalignrr}{\protect} +\newcommand{\docbooktolatexalignll}{\protect\ifvmode\raggedright\else\fi} +\newcommand{\docbooktolatexalignlr}{\protect\ifvmode\else\hspace*\fill\fi} +\newcommand{\docbooktolatexaligncl}{\protect\ifvmode\centering\else\hfill\fi} +\newcommand{\docbooktolatexaligncr}{\protect\ifvmode\else\hspace*\fill\fi} +\ifx\captionswapskip\@undefined\newcommand{\captionswapskip}{}\fi +\makeatother +]]></xsl:text> + </xsl:template> + + + + <!--############################################################################# + | Auxiliary templates and variables + |- ############################################################################# + | + + ############################################################################## --> + + <doc:template name="latex.float.preamble" xmlns=""> + <refpurpose> + </refpurpose> + <refdescription> + </refdescription> + </doc:template> + <xsl:template name="latex.float.preamble"> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>% Commands to manage/style/create floats </xsl:text> + <xsl:text>% figures, tables, algorithms, examples, eqn </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text> \floatstyle{ruled} </xsl:text> + <xsl:text> \restylefloat{figure} </xsl:text> + <xsl:text> \floatstyle{ruled} </xsl:text> + <xsl:text> \restylefloat{table} </xsl:text> + <xsl:text> \floatstyle{ruled} </xsl:text> + <xsl:text> \newfloat{program}{ht}{lop}[section] </xsl:text> + <xsl:text> \floatstyle{ruled} </xsl:text> + <xsl:text> \newfloat{example}{ht}{loe}[section] </xsl:text> + <xsl:text> \floatname{example}{</xsl:text> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name">example</xsl:with-param> + </xsl:call-template> + <xsl:text>} </xsl:text> + <xsl:text> \floatstyle{ruled} </xsl:text> + <xsl:text> \newfloat{dbequation}{ht}{loe}[section] </xsl:text> + <xsl:text> \floatname{dbequation}{</xsl:text> + <xsl:call-template name="gentext.element.name"> + <xsl:with-param name="element.name">equation</xsl:with-param> + </xsl:call-template> + <xsl:text>} </xsl:text> + <xsl:text> \floatstyle{boxed} </xsl:text> + <xsl:text> \newfloat{algorithm}{ht}{loa}[section] </xsl:text> + <xsl:text> \floatname{algorithm}{Algorithm} </xsl:text> + </xsl:template> + + + + + <!-- DOCUMENTATION --> + <doc:variable name="latex.pdf.preamble" xmlns=""> + <refpurpose> + </refpurpose> + <refdescription> + <formalpara><title>Default Value:</title> + <screen> + \usepackage{ifthen} + % -------------------------------------------- + % Check for PDFLaTeX/LaTeX + % -------------------------------------------- + \newif\ifpdf + \ifx\pdfoutput\undefined + \pdffalse % we are not running PDFLaTeX + \else + \pdfoutput=1 % we are running PDFLaTeX + \pdftrue + \fi + % -------------------------------------------- + % Load graphicx package with pdf if needed + % -------------------------------------------- + \ifpdf + \usepackage[pdftex]{graphicx} + \pdfcompresslevel=9 + \else + \usepackage{graphicx} + \fi + </screen> + </formalpara> + </refdescription> + <refauthor>Ramon Casellas <email>casellas@aist.enst.fr</email></refauthor> + </doc:variable> + + <!-- VARIABLE --> + <xsl:variable name="latex.pdf.preamble"> + <xsl:text>\usepackage{ifthen} </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>% Check for PDFLaTeX/LaTeX </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>\newif\ifpdf </xsl:text> + <xsl:text>\ifx\pdfoutput\undefined </xsl:text> + <xsl:text>\pdffalse % we are not running PDFLaTeX </xsl:text> + <xsl:text>\else </xsl:text> + <xsl:text>\pdfoutput=1 % we are running PDFLaTeX </xsl:text> + <xsl:text>\pdftrue </xsl:text> + <xsl:text>\fi </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>% Load graphicx package with pdf if needed </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>\ifpdf </xsl:text> + <xsl:text>\usepackage[pdftex]{graphicx} </xsl:text> + <xsl:text>\pdfcompresslevel=9 </xsl:text> + <xsl:text>\else </xsl:text> + <xsl:text>\usepackage{graphicx} </xsl:text> + <xsl:text>\fi </xsl:text> + </xsl:variable> + + + + <!-- DOCUMENTATION --> + <doc:template name="latex.hyperref.preamble" xmlns=""> + <refpurpose> Manage the part of the preamble that handles the hyperref package.</refpurpose> + <refdescription> + <para> This template outputs the LaTeX code <literal>\usepackage[...]{hyperref}</literal> + in order to use hyperlinks, backrefs and other goodies. If PDF support is activated, + outputs laTeX code to detect whether the document is being compiled with + <filename>pdflatex</filename> or <filename>latex</filename> to supply the + right parameters (pdftex, dvips, etc). </para> + <formalpara><title>To Do</title> The package options should be optained + from XSL variables.</formalpara> + <formalpara><title>Default Value with PDF support</title> + <screen> + % -------------------------------------------- + % Load hyperref package with pdf if needed + % -------------------------------------------- + \ifpdf + \usepackage[pdftex,bookmarksnumbered,colorlinks,backref, bookmarks, breaklinks, linktocpage]{hyperref} + \else + \usepackage[dvips,bookmarksnumbered,colorlinks,backref, bookmarks, breaklinks, linktocpage]{hyperref} + \fi + % -------------------------------------------- + </screen> + </formalpara> + <formalpara><title>Default Value without PDF support</title> + <screen> + % -------------------------------------------- + % Load hyperref package + % -------------------------------------------- + \usepackage[dvips,bookmarksnumbered,colorlinks,backref, bookmarks, breaklinks, linktocpage]{hyperref} + </screen> + </formalpara> + </refdescription> + </doc:template> + <!-- TEMPLATE --> + <xsl:template name="latex.hyperref.preamble"> + <xsl:choose> + <xsl:when test="$latex.pdf.support=1"> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>% Load hyperref package with pdf if needed </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>\ifpdf </xsl:text> + <xsl:text>\usepackage[pdftex,</xsl:text> + <xsl:value-of select="$latex.hyperref.param.common" /> + <xsl:text>,</xsl:text> + <xsl:value-of select="$latex.hyperref.param.pdftex" /> + <xsl:text>]{hyperref} </xsl:text> + <xsl:text>\else </xsl:text> + <xsl:text>\usepackage[dvips,</xsl:text> + <xsl:value-of select="$latex.hyperref.param.common" /> + <xsl:text>,</xsl:text> + <xsl:value-of select="$latex.hyperref.param.dvips" /> + <xsl:text>]{hyperref} </xsl:text> + <xsl:text>\fi </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>% Load hyperref package </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>\usepackage[dvips,</xsl:text> + <xsl:value-of select="$latex.hyperref.param.common" /> + <xsl:text>,</xsl:text> + <xsl:value-of select="$latex.hyperref.param.dvips" /> + <xsl:text>]{hyperref} </xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + + + + + + + + + + + <!--############################################################################# + | latex.math.preamble + |- ############################################################################# + | This "preamble chunk" declares usage of most common AMS packages. + | Defines new useful commands. + + ############################################################################## --> + + <!-- DOCUMENTATION --> + <doc:variable name="latex.math.preamble" xmlns=""> + <refpurpose> Manage the math related preamble</refpurpose> + <refdescription> + </refdescription> + </doc:variable> + + <!-- VARIABLE --> + <xsl:variable name="latex.math.preamble"> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>% Math support </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>\usepackage{amsmath,amsthm, amsfonts, amssymb, amsxtra,amsopn} </xsl:text> + <xsl:text>%\newtheorem{thm}{Theorem}[section] </xsl:text> + <xsl:text>%\newtheorem{cor}[section]{Corollary} </xsl:text> + <xsl:text>%\newtheorem{lem}[section]{Lemma} </xsl:text> + <xsl:text>%\newtheorem{defn}[section]{Definition} </xsl:text> + <xsl:text>%\newtheorem{prop}[section]{Proposition} </xsl:text> + <xsl:text>%\newtheorem{ax}{Axiom} </xsl:text> + <xsl:text>%\newtheorem{theorem}[section]{Theorem} </xsl:text> + <xsl:text>%\newtheorem{corollary}{Corollary} </xsl:text> + <xsl:text>%\newtheorem{lemma}{Lemma} </xsl:text> + <xsl:text>%\newtheorem{proposition}{Proposition} </xsl:text> + <xsl:text>%\theoremstyle{definition} </xsl:text> + <xsl:text>%\newtheorem{definition}{Definition} </xsl:text> + <xsl:text>%\theoremstyle{remark} </xsl:text> + <xsl:text>%\newtheorem{rem}{Remark} </xsl:text> + <xsl:text>%\newtheorem*{notation}{Notation} </xsl:text> + <xsl:text>%\newcommand{\ntt}{\normalfont\ttfamily} </xsl:text> + <xsl:text>%\newcommand{\thmref}[1]{Theorem~\ref{#1}} </xsl:text> + <xsl:text>%\newcommand{\secref}[1]{\S\ref{#1}} </xsl:text> + <xsl:text>%\newcommand{\lemref}[1]{Lemma~\ref{#1}} </xsl:text> + <xsl:text> \newcommand{\bysame}{\mbox{\rule{3em}{.4pt}}\,} </xsl:text> + <xsl:text> \newcommand{\A}{\mathcal{A}} </xsl:text> + <xsl:text> \newcommand{\B}{\mathcal{B}} </xsl:text> + <xsl:text> \newcommand{\XcY}{{(X,Y)}} </xsl:text> + <xsl:text> \newcommand{\SX}{{S_X}} </xsl:text> + <xsl:text> \newcommand{\SY}{{S_Y}} </xsl:text> + <xsl:text> \newcommand{\SXY}{{S_{X,Y}}} </xsl:text> + <xsl:text> \newcommand{\SXgYy}{{S_{X|Y}(y)}} </xsl:text> + <xsl:text> \newcommand{\Cw}[1]{{\hat C_#1(X|Y)}} </xsl:text> + <xsl:text> \newcommand{\G}{{G(X|Y)}} </xsl:text> + <xsl:text> \newcommand{\PY}{{P_{\mathcal{Y}}}} </xsl:text> + <xsl:text> \newcommand{\X}{\mathcal{X}} </xsl:text> + <xsl:text> \newcommand{\wt}{\widetilde} </xsl:text> + <xsl:text> \newcommand{\wh}{\widehat} </xsl:text> + <xsl:text> % -------------------------------------------- </xsl:text> + <xsl:text> %\DeclareMathOperator{\per}{per} </xsl:text> + <xsl:text> \DeclareMathOperator{\cov}{cov} </xsl:text> + <xsl:text> \DeclareMathOperator{\non}{non} </xsl:text> + <xsl:text> \DeclareMathOperator{\cf}{cf} </xsl:text> + <xsl:text> \DeclareMathOperator{\add}{add} </xsl:text> + <xsl:text> \DeclareMathOperator{\Cham}{Cham} </xsl:text> + <xsl:text> \DeclareMathOperator{\IM}{Im} </xsl:text> + <xsl:text> \DeclareMathOperator{\esssup}{ess\,sup} </xsl:text> + <xsl:text> \DeclareMathOperator{\meas}{meas} </xsl:text> + <xsl:text> \DeclareMathOperator{\seg}{seg} </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + </xsl:variable> + + + + +<!--############################################################################# +| latex.graphicext +|- ############################################################################# +| ++ ############################################################################## --> + +<doc:template name="latex.graphicext" xmlns=""> +<refpurpose> Declared graphic extensions </refpurpose> +<refdescription> +This template checks whether the user has overriden <command>grafic.default.extension</command> +Otherwise, declares .pdf, .png, .jpg if using pdflatex and .eps if using latex. +<programlisting><![CDATA[ +<xsl:template name="latex.graphicext"> +<xsl:choose> +<xsl:when test="$graphic.default.extension !=''"> + <xsl:text>\DeclareGraphicsExtensions{</xsl:text> + <xsl:if test="not(contains($graphic.default.extension,'.'))"> + <xsl:text>.</xsl:text> + </xsl:if> + <xsl:value-of select="$graphic.default.extension"/> + <xsl:text>} </xsl:text> +</xsl:when> +<xsl:otherwise> + <xsl:choose> + <xsl:when test="$latex.pdf.support=1"> + <xsl:text>\ifpdf </xsl:text> + <xsl:text>\DeclareGraphicsExtensions{.pdf,.png,.jpg} </xsl:text> + <xsl:text>\else </xsl:text> + <xsl:text>\DeclareGraphicsExtensions{.eps} </xsl:text> + <xsl:text>\fi </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\DeclareGraphicsExtensions{.eps} </xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:otherwise> +</xsl:choose> +</xsl:template> + + +]]></programlisting> +</refdescription> +<refreturn> +</refreturn> +</doc:template> + +<xsl:template name="latex.graphicext"> +<xsl:choose> +<xsl:when test="$graphic.default.extension !=''"> + <xsl:text>\DeclareGraphicsExtensions{</xsl:text> + <xsl:if test="not(contains($graphic.default.extension,'.'))"> + <xsl:text>.</xsl:text> + </xsl:if> + <xsl:value-of select="$graphic.default.extension"/> + <xsl:text>} </xsl:text> +</xsl:when> +<xsl:otherwise> + <xsl:choose> + <xsl:when test="$latex.pdf.support=1"> + <xsl:text>\ifpdf </xsl:text> + <xsl:text>\DeclareGraphicsExtensions{.pdf,.png,.jpg} </xsl:text> + <xsl:text>\else </xsl:text> + <xsl:text>\DeclareGraphicsExtensions{.eps} </xsl:text> + <xsl:text>\fi </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\DeclareGraphicsExtensions{.eps} </xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:otherwise> +</xsl:choose> +</xsl:template> + + <xsl:template name="generate.latex.cell.separator"> + <xsl:choose> + <xsl:when test="$latex.entities='catcode'"> + <xsl:text> \catcode`\&=4 &\catcode`\&=\active </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text> & </xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/preface.mod.xsl b/docs/docbook/xslt/db2latex/preface.mod.xsl new file mode 100644 index 0000000000..90d30f09cf --- /dev/null +++ b/docs/docbook/xslt/db2latex/preface.mod.xsl @@ -0,0 +1,112 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: preface.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="preface" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: preface.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Preface <filename>preface.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + +<!--############################################################################# + | Preface + +- ############################################################################# --> +<xsl:template match="preface"> +<xsl:text>\newpage </xsl:text> +<xsl:text>% ------------------------------------------------------------- </xsl:text> +<xsl:text>% Preface </xsl:text> +<xsl:text>% ------------------------------------------------------------- </xsl:text> +<xsl:text>\chapter*{</xsl:text> +<!-- Output preface title or generic text --> +<xsl:choose> + <xsl:when test="title"> + <xsl:apply-templates select="title"/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="gentext"> + <xsl:with-param name="key">preface</xsl:with-param> + </xsl:call-template> + </xsl:otherwise> +</xsl:choose> +<xsl:text>} </xsl:text> +<!-- done with title. Tag it. --> +<xsl:call-template name="label.id"/> +<!-- except title, titleabbrev and subtitle --> +<xsl:apply-templates select="*[name(.) != 'title' and name(.) != 'subtitle' and name(.) != 'titleabbrev']"/> +</xsl:template> + + +<!--############################################################################# + | Preface Title + +- ############################################################################# --> +<xsl:template match="preface/title"> +<xsl:apply-templates/> +</xsl:template> + + +<!--############################################################################# + | Other Preface Elements + +- ############################################################################# --> +<xsl:template match="preface/titleabbrev"/> +<xsl:template match="preface/subtitle"/> +<xsl:template match="preface/docinfo|prefaceinfo"/> + + +<xsl:template match="preface/sect1|preface/simplesect"> +<xsl:text> \section*{</xsl:text> +<xsl:apply-templates select="title"/> +<xsl:text>} </xsl:text> +<xsl:apply-templates select="*[name(.) != 'title']"/> +</xsl:template> + + +<xsl:template match="preface/sect1/sect2"> +<xsl:text> \subsection*{</xsl:text> +<xsl:apply-templates select="title"/> +<xsl:text>} </xsl:text> +<xsl:apply-templates select="*[name(.) != 'title']"/> +</xsl:template> + + +<xsl:template match="preface/sect1/sect2/sect3"> +<xsl:text> \subsubsection*{</xsl:text> +<xsl:apply-templates select="title"/> +<xsl:text>} </xsl:text> +<xsl:apply-templates select="*[name(.) != 'title']"/> +</xsl:template> + + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/procedure.mod.xsl b/docs/docbook/xslt/db2latex/procedure.mod.xsl new file mode 100644 index 0000000000..3fca796151 --- /dev/null +++ b/docs/docbook/xslt/db2latex/procedure.mod.xsl @@ -0,0 +1,165 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: procedure.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="procedure" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: procedure.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Procedures <filename>procedure.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + +<!--############################################################################# --> +<doc:template match="procedure" xmlns=""> +<refpurpose>Procedure XSL Template.</refpurpose> +<refdescription> +<para></para> +<programlisting><![CDATA[ +]]></programlisting> +</refdescription> +</doc:template> +<!--############################################################################# --> + +<xsl:template match="procedure"> + <xsl:variable name="placement"> + <xsl:call-template name="generate.formal.title.placement"> + <xsl:with-param name="object" select="local-name(.)" /> + </xsl:call-template> + </xsl:variable> + <xsl:choose> + <xsl:when test="$placement='before' or $placement=''"> + <xsl:apply-templates select="title" mode="procedure.title"/> + <xsl:text>\begin{enumerate} </xsl:text> + <xsl:apply-templates/> + <xsl:text>\end{enumerate} </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\begin{enumerate} </xsl:text> + <xsl:apply-templates/> + <xsl:text>\end{enumerate} </xsl:text> + <xsl:apply-templates select="title" mode="procedure.title"/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + +<xsl:template match="procedure/title"> +</xsl:template> + +<xsl:template match="procedure/title" mode="procedure.title"> + <xsl:text> {</xsl:text> + <xsl:value-of select="$latex.procedure.title.style"/> + <xsl:text>{</xsl:text> + <xsl:choose> + <xsl:when test="$latex.apply.title.templates=1"> + <xsl:apply-templates/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="."/> + </xsl:otherwise> + </xsl:choose> + <xsl:text>}} </xsl:text> +</xsl:template> + + + + +<!--############################################################################# --> +<doc:template match="step" xmlns=""> +<refpurpose>Step XSL Template.</refpurpose> +<refdescription> +<para></para> +<programlisting><![CDATA[ +]]></programlisting> +</refdescription> +</doc:template> +<!--############################################################################# --> + + <xsl:template match="step"> + <xsl:choose> + <xsl:when test="title"> + <xsl:text> \item{{</xsl:text> + <xsl:value-of select="$latex.step.title.style"/> <!-- by default \sc --> + <xsl:text>{</xsl:text> + <xsl:apply-templates select="title"/> + <xsl:text>}} </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text> \item{</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:apply-templates select="*[not(self::title)]"/> + <xsl:text>} </xsl:text> + </xsl:template> + +<!-- step/title, just apply templates ########################################### --> + <xsl:template match="step/title"> + <xsl:apply-templates/> + </xsl:template> + + + + + + + + + +<!--############################################################################# --> +<doc:template match="substeps" xmlns=""> +<refpurpose>SubSteps XSL Template.</refpurpose> +<refdescription> +<para></para> +<programlisting><![CDATA[ +<xsl:template match="substeps"> + <xsl:text>\begin{enumerate} </xsl:text> + <xsl:apply-templates/> + <xsl:text>\end{enumerate} </xsl:text> +</xsl:template> +]]></programlisting> +</refdescription> +</doc:template> +<!--############################################################################# --> + +<xsl:template match="substeps"> + <xsl:text>\begin{enumerate} </xsl:text> + <xsl:apply-templates/> + <xsl:text>\end{enumerate} </xsl:text> +</xsl:template> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/qandaset.mod.xsl b/docs/docbook/xslt/db2latex/qandaset.mod.xsl new file mode 100644 index 0000000000..c6363e4782 --- /dev/null +++ b/docs/docbook/xslt/db2latex/qandaset.mod.xsl @@ -0,0 +1,409 @@ +<?xml version="1.0"?> +<!--############################################################################# +| $Id: qandaset.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: +| Portions (c) Norman Walsh, official DocBook XSL stylesheets. +| See docbook.sf.net ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version="1.0"> + + +<!--############################################################################# --> +<!-- DOCUMENTATION --> + <doc:reference xmlns="" id="qandaset"> + <referenceinfo> + <releaseinfo role="meta"> $Id: qandaset.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>QandaSet <filename>qandaset.mod.xsl</filename></title> + <partintro> + <section> + <title>Introduction</title> + </section> + </partintro> + </doc:reference> + + + + +<!--############################################################################# +| qandaset +|- ############################################################################# +| ++ ############################################################################# --> + +<xsl:template match="qandaset"> + <!-- get all children that are not the following --> + <xsl:variable name="preamble" select="*[name(.) != 'title' + and name(.) != 'titleabbrev' + and name(.) != 'qandadiv' + and name(.) != 'qandaentry']"/> + <xsl:variable name="label-width"/> + <xsl:variable name="table-summary"/> + <xsl:variable name="cellpadding"/> + <xsl:variable name="cellspacing"/> + <xsl:variable name="toc"/> + <xsl:variable name="toc.params"/> + <xsl:variable name="qalevel"> + <xsl:call-template name="qanda.section.level"/> + </xsl:variable> + <xsl:text>% ------------------------------------------------------------- </xsl:text> + <xsl:text>% QandASet </xsl:text> + <xsl:text>% ------------------------------------------------------------- </xsl:text> + <xsl:choose> + <xsl:when test="ancestor::sect2"> + <xsl:text>\subsubsection*{</xsl:text> + </xsl:when> + <xsl:when test="ancestor::sect1"> + <xsl:text>\subsection*{</xsl:text> + </xsl:when> + <xsl:when test="ancestor::article | ancestor::appendix"> + <xsl:text>\section*{</xsl:text> + </xsl:when> + <xsl:when test="ancestor::book"> + <xsl:text>\chapter*{</xsl:text> + </xsl:when> + </xsl:choose> + <xsl:choose> + <xsl:when test="title"> + <xsl:apply-templates select="title"/> + </xsl:when> + <xsl:otherwise> + <xsl:text>F.A.Q.</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:text>} </xsl:text> + <xsl:call-template name="label.id"/> + <xsl:text> </xsl:text> + + <!-- process toc --> + <xsl:if test="contains($toc.params, 'toc') and $toc != '0'"> + <xsl:call-template name="process.qanda.toc"/> + </xsl:if> + <!-- process preamble --> + <xsl:apply-templates select="$preamble"/> + <!-- process divs and entries --> + <xsl:apply-templates select="qandaentry|qandadiv"/> +</xsl:template> + + +<xsl:template match="qandaset/title"> +<xsl:apply-templates/> +</xsl:template> + + + + +<!--############################################################################# +| qandadiv +|- ############################################################################# +| ++ ############################################################################# --> + + +<xsl:template match="qandadiv"> + <!-- get the preamble --> + <xsl:variable name="preamble" select="*[name(.) != 'title' + and name(.) != 'titleabbrev' + and name(.) != 'qandadiv' + and name(.) != 'qandaentry']"/> + <xsl:variable name="qalevel"> + <xsl:call-template name="qandadiv.section.level"/> + </xsl:variable> + <!-- process the title if it exists --> + <xsl:text>% ----------- </xsl:text> + <xsl:text>% QandADiv </xsl:text> + <xsl:text>% ----------- </xsl:text> + <xsl:text>\noindent\begin{minipage}{\linewidth} </xsl:text> + <xsl:text>\vspace{0.25em}\hrule\vspace{0.25em} </xsl:text> + <xsl:choose> + <xsl:when test="ancestor::sect2"> + <xsl:text>\paragraph*{</xsl:text> + </xsl:when> + <xsl:when test="ancestor::sect1"> + <xsl:text>\subsubsection*{</xsl:text> + </xsl:when> + <xsl:when test="ancestor::article | ancestor::appendix"> + <xsl:text>\subsection*{</xsl:text> + </xsl:when> + <xsl:when test="ancestor::book"> + <xsl:text>\section*{</xsl:text> + </xsl:when> + </xsl:choose> + <xsl:choose> + <xsl:when test="title"> + <xsl:apply-templates select="title"/> + </xsl:when> + <xsl:otherwise> + <xsl:text>F.A.Q. Part</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:text>}</xsl:text> + <xsl:call-template name="label.id"/> + <xsl:text> </xsl:text> + <xsl:text>\hrule\vspace{0.25em} </xsl:text> + <xsl:text>\end{minipage} </xsl:text> + +<!-- + <xsl:variable name="toc.params"> + </xsl:variable> + <xsl:if test="contains($toc.params, 'toc')"> + <xsl:call-template name="process.qanda.toc"/> + </xsl:if> + <xsl:if test="$preamble"> + <xsl:apply-templates select="$preamble"/> + </xsl:if> +--> +<!-- + <xsl:text>\begin{toc} </xsl:text> + <xsl:for-each select="qandaentry"> + <xsl:text>\tocref{</xsl:text> + <xsl:value-of select="@id"/> + <xsl:text>} </xsl:text> + </xsl:for-each> + <xsl:text>\end{toc} </xsl:text> +--> + +<!-- pseudo table of contents --> + <!-- + <xsl:choose> + <xsl:when test="title"> + <xsl:text>\caption{</xsl:text> + <xsl:apply-templates select="title"/> + <xsl:text>} </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\caption{</xsl:text> + <xsl:text>F.A.Q. Part</xsl:text> + <xsl:text>} </xsl:text> + </xsl:otherwise> + </xsl:choose> + --> + <xsl:for-each select="qandaentry"> + <xsl:text>\noindent{}</xsl:text> + <xsl:value-of select="position()"/> + <xsl:text>.~</xsl:text> + <xsl:apply-templates select="question"/> + <xsl:if test="position()!=last()"><xsl:text>\newline </xsl:text></xsl:if> + </xsl:for-each> + <xsl:text>\vspace{0.25em}\hrule </xsl:text> + + <xsl:for-each select="qandaentry"> + <xsl:text>\vspace{1em} </xsl:text> + <xsl:text>\noindent{}</xsl:text> + <xsl:value-of select="position()"/> + <xsl:text>.~</xsl:text> + <xsl:apply-templates select="question"/> + <xsl:text>\newline </xsl:text> + <xsl:apply-templates select="answer"/> + </xsl:for-each> +<!-- <xsl:apply-templates select="qandadiv|qandaentry"/> --> +<!-- <xsl:apply-templates/> --> + <xsl:text>\vspace{1em} </xsl:text> +</xsl:template> + + + + + + + + +<!--############################################################################# +| qandadiv/title +|- ############################################################################# +| ++ ############################################################################# --> + +<xsl:template match="qandadiv/title"> + <!-- <xsl:apply-templates select="parent::qandadiv" mode="label.markup"/> --> + <xsl:apply-templates/> +</xsl:template> + + + + +<!--############################################################################# +| question +|- ############################################################################# +| ++ ############################################################################# --> + +<xsl:template match="question"> +<!-- get the default label --> +<xsl:variable name="deflabel"> + <xsl:choose> + <xsl:when test="ancestor-or-self::*[@defaultlabel]"> + <xsl:value-of select="(ancestor-or-self::*[@defaultlabel])[last()]/@defaultlabel"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="latex.qanda.defaultlabel"/> + </xsl:otherwise> + </xsl:choose> +</xsl:variable> +<!-- process the question itself +<xsl:apply-templates select="." mode="label.markup"/> +<xsl:choose> + <xsl:when test="$deflabel = 'none' and not(label)"> + <xsl:apply-templates select="*[name(.) != 'label']"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="*[name(.) != 'label']"/> + </xsl:otherwise> +</xsl:choose> +--> +<xsl:text>\textbf{Q:}~\textit{</xsl:text> +<xsl:apply-templates/> +<xsl:text>} </xsl:text> +</xsl:template> + + + + + + + + +<!--############################################################################# +| answer +|- ############################################################################# +| ++ ############################################################################# --> + +<xsl:template match="answer"> +<xsl:text>\noindent\textbf{A:}~</xsl:text> +<xsl:apply-templates/> +<xsl:text> </xsl:text> +</xsl:template> + + + + + + + +<!--############################################################################# +| label +|- ############################################################################# +| ++ ############################################################################# --> + +<xsl:template match="label"> + <xsl:apply-templates/> +</xsl:template> + + +<xsl:template name="process.qanda.toc"> + <xsl:apply-templates select="qandadiv" mode="qandatoc.mode"/> + <xsl:apply-templates select="qandaentry" mode="qandatoc.mode"/> +</xsl:template> + +<xsl:template match="qandadiv" mode="qandatoc.mode"> + <xsl:apply-templates select="title" mode="qandatoc.mode"/> + <xsl:call-template name="process.qanda.toc"/> +</xsl:template> + + + + + + +<xsl:template match="qandadiv/title" mode="qandatoc.mode"> +<xsl:variable name="qalevel"> + <xsl:call-template name="qandadiv.section.level"/> +</xsl:variable> +<xsl:call-template name="label.id"> + <xsl:with-param name="object" select="parent::*"/> +</xsl:call-template> +<xsl:apply-templates select="parent::qandadiv" mode="label.markup"/> +<xsl:value-of select="$autotoc.label.separator"/> +<xsl:apply-templates/> +</xsl:template> + + + +<xsl:template match="qandaentry" mode="qandatoc.mode"> + <xsl:apply-templates mode="qandatoc.mode"/> +</xsl:template> + + + +<xsl:template match="question" mode="qandatoc.mode"> + <xsl:variable name="firstch" select="(*[name(.)!='label'])[1]"/> + <xsl:apply-templates select="." mode="label.markup"/> + <xsl:text> </xsl:text> +</xsl:template> + + +<xsl:template match="answer|revhistory" mode="qandatoc.mode"> + <!-- nop --> +</xsl:template> + + + + +<xsl:template name="question.answer.label"> + <!-- variable: deflabel --> + <xsl:variable name="deflabel"> + <!-- chck whether someone has a defaultlabel attribute --> + <xsl:choose> + <xsl:when test="ancestor-or-self::*[@defaultlabel]"> + <xsl:value-of select="(ancestor-or-self::*[@defaultlabel])[last()]/@defaultlabel"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="latex.qanda.defaultlabel"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + + <xsl:variable name="label" select="@label"/> + <xsl:choose> + <xsl:when test="$deflabel = 'qanda'"> + <xsl:call-template name="gentext"> + <xsl:with-param name="key"> + <xsl:choose> + <xsl:when test="local-name(.) = 'question'">question</xsl:when> + <xsl:when test="local-name(.) = 'answer'">answer</xsl:when> + <xsl:when test="local-name(.) = 'qandadiv'">qandadiv</xsl:when> + <xsl:otherwise>qandaset</xsl:otherwise> + </xsl:choose> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="$deflabel = 'label'"> + <xsl:value-of select="$label"/> + </xsl:when> + <xsl:when test="$deflabel = 'number' and local-name(.) = 'question'"> + <xsl:apply-templates select="ancestor::qandaset[1]" mode="number"/> + <xsl:choose> + <xsl:when test="ancestor::qandadiv"> + <xsl:apply-templates select="ancestor::qandadiv[1]" mode="number"/> + <xsl:apply-templates select="ancestor::qandaentry" mode="number"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="ancestor::qandaentry" mode="number"/> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <!-- nothing --> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/refentry.mod.xsl b/docs/docbook/xslt/db2latex/refentry.mod.xsl new file mode 100644 index 0000000000..dc1a7c440c --- /dev/null +++ b/docs/docbook/xslt/db2latex/refentry.mod.xsl @@ -0,0 +1,187 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: refentry.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="refentry" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: refentry.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authogroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authogroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>References and Entries <filename>refentry.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + <!--############################################################################# + | REFERENCE + |- ############################################################################# + | + + ############################################################################## --> + <xsl:template match="reference"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates select="partintro"/> + <xsl:apply-templates select="*[local-name(.) != 'partintro']"/> + </xsl:template> + + <xsl:template match="reference" mode="division.number"> + <xsl:number from="book" count="reference" format="I."/> + </xsl:template> + + <xsl:template match="reference/docinfo"/> + <xsl:template match="reference/title"/> + <xsl:template match="reference/subtitle"/> + + + + <!--############################################################################# + | REFENTRY + |- ############################################################################# + | + + ############################################################################## --> + <xsl:template match="refentry"> + <xsl:variable name="refmeta" select=".//refmeta"/> + <xsl:variable name="refentrytitle" select="$refmeta//refentrytitle"/> + <xsl:variable name="refnamediv" select=".//refnamediv"/> + <xsl:variable name="refname" select="$refnamediv//refname"/> + <xsl:variable name="title"> + <xsl:choose> + <xsl:when test="$refentrytitle"> + <xsl:apply-templates select="$refentrytitle[1]" mode="title"/> + </xsl:when> + <xsl:when test="$refname"> + <xsl:apply-templates select="$refname[1]" mode="title"/> + </xsl:when> + <xsl:otherwise></xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:call-template name="map.begin"> + <xsl:with-param name="string" select="$title"/> + </xsl:call-template> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="refentrytitle|refname" mode="title"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="refentry/docinfo|refentry/refentryinfo"/> + <xsl:template match="refmeta"/> + + <xsl:template match="manvolnum"> + <xsl:if test="$refentry.xref.manvolnum != 0"> + <xsl:text>(</xsl:text> + <xsl:apply-templates/> + <xsl:text>)</xsl:text> + </xsl:if> + </xsl:template> + + <xsl:template match="refmiscinfo"/> + + <xsl:template match="refentrytitle"> + <xsl:call-template name="inline.charseq"/> + </xsl:template> + + <xsl:template match="refnamediv"> + <xsl:call-template name="block.object"/> + </xsl:template> + + <xsl:template match="refname"> + <xsl:apply-templates/> + <xsl:if test="not (preceding-sibling::refname)"> + <xsl:text> \subsection*{</xsl:text> + <xsl:if test="$refentry.generate.name != 0"> + <xsl:call-template name="gentext.element.name"/> + </xsl:if> + <xsl:text>} </xsl:text> + </xsl:if> + <xsl:apply-templates/> + <xsl:if test="following-sibling::refname"> + <xsl:text>, </xsl:text> + </xsl:if> + </xsl:template> + + + <xsl:template match="refpurpose"> + <xsl:text> $-$ </xsl:text> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="refdescriptor"> + <!-- todo: finish this --> + </xsl:template> + + <xsl:template match="refclass"> + <xsl:if test="@role"> + <xsl:value-of select="@role"/> + <xsl:text>: </xsl:text> + </xsl:if> + <xsl:apply-templates/> + </xsl:template> + + + + <!--############################################################################# + | REFSYNOPSIS + |- ############################################################################# + | + + ############################################################################## --> + + <xsl:template match="refsynopsisdiv"> + <xsl:call-template name="label.id"/> + <xsl:text> \subsection*{Synopsis} </xsl:text> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="refsynopsisdivinfo"></xsl:template> + <xsl:template match="refsynopsisdiv/title"></xsl:template> + + + <!--############################################################################# + | REFSECTS + |- ############################################################################# + | + + ############################################################################## --> + + <xsl:template match="refsect1|refsect2|refsect3"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="refsect1/title"/> + <xsl:template match="refsect2/title"/> + <xsl:template match="refsect3/title"/> + <xsl:template match="refsect1info"/> + <xsl:template match="refsect2info"/> + <xsl:template match="refsect3info"/> + + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/revision.mod.xsl b/docs/docbook/xslt/db2latex/revision.mod.xsl new file mode 100644 index 0000000000..c1b39cee48 --- /dev/null +++ b/docs/docbook/xslt/db2latex/revision.mod.xsl @@ -0,0 +1,218 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: revision.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="revision" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: revision.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>Revision Management <filename>revision.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para> + This file defines the DB2LaTeX XSL templates for <sgmltag>revision</sgmltag> + and its children. The basic mapping is to output a LaTeX table and a table + row for each revision. + </para> + </section> + </partintro> + </doc:reference> + <!--############################################################################# --> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="revhistory" xmlns=""> + <refpurpose> revhistory XSL template </refpurpose> + <refdescription> + <formalpara><title>User variables</title> + <itemizedlist> + <listitem><para><literal>latex.output.revhistory</literal></para></listitem> + </itemizedlist> + </formalpara> + <para>This XSL template depends on the value of <literal>latex.output.revhistory</literal>. + If this variable is "1", the XSL template calls <command>map.begin</command>, then + applies templates and finally calls <command>map.end</command></para> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="revhistory"> + <xsl:message>RCAS: Processing Revision History </xsl:message> + <xsl:if test="$latex.output.revhistory=1"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + <xsl:call-template name="map.end"/> + </xsl:if> + </xsl:template> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="revhistory/revision" xmlns=""> + <refpurpose> revhistory/revision XSL template </refpurpose> + <refdescription> + <para>Each revhistory/revision corresponds to a LaTeX table row (see revhistory) + containing the revision number, the date, author initials and the description/ + remarks of the revision.</para> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="revhistory/revision"> + <xsl:variable name="revnumber" select=".//revnumber"/> + <xsl:variable name="revdate" select=".//date"/> + <xsl:variable name="revauthor" select=".//authorinitials"/> + <xsl:variable name="revremark" select=".//revremark|.//revdescription"/> + <!-- Row starts here --> + <xsl:if test="$revnumber"> + <xsl:call-template name="gentext.element.name"/> + <xsl:text> </xsl:text> + <xsl:apply-templates select="$revnumber"/> + </xsl:if> + <xsl:text> & </xsl:text> + <xsl:apply-templates select="$revdate"/> + <xsl:text> & </xsl:text> + <xsl:choose> + <xsl:when test="count($revauthor)=0"> + <xsl:call-template name="dingbat"> + <xsl:with-param name="dingbat">nbsp</xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="$revauthor"/> + </xsl:otherwise> + </xsl:choose> + <!-- End Row here --> + <xsl:text> \\ \hline </xsl:text> + <!-- Add Remark Row if exists--> + <xsl:if test="$revremark"> + <xsl:text>\multicolumn{3}{|l|}{</xsl:text> + <xsl:apply-templates select="$revremark"/> + <!-- End Row here --> + <xsl:text>} \\ \hline </xsl:text> + </xsl:if> + </xsl:template> + + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="revision/authorinitials" xmlns=""> + <refpurpose> revision/authorinitials XSL template </refpurpose> + <refdescription> + <para>Applies templates and outputs a "comma" if the node position is not + last()</para> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="revision/authorinitials"> + <xsl:apply-templates/> + <xsl:if test="position()!=last()"> + <xsl:text>, </xsl:text> + </xsl:if> + </xsl:template> + + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="revision/revnumber" xmlns=""> + <refpurpose> revision/revnumber XSL template </refpurpose> + <refdescription> + <para>Applies templates.</para> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="revision/revnumber"> + <xsl:apply-templates/> + </xsl:template> + + + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="revision/date" xmlns=""> + <refpurpose> revision/date XSL template </refpurpose> + <refdescription> + <para>Applies templates.</para> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="revision/date"> + <xsl:apply-templates/> + </xsl:template> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="revision/revremark" xmlns=""> + <refpurpose> revision/revremark XSL template </refpurpose> + <refdescription> + <para>Applies templates.</para> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="revision/revremark"> + <xsl:apply-templates/> + </xsl:template> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="revision/revdescription" xmlns=""> + <refpurpose> revision/revdescription XSL template </refpurpose> + <refdescription> + <para>Applies templates.</para> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="revision/revdescription"> + <xsl:apply-templates/> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/sections.mod.xsl b/docs/docbook/xslt/db2latex/sections.mod.xsl new file mode 100644 index 0000000000..f81524d51d --- /dev/null +++ b/docs/docbook/xslt/db2latex/sections.mod.xsl @@ -0,0 +1,150 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: sections.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: sections. +| PENDING: +| - Nested section|simplesect > 3 mapped to subsubsection* +| - No sectinfo (!) ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="sections" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: sections.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authogroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authogroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Sections <filename>sections.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + + <xsl:template match="sect1|sect2|sect3|sect4|sect5"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="sect1/title"/> + <xsl:template match="sect2/title"/> + <xsl:template match="sect3/title"/> + <xsl:template match="sect4/title"/> + <xsl:template match="sect5/title"/> + + + <xsl:template match="section"> + <xsl:text> </xsl:text> + <xsl:variable name="level" select="count(ancestor::section)+1"/> + <xsl:choose> + <xsl:when test='$level=1'> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect1'"/> + </xsl:call-template> + </xsl:when> + <xsl:when test='$level=2'> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect2'"/> + </xsl:call-template> + </xsl:when> + <xsl:when test='$level=3'> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect3'"/> + </xsl:call-template> + </xsl:when> + <xsl:when test='$level=4'> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect4'"/> + </xsl:call-template> + </xsl:when> + <xsl:when test='$level=5'> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect5'"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:message>DB2LaTeX: recursive section|simplesect > 5 Not well Supported</xsl:message> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect6'"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + <xsl:apply-templates/> + </xsl:template> + + + <xsl:template match="simplesect"> + <xsl:text> </xsl:text> + <xsl:variable name="level" select="count(ancestor::section) + 1"/> + <xsl:choose> + <xsl:when test='$level=1'> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect1'"/> + </xsl:call-template> + </xsl:when> + <xsl:when test='$level=2'> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect2'"/> + </xsl:call-template> + </xsl:when> + <xsl:when test='$level=3'> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect3'"/> + </xsl:call-template> + </xsl:when> + <xsl:when test='$level=4'> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect4'"/> + </xsl:call-template> + </xsl:when> + <xsl:when test='$level=5'> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect5'"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:message>DB2LaTeX: recursive section|simplesect > 5 Not well Supported</xsl:message> + <xsl:call-template name="map.begin"> + <xsl:with-param name="keyword" select="'sect6'"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="section/title"/> + <xsl:template match="simplesect/title"/> + + <xsl:template match="sectioninfo"/> + <xsl:template match="sect1info"/> + <xsl:template match="sect2info"/> + <xsl:template match="sect3info"/> + <xsl:template match="sect4info"/> + <xsl:template match="sect5info"/> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/set.mod.xsl b/docs/docbook/xslt/db2latex/set.mod.xsl new file mode 100644 index 0000000000..9c45efec52 --- /dev/null +++ b/docs/docbook/xslt/db2latex/set.mod.xsl @@ -0,0 +1,53 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: set.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="set" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: set.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Sets <filename>set.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + <xsl:template match="set"> + <xsl:call-template name="label.id"/> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="set/setinfo"></xsl:template> + <xsl:template match="set/title"></xsl:template> + <xsl:template match="set/subtitle"></xsl:template> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/sgmltag.mod.xsl b/docs/docbook/xslt/db2latex/sgmltag.mod.xsl new file mode 100644 index 0000000000..8c0c57d83f --- /dev/null +++ b/docs/docbook/xslt/db2latex/sgmltag.mod.xsl @@ -0,0 +1,157 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: sgmltag.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="sgmltag" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: sgmltag.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authogroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authogroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>SGML Tags <filename>sgmltag.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <xsl:template match="sgmltag"> + <xsl:call-template name="format.sgmltag"/> + </xsl:template> + + <xsl:template name="format.sgmltag"> + <xsl:param name="class"> + <xsl:choose> + <xsl:when test="@class"> + <xsl:value-of select="normalize-space(@class)"/> + </xsl:when> + <xsl:otherwise>element</xsl:otherwise> + </xsl:choose> + </xsl:param> + + <xsl:choose> + <xsl:when test="$class='attribute'"> + <xsl:call-template name="inline.charseq"/> + </xsl:when> + <xsl:when test="$class='attvalue'"> + <xsl:call-template name="inline.monoseq"/> + </xsl:when> + <xsl:when test="$class='element'"> + <xsl:call-template name="inline.monoseq"/> + </xsl:when> + <xsl:when test="$class='endtag'"> + <xsl:call-template name="inline.monoseq"> + <xsl:with-param name="content"> + <xsl:text></</xsl:text> + <xsl:apply-templates/> + <xsl:text>></xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="$class='genentity'"> + <xsl:call-template name="inline.monoseq"> + <xsl:with-param name="content"> + <xsl:text>\&</xsl:text> + <xsl:apply-templates/> + <xsl:text>;</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="$class='numcharref'"> + <xsl:call-template name="inline.monoseq"> + <xsl:with-param name="content"> + <xsl:text>\&\#</xsl:text> + <xsl:apply-templates/> + <xsl:text>;</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="$class='paramentity'"> + <xsl:call-template name="inline.monoseq"> + <xsl:with-param name="content"> + <xsl:text>\%</xsl:text> + <xsl:apply-templates/> + <xsl:text>;</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="$class='pi'"> + <xsl:call-template name="inline.monoseq"> + <xsl:with-param name="content"> + <xsl:text><?</xsl:text> + <xsl:apply-templates/> + <xsl:text>?></xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="$class='xmlpi'"> + <xsl:call-template name="inline.monoseq"> + <xsl:with-param name="content"> + <xsl:text><?</xsl:text> + <xsl:apply-templates/> + <xsl:text>?></xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="$class='starttag'"> + <xsl:call-template name="inline.monoseq"> + <xsl:with-param name="content"> + <xsl:text><</xsl:text> + <xsl:apply-templates/> + <xsl:text>></xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="$class='emptytag'"> + <xsl:call-template name="inline.monoseq"> + <xsl:with-param name="content"> + <xsl:text><</xsl:text> + <xsl:apply-templates/> + <xsl:text>/></xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="$class='sgmlcomment'"> + <xsl:call-template name="inline.monoseq"> + <xsl:with-param name="content"> + <xsl:text><!--</xsl:text> + <xsl:apply-templates/> + <xsl:text>--></xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="inline.charseq"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/synop-oop.mod.xsl b/docs/docbook/xslt/db2latex/synop-oop.mod.xsl new file mode 100644 index 0000000000..1b5d660aac --- /dev/null +++ b/docs/docbook/xslt/db2latex/synop-oop.mod.xsl @@ -0,0 +1,691 @@ +<?xml version='1.0'?> +<!DOCTYPE xsl:stylesheet [ <!ENTITY RE " "> ]> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version='1.0'> + <!--############################################################################# + | $Id: synop-oop.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: + + ############################################################################## --> + + + + <xsl:template match="classsynopsis"> + <!-- PARAM language : --> + <xsl:param name="language"> + <xsl:choose> + <xsl:when test="@language"> + <xsl:value-of select="@language"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$default-classsynopsis-language"/> + </xsl:otherwise> + </xsl:choose> + </xsl:param> + + <xsl:choose> + <xsl:when test="$language='java'"> <xsl:apply-templates select="." mode="java"/> </xsl:when> + <xsl:when test="$language='perl'"> <xsl:apply-templates select="." mode="perl"/> </xsl:when> + <xsl:when test="$language='idl'"> <xsl:apply-templates select="." mode="idl"/> </xsl:when> + <xsl:when test="$language='cpp'"> <xsl:apply-templates select="." mode="cpp"/> </xsl:when> + <xsl:otherwise> + <xsl:message>Unrecognized language on classsynopsis: <xsl:value-of select="$language"/> </xsl:message> + <xsl:apply-templates select="."> + <xsl:with-param name="language" select="$default-classsynopsis-language"/> + </xsl:apply-templates> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + + + <!-- ===== Java ======================================================== --> + + <xsl:template match="classsynopsis" mode="java"> + <pre class="{name(.)}"> + <xsl:apply-templates select="ooclass[1]" mode="java"/> + <xsl:if test="ooclass[position() > 1]"> + <xsl:text> extends</xsl:text> + <xsl:apply-templates select="ooclass[position() > 1]" mode="java"/> + <xsl:if test="oointerface|ooexception"> + <xsl:text>&RE; </xsl:text> + </xsl:if> + </xsl:if> + <xsl:if test="oointerface"> + <xsl:text>implements</xsl:text> + <xsl:apply-templates select="oointerface" mode="java"/> + <xsl:if test="ooexception"> + <xsl:text>&RE; </xsl:text> + </xsl:if> + </xsl:if> + <xsl:if test="ooexception"> + <xsl:text>throws</xsl:text> + <xsl:apply-templates select="ooexception" mode="java"/> + </xsl:if> + <xsl:text> {&RE;&RE;</xsl:text> + <xsl:apply-templates select="constructorsynopsis + |destructorsynopsis + |fieldsynopsis + |methodsynopsis + |classsynopsisinfo" mode="java"/> + <xsl:text>}</xsl:text> + </pre> + </xsl:template> + + <xsl:template match="classsynopsisinfo" mode="java"> + <xsl:apply-templates mode="java"/> + </xsl:template> + + <xsl:template match="ooclass|oointerface|ooexception" mode="java"> + <xsl:choose> + <xsl:when test="position() > 1"> + <xsl:text>, </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text> </xsl:text> + </xsl:otherwise> + </xsl:choose> + + <xsl:apply-templates mode="java"/> + + </xsl:template> + + <xsl:template match="modifier" mode="java"> + + <xsl:apply-templates mode="java"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="classname" mode="java"> + <xsl:if test="name(preceding-sibling::*[1]) = 'classname'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="java"/> + + </xsl:template> + + <xsl:template match="interfacename" mode="java"> + <xsl:if test="name(preceding-sibling::*[1]) = 'interfacename'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="java"/> + + </xsl:template> + + <xsl:template match="exceptionname" mode="java"> + <xsl:if test="name(preceding-sibling::*[1]) = 'exceptionname'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="java"/> + + </xsl:template> + + <xsl:template match="fieldsynopsis" mode="java"> + + <xsl:text> </xsl:text> + <xsl:apply-templates mode="java"/> + <xsl:text>;</xsl:text> + + </xsl:template> + + <xsl:template match="type" mode="java"> + + <xsl:apply-templates mode="java"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="varname" mode="java"> + + <xsl:apply-templates mode="java"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="initializer" mode="java"> + + <xsl:text>= </xsl:text> + <xsl:apply-templates mode="java"/> + + </xsl:template> + + <xsl:template match="void" mode="java"> + + <xsl:text>void </xsl:text> + + </xsl:template> + + <xsl:template match="methodname" mode="java"> + + <xsl:apply-templates mode="java"/> + </xsl:template> + + + + + <xsl:template match="methodparam" mode="java"> + <!-- PARAM: indent := 0 --> + <xsl:param name="indent">0</xsl:param> + <xsl:if test="position() > 1"> + <xsl:text>,&RE;</xsl:text> + <xsl:if test="$indent > 0"> + <!-- RCAS FIXME: copy-string does not exist + <xsl:call-template name="copy-string"> + <xsl:with-param name="string"> </xsl:with-param> + <xsl:with-param name="count" select="$indent + 1"/> + </xsl:call-template> + --> + </xsl:if> + </xsl:if> + <xsl:apply-templates mode="java"/> + </xsl:template> + + + + <xsl:template match="parameter" mode="java"> + <xsl:apply-templates mode="java"/> + </xsl:template> + + <xsl:template mode="java" + match="constructorsynopsis|destructorsynopsis|methodsynopsis"> + <xsl:variable name="modifiers" select="modifier"/> + <xsl:variable name="notmod" select="*[name(.) != 'modifier']"/> + <xsl:variable name="decl"> + <xsl:text> </xsl:text> + <xsl:apply-templates select="$modifiers" mode="java"/> + + <!-- type --> + <xsl:if test="name($notmod[1]) != 'methodname'"> + <xsl:apply-templates select="$notmod[1]" mode="java"/> + </xsl:if> + + <xsl:apply-templates select="methodname" mode="java"/> + </xsl:variable> + + + <xsl:copy-of select="$decl"/> + <xsl:text>(</xsl:text> + <xsl:apply-templates select="methodparam" mode="java"> + <xsl:with-param name="indent" select="string-length($decl)"/> + </xsl:apply-templates> + <xsl:text>)</xsl:text> + <xsl:if test="exceptionname"> + <xsl:text>&RE; throws </xsl:text> + <xsl:apply-templates select="exceptionname" mode="java"/> + </xsl:if> + <xsl:text>;</xsl:text> + + </xsl:template> + + <!-- ===== C++ ========================================================= --> + + <xsl:template match="classsynopsis" mode="cpp"> + <pre class="{name(.)}"> + <xsl:apply-templates select="ooclass[1]" mode="cpp"/> + <xsl:if test="ooclass[position() > 1]"> + <xsl:text>: </xsl:text> + <xsl:apply-templates select="ooclass[position() > 1]" mode="cpp"/> + <xsl:if test="oointerface|ooexception"> + <xsl:text>&RE; </xsl:text> + </xsl:if> + </xsl:if> + <xsl:if test="oointerface"> + <xsl:text> implements</xsl:text> + <xsl:apply-templates select="oointerface" mode="cpp"/> + <xsl:if test="ooexception"> + <xsl:text>&RE; </xsl:text> + </xsl:if> + </xsl:if> + <xsl:if test="ooexception"> + <xsl:text> throws</xsl:text> + <xsl:apply-templates select="ooexception" mode="cpp"/> + </xsl:if> + <xsl:text> {&RE;&RE;</xsl:text> + <xsl:apply-templates select="constructorsynopsis + |destructorsynopsis + |fieldsynopsis + |methodsynopsis + |classsynopsisinfo" mode="cpp"/> + <xsl:text>}</xsl:text> + </pre> + </xsl:template> + + <xsl:template match="classsynopsisinfo" mode="cpp"> + <xsl:apply-templates mode="cpp"/> + </xsl:template> + + <xsl:template match="ooclass|oointerface|ooexception" mode="cpp"> + <xsl:if test="position() > 1"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="cpp"/> + + </xsl:template> + + <xsl:template match="modifier" mode="cpp"> + + <xsl:apply-templates mode="cpp"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="classname" mode="cpp"> + <xsl:if test="name(preceding-sibling::*[1]) = 'classname'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="cpp"/> + + </xsl:template> + + <xsl:template match="interfacename" mode="cpp"> + <xsl:if test="name(preceding-sibling::*[1]) = 'interfacename'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="cpp"/> + + </xsl:template> + + <xsl:template match="exceptionname" mode="cpp"> + <xsl:if test="name(preceding-sibling::*[1]) = 'exceptionname'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="cpp"/> + + </xsl:template> + + <xsl:template match="fieldsynopsis" mode="cpp"> + + <xsl:text> </xsl:text> + <xsl:apply-templates mode="cpp"/> + <xsl:text>;</xsl:text> + + </xsl:template> + + <xsl:template match="type" mode="cpp"> + + <xsl:apply-templates mode="cpp"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="varname" mode="cpp"> + + <xsl:apply-templates mode="cpp"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="initializer" mode="cpp"> + + <xsl:text>= </xsl:text> + <xsl:apply-templates mode="cpp"/> + + </xsl:template> + + <xsl:template match="void" mode="cpp"> + + <xsl:text>void </xsl:text> + + </xsl:template> + + <xsl:template match="methodname" mode="cpp"> + + <xsl:apply-templates mode="cpp"/> + + </xsl:template> + + <xsl:template match="methodparam" mode="cpp"> + <xsl:if test="position() > 1"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="cpp"/> + + </xsl:template> + + <xsl:template match="parameter" mode="cpp"> + + <xsl:apply-templates mode="cpp"/> + + </xsl:template> + + <xsl:template mode="cpp" + match="constructorsynopsis|destructorsynopsis|methodsynopsis"> + <xsl:variable name="modifiers" select="modifier"/> + <xsl:variable name="notmod" select="*[name(.) != 'modifier']"/> + <xsl:variable name="type"> + </xsl:variable> + + <xsl:text> </xsl:text> + <xsl:apply-templates select="$modifiers" mode="cpp"/> + + <!-- type --> + <xsl:if test="name($notmod[1]) != 'methodname'"> + <xsl:apply-templates select="$notmod[1]" mode="cpp"/> + </xsl:if> + + <xsl:apply-templates select="methodname" mode="cpp"/> + <xsl:text>(</xsl:text> + <xsl:apply-templates select="methodparam" mode="cpp"/> + <xsl:text>)</xsl:text> + <xsl:if test="exceptionname"> + <xsl:text>&RE; throws </xsl:text> + <xsl:apply-templates select="exceptionname" mode="cpp"/> + </xsl:if> + <xsl:text>;</xsl:text> + + </xsl:template> + + <!-- ===== IDL ========================================================= --> + + <xsl:template match="classsynopsis" mode="idl"> + <pre class="{name(.)}"> + <xsl:text>interface </xsl:text> + <xsl:apply-templates select="ooclass[1]" mode="idl"/> + <xsl:if test="ooclass[position() > 1]"> + <xsl:text>: </xsl:text> + <xsl:apply-templates select="ooclass[position() > 1]" mode="idl"/> + <xsl:if test="oointerface|ooexception"> + <xsl:text>&RE; </xsl:text> + </xsl:if> + </xsl:if> + <xsl:if test="oointerface"> + <xsl:text> implements</xsl:text> + <xsl:apply-templates select="oointerface" mode="idl"/> + <xsl:if test="ooexception"> + <xsl:text>&RE; </xsl:text> + </xsl:if> + </xsl:if> + <xsl:if test="ooexception"> + <xsl:text> throws</xsl:text> + <xsl:apply-templates select="ooexception" mode="idl"/> + </xsl:if> + <xsl:text> {&RE;&RE;</xsl:text> + <xsl:apply-templates select="constructorsynopsis + |destructorsynopsis + |fieldsynopsis + |methodsynopsis + |classsynopsisinfo" mode="idl"/> + <xsl:text>}</xsl:text> + </pre> + </xsl:template> + + <xsl:template match="classsynopsisinfo" mode="idl"> + <xsl:apply-templates mode="idl"/> + </xsl:template> + + <xsl:template match="ooclass|oointerface|ooexception" mode="idl"> + <xsl:if test="position() > 1"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="idl"/> + + </xsl:template> + + <xsl:template match="modifier" mode="idl"> + + <xsl:apply-templates mode="idl"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="classname" mode="idl"> + <xsl:if test="name(preceding-sibling::*[1]) = 'classname'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="idl"/> + + </xsl:template> + + <xsl:template match="interfacename" mode="idl"> + <xsl:if test="name(preceding-sibling::*[1]) = 'interfacename'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="idl"/> + + </xsl:template> + + <xsl:template match="exceptionname" mode="idl"> + <xsl:if test="name(preceding-sibling::*[1]) = 'exceptionname'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="idl"/> + + </xsl:template> + + <xsl:template match="fieldsynopsis" mode="idl"> + + <xsl:text> </xsl:text> + <xsl:apply-templates mode="idl"/> + <xsl:text>;</xsl:text> + + </xsl:template> + + <xsl:template match="type" mode="idl"> + + <xsl:apply-templates mode="idl"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="varname" mode="idl"> + + <xsl:apply-templates mode="idl"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="initializer" mode="idl"> + + <xsl:text>= </xsl:text> + <xsl:apply-templates mode="idl"/> + + </xsl:template> + + <xsl:template match="void" mode="idl"> + + <xsl:text>void </xsl:text> + + </xsl:template> + + <xsl:template match="methodname" mode="idl"> + + <xsl:apply-templates mode="idl"/> + + </xsl:template> + + <xsl:template match="methodparam" mode="idl"> + <xsl:if test="position() > 1"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="idl"/> + + </xsl:template> + + <xsl:template match="parameter" mode="idl"> + + <xsl:apply-templates mode="idl"/> + + </xsl:template> + + <xsl:template mode="idl" + match="constructorsynopsis|destructorsynopsis|methodsynopsis"> + <xsl:variable name="modifiers" select="modifier"/> + <xsl:variable name="notmod" select="*[name(.) != 'modifier']"/> + <xsl:variable name="type"> + </xsl:variable> + + <xsl:text> </xsl:text> + <xsl:apply-templates select="$modifiers" mode="idl"/> + + <!-- type --> + <xsl:if test="name($notmod[1]) != 'methodname'"> + <xsl:apply-templates select="$notmod[1]" mode="idl"/> + </xsl:if> + + <xsl:apply-templates select="methodname" mode="idl"/> + <xsl:text>(</xsl:text> + <xsl:apply-templates select="methodparam" mode="idl"/> + <xsl:text>)</xsl:text> + <xsl:if test="exceptionname"> + <xsl:text>&RE; raises(</xsl:text> + <xsl:apply-templates select="exceptionname" mode="idl"/> + <xsl:text>)</xsl:text> + </xsl:if> + <xsl:text>;</xsl:text> + + </xsl:template> + + + + + + <!-- ===== Perl ======================================================== --> + + <xsl:template match="classsynopsis" mode="perl"> + <pre class="{name(.)}"> + <xsl:text>package </xsl:text> + <xsl:apply-templates select="ooclass[1]" mode="perl"/> + <xsl:text>;&RE;</xsl:text> + + <xsl:if test="ooclass[position() > 1]"> + <xsl:text>@ISA = (</xsl:text> + <xsl:apply-templates select="ooclass[position() > 1]" mode="perl"/> + <xsl:text>);&RE;</xsl:text> + </xsl:if> + + <xsl:apply-templates select="constructorsynopsis + |destructorsynopsis + |fieldsynopsis + |methodsynopsis + |classsynopsisinfo" mode="perl"/> + </pre> + </xsl:template> + + <xsl:template match="classsynopsisinfo" mode="perl"> + <xsl:apply-templates mode="perl"/> + </xsl:template> + + <xsl:template match="ooclass|oointerface|ooexception" mode="perl"> + <xsl:if test="position() > 1"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="perl"/> + + </xsl:template> + + <xsl:template match="modifier" mode="perl"> + + <xsl:apply-templates mode="perl"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="classname" mode="perl"> + <xsl:if test="name(preceding-sibling::*[1]) = 'classname'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="perl"/> + + </xsl:template> + + <xsl:template match="interfacename" mode="perl"> + <xsl:if test="name(preceding-sibling::*[1]) = 'interfacename'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="perl"/> + + </xsl:template> + + <xsl:template match="exceptionname" mode="perl"> + <xsl:if test="name(preceding-sibling::*[1]) = 'exceptionname'"> + <xsl:text>, </xsl:text> + </xsl:if> + + <xsl:apply-templates mode="perl"/> + + </xsl:template> + + <xsl:template match="fieldsynopsis" mode="perl"> + + <xsl:text> </xsl:text> + <xsl:apply-templates mode="perl"/> + <xsl:text>;</xsl:text> + + </xsl:template> + + <xsl:template match="type" mode="perl"> + + <xsl:apply-templates mode="perl"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="varname" mode="perl"> + + <xsl:apply-templates mode="perl"/> + <xsl:text> </xsl:text> + + </xsl:template> + + <xsl:template match="initializer" mode="perl"> + + <xsl:text>= </xsl:text> + <xsl:apply-templates mode="perl"/> + + </xsl:template> + + <xsl:template match="void" mode="perl"> + + <xsl:text>void </xsl:text> + + </xsl:template> + + + + <xsl:template match="methodname" mode="perl"> + <xsl:apply-templates mode="perl"/> + </xsl:template> + + <xsl:template match="methodparam" mode="perl"> + <xsl:if test="position() > 1"> <xsl:text>, </xsl:text> </xsl:if> + <xsl:apply-templates mode="perl"/> + </xsl:template> + + + <xsl:template match="parameter" mode="perl"> + <xsl:apply-templates mode="perl"/> + </xsl:template> + + + <xsl:template mode="perl" match="constructorsynopsis|destructorsynopsis|methodsynopsis"> + <xsl:variable name="modifiers" select="modifier"/> + <xsl:variable name="notmod" select="*[name(.) != 'modifier']"/> + <xsl:variable name="type"> </xsl:variable> + + <xsl:text>sub </xsl:text> + + <xsl:apply-templates select="methodname" mode="perl"/> + <xsl:text> { ... };</xsl:text> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/synop-struct.mod.xsl b/docs/docbook/xslt/db2latex/synop-struct.mod.xsl new file mode 100644 index 0000000000..1fef51e62e --- /dev/null +++ b/docs/docbook/xslt/db2latex/synop-struct.mod.xsl @@ -0,0 +1,248 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: synop-struct.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + <xsl:template match="synopsis"> + <xsl:call-template name="label.id"/> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="cmdsynopsis"> + <xsl:call-template name="label.id"/> + <xsl:text> \begin{list}{}{\setlength{\itemindent}{-\leftmargin}\setlength{\parsep}{0mm}} </xsl:text> + <xsl:if test="@label!=''"> + <xsl:text>\item\textbf{</xsl:text> + <xsl:call-template name="normalize-scape"><xsl:with-param name="string" select="@label"/></xsl:call-template> + <xsl:text>} </xsl:text> + </xsl:if> + <xsl:text>\item\raggedright\texttt{</xsl:text> + <xsl:apply-templates/> + <xsl:text>} </xsl:text> + <xsl:text>\end{list} </xsl:text> + </xsl:template> + + + <xsl:template match="cmdsynopsis/command"> + <xsl:apply-templates /> + </xsl:template> + + + <xsl:template match="cmdsynopsis//replaceable" priority="2"> + <xsl:text>{\itshape </xsl:text> + <xsl:apply-templates /> + <xsl:text>}</xsl:text> + </xsl:template> + + + <xsl:template match="group|arg"> + <xsl:variable name="choice" select="@choice"/> + <xsl:variable name="rep" select="@rep"/> + <xsl:variable name="sepchar"> + <xsl:choose> + <xsl:when test="ancestor-or-self::*/@sepchar"> + <xsl:value-of select="ancestor-or-self::*/@sepchar"/> + </xsl:when> + <xsl:otherwise> + <xsl:text> </xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:if test="position()>1"><xsl:value-of select="$sepchar"/></xsl:if> + <xsl:choose> + <xsl:when test="$choice='plain'"> + <xsl:value-of select="$arg.choice.plain.open.str"/> + </xsl:when> + <xsl:when test="$choice='req'"> + <xsl:value-of select="$arg.choice.req.open.str"/> + </xsl:when> + <xsl:when test="$choice='opt'"> + <xsl:value-of select="$arg.choice.opt.open.str"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$arg.choice.def.open.str"/> + </xsl:otherwise> + </xsl:choose> + <xsl:apply-templates/> + <xsl:choose> + <xsl:when test="$rep='repeat'"> + <xsl:value-of select="$arg.rep.repeat.str"/> + </xsl:when> + <xsl:when test="$rep='norepeat'"> + <xsl:value-of select="$arg.rep.norepeat.str"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$arg.rep.def.str"/> + </xsl:otherwise> + </xsl:choose> + <xsl:choose> + <xsl:when test="$choice='plain'"> + <xsl:value-of select="$arg.choice.plain.close.str"/> + </xsl:when> + <xsl:when test="$choice='req'"> + <xsl:value-of select="$arg.choice.req.close.str"/> + </xsl:when> + <xsl:when test="$choice='opt'"> + <xsl:value-of select="$arg.choice.opt.close.str"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$arg.choice.def.close.str"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="group/arg"> + <xsl:variable name="choice" select="@choice"/> + <xsl:variable name="rep" select="@rep"/> + <xsl:if test="position()>1"><xsl:value-of select="$arg.or.sep"/></xsl:if> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="sbr"> + <xsl:text> </xsl:text> + </xsl:template> + + <!-- ==================================================================== --> + + <xsl:template match="synopfragmentref"> + <!-- VAR target : --> + <xsl:variable name="target" select="id(@linkend)"/> + <!-- VAR snum : --> + <xsl:variable name="snum"> + <xsl:apply-templates select="$target" mode="synopfragment.number"/> + </xsl:variable> + + <xsl:text> {\em (</xsl:text> <xsl:value-of select="$snum"/> <xsl:text>) }</xsl:text> + </xsl:template> + + <xsl:template match="synopfragment" mode="synopfragment.number"> + <xsl:number format="1"/> + </xsl:template> + + <xsl:template match="synopfragment"> + <xsl:variable name="snum"> + <xsl:apply-templates select="." mode="synopfragment.number"/> + </xsl:variable> + <p> + <a name="#{@id}"> + <xsl:text>(</xsl:text> + <xsl:value-of select="$snum"/> + <xsl:text>)</xsl:text> + </a> + <xsl:text> </xsl:text> + <xsl:apply-templates/> + </p> + </xsl:template> + + + <xsl:template match="funcsynopsis"> + <xsl:call-template name="informal.object"/> + </xsl:template> + + + <xsl:template match="funcsynopsisinfo"> + <xsl:call-template name="verbatim.apply.templates"/> + </xsl:template> + + + <xsl:template match="funcprototype"> + <xsl:apply-templates/> + <xsl:if test="$funcsynopsis.style='kr'"> + <xsl:apply-templates select="./paramdef" mode="kr-funcsynopsis-mode"/> + </xsl:if> + </xsl:template> + + <xsl:template match="funcdef"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="funcdef/function"> + <xsl:choose> + <xsl:when test="$funcsynopsis.decoration != 0"> + <xsl:text>\textbf{ </xsl:text><xsl:apply-templates/><xsl:text> } </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <xsl:template match="void"> + <xsl:choose> + <xsl:when test="$funcsynopsis.style='ansi'"> + <xsl:text>(void);</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>();</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="varargs"> + <xsl:text>( ... );</xsl:text> + </xsl:template> + + <xsl:template match="paramdef"> + <!-- VAR paramnum --> + <xsl:variable name="paramnum"> <xsl:number count="paramdef" format="1"/> </xsl:variable> + + <xsl:if test="$paramnum=1">(</xsl:if> + <xsl:choose> + <xsl:when test="$funcsynopsis.style='ansi'"> + <xsl:apply-templates/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="./parameter"/> + </xsl:otherwise> + </xsl:choose> + <xsl:choose> + <xsl:when test="following-sibling::paramdef"> + <xsl:text>, </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>);</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + <xsl:template match="paramdef/parameter"> + <xsl:choose> + <xsl:when test="$funcsynopsis.decoration != 0"> + <xsl:apply-templates/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="following-sibling::parameter"> + <xsl:text>, </xsl:text> + </xsl:if> + </xsl:template> + + + + <xsl:template match="paramdef" mode="kr-funcsynopsis-mode"> + \newline + <xsl:apply-templates/> + <xsl:text>;</xsl:text> + </xsl:template> + + <xsl:template match="funcparams"> + <xsl:text>(</xsl:text> + <xsl:apply-templates/> + <xsl:text>)</xsl:text> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/table.mod.xsl b/docs/docbook/xslt/db2latex/table.mod.xsl new file mode 100644 index 0000000000..31085b9093 --- /dev/null +++ b/docs/docbook/xslt/db2latex/table.mod.xsl @@ -0,0 +1,746 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: table.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="table" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: table.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <firstname>Ramon</firstname> <surname>Casellas</surname> + <firstname>James</firstname> <surname>Devenish</surname> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Tables <filename>table.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="table|informaltable" xmlns=""> + <refpurpose>XSL template for docbook tables. </refpurpose> + <refdescription> + <para></para> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + </itemizedlist> + </formalpara> + <formalpara><title>Default Behaviour</title> + <screen></screen> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="table"> + <xsl:variable name="placement"> + <xsl:call-template name="generate.formal.title.placement"> + <xsl:with-param name="object" select="local-name(.)" /> + </xsl:call-template> + </xsl:variable> + <xsl:variable name="caption"> + <xsl:text>\caption{</xsl:text> + <xsl:apply-templates select="title" mode="caption.mode"/> + <xsl:text>} </xsl:text> + </xsl:variable> + <xsl:call-template name="map.begin"/> + <xsl:if test="$placement='before'"> + <xsl:text>\captionswapskip{}</xsl:text> + <xsl:value-of select="$caption" /> + <xsl:text>\captionswapskip{}</xsl:text> + </xsl:if> + <xsl:apply-templates/> + <xsl:if test="$placement!='before'"><xsl:value-of select="$caption" /></xsl:if> + <xsl:call-template name="map.end"/> + </xsl:template> + + <xsl:template match="table/title"/> + <xsl:template match="table/title" mode="caption.mode"><xsl:apply-templates /></xsl:template> + + <xsl:template match="informaltable"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + <xsl:call-template name="map.end"/> + </xsl:template> + + + <xsl:template name="table.format.tabularx"> + <xsl:param name="cols" select="1"/> + <xsl:param name="i" select="1"/> + <xsl:param name="colsep" select="1"/> + <!-- sum of numeric portions in 1*-like colwidths --> + <xsl:param name="starfactor" select="0"/> + <xsl:choose> + <!-- Out of the recursive iteration --> + <xsl:when test="$i > $cols"></xsl:when> + <!-- There are still columns to count --> + <xsl:otherwise> + <xsl:variable name="width"> + <xsl:variable name="userchoice" select="colspec[@colnum=$i]/@colwidth"/> + <xsl:variable name="cells" select="thead/row/entry[$i]|tbody/row/entry[$i]"/> + <xsl:choose> + <xsl:when test="string-length($userchoice)=0 and count($cells//itemizedlist|$cells//orderedlist|$cells//variablelist)>0"> + <!-- In these specific circumstances, we MUST use a line-wrapped column + and yet the user hasn't specified one. --> + <xsl:value-of select="'1*'"/> + </xsl:when> + <xsl:otherwise> + <!-- In the general case, we just do what the user wants (may even + have no pre-specified width). --> + <xsl:value-of select="$userchoice"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <!-- Try to take heed of colspecs --> + <xsl:choose> + <xsl:when test="$width!=''"> + <xsl:text>>{</xsl:text> + <xsl:if test="contains($width,'*')"> + <!-- see tabularx documentation --> + <xsl:text>\hsize=</xsl:text> + <xsl:value-of select="substring-before($width,'*') * $starfactor" /> + <xsl:text>\hsize</xsl:text> + </xsl:if> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>\RaggedRight</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>\RaggedLeft</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>\Centering</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + </xsl:choose> + <xsl:text>}</xsl:text> + <xsl:choose> + <xsl:when test="contains($width,'*')"> + <xsl:text>X</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>p{</xsl:text><xsl:value-of select="$width" /><xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:when> + <xsl:otherwise> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>r</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>c</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='justify'"><xsl:text>X</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:text>c</xsl:text><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + <xsl:otherwise><xsl:text>c</xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:otherwise> + </xsl:choose> + <!-- Recursive for next column --> + <xsl:call-template name="table.format.tabularx"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="starfactor" select="$starfactor"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <!-- FIX THIS --> + <xsl:template name="table.format.tabular"> + <xsl:param name="cols" select="1"/> + <xsl:param name="i" select="1"/> + <xsl:param name="colsep" select="1"/> + <xsl:choose> + <!-- Out of the recursive iteration --> + <xsl:when test="$i > $cols"></xsl:when> + <!-- There are still columns to count --> + <xsl:otherwise> + <!-- Try to take heed of colspecs --> + <xsl:choose> + <!-- RC 2003/03/19 : Added first 'test' : colspec[@colnum=$i] for xsltproc + Before this patch, parsing the doc with xsltproc the xsl:when clause + was evaluated to 'true' even if there was no colspec for the column + --> + <xsl:when test="colspec[@colnum=$i] and colspec[@colnum=$i]/@colwidth!='' and not(contains(colspec[@colnum=$i]/@colwidth,'*'))"> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>>{\RaggedRight}</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>>{\RaggedLeft}</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>>{\Centering}</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + </xsl:choose> + <xsl:text>p{</xsl:text><xsl:value-of select="colspec[@colnum=$i]/@colwidth" /><xsl:text>}</xsl:text> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:when> + <xsl:otherwise> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>r</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>c</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='justify'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:text>c</xsl:text><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + <xsl:otherwise><xsl:text>c</xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:otherwise> + </xsl:choose> + <!-- Recursive for next column --> + <xsl:call-template name="table.format.tabular"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + <!-- See tabularx documentation. --> + <!-- For example, if we have a 1* column and a 3* column, then the + the hsizes for each column are (1/(1+3)*2) and (3/(1+3)*2). + The ratio of these to the star values (star values being 1 and 3) + is 2/(1+3). + BUT it is now very complicated because it takes into account columns + where the user has not specified a width but LaTeX requires a + fixed-width column (i.e. specialcols may vary). + Relies on there being (a) colspecs for every column or (b) no + colspecs. + --> + <xsl:template name="generate.starfactor"> + <xsl:param name="i" select="1"/> + <xsl:param name="cols" select="count(colspec)"/> + <xsl:param name="sum" select="0"/> + <xsl:param name="specialcols" select="count(colspec[contains(@colwidth,'*')])"/> + <xsl:choose> + <xsl:when test="$i<=$cols and colspec[position()=$i and contains(@colwidth,'*')]"> + <!-- a * column --> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="sum" select="$sum+substring-before(colspec[$i]/@colwidth,'*')"/> + <xsl:with-param name="specialcols" select="$specialcols"/> + </xsl:call-template> + </xsl:when> + <xsl:when test="$i<=$cols"> + <!-- not a * column, but we are going to pretend that it is --> + <xsl:variable name="cells" select="thead/row/entry[$i]|tbody/row/entry[$i]"/> + <xsl:variable name="problems" select="count($cells//itemizedlist|$cells//orderedlist|$cells//variablelist)"/> + <xsl:choose> + <xsl:when test="$problems > 0"> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="sum" select="$sum+1"/> + <xsl:with-param name="specialcols" select="$specialcols+1"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="sum" select="$sum"/> + <xsl:with-param name="specialcols" select="$specialcols"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$specialcols div $sum"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <xsl:template match="tgroup"> + <xsl:variable name="align" select="@align"/> + <xsl:variable name="frame"> + <xsl:choose> + <xsl:when test="string-length(../@frame)<1">all</xsl:when> + <xsl:otherwise> + <xsl:value-of select="../@frame"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="colspecs" select="./colspec"/> + <xsl:variable name="usex"> + <xsl:choose> + <!-- if there are lists within cells, we need tabularx --> + <xsl:when test="$latex.use.tabularx=1 and (descendant::itemizedlist|descendant::orderedlist|descendant::variablelist)"> + <xsl:text>1</xsl:text> + </xsl:when> + <!-- if there are instances of 1*-style colwidths, we need tabularx --> + <xsl:when test="$latex.use.tabularx=1 and contains(colspec/@colwidth,'*')"> + <xsl:text>1</xsl:text> + </xsl:when> + <!-- if there are colspecs with 'justify' alignment and no explicit width, we need tabularx --> + <xsl:when test="$latex.use.tabularx=1 and count(colspec[@align='justify'])>0"> + <xsl:text>1</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>0</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="useminipage"> + <!-- Hack to get around LaTeX issue with tabular (not necessary with tabularx). + This is NOT a good solution, and has problems of its own, but at least the footnotes + do not actually disappear (which is what would otherwise happen). --> + <xsl:if test="count(.//footnote)!=0">1</xsl:if> + </xsl:variable> + <xsl:choose> + <xsl:when test="$usex='1'"> + <xsl:text>\begin{tabularx}{\linewidth}{</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:if test="$useminipage='1'"><xsl:text>\begin{minipage}{\linewidth} </xsl:text></xsl:if> + <xsl:text>\begin{tabular}{</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="$frame='all' or $frame='sides'"> + <xsl:text>|</xsl:text> + </xsl:if> + <xsl:choose> + <xsl:when test="$usex=1"> + <xsl:call-template name="table.format.tabularx"> + <xsl:with-param name="cols" select="@cols"/> + <xsl:with-param name="starfactor"> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="cols" select="@cols"/> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="table.format.tabular"> + <xsl:with-param name="cols" select="@cols"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="$frame='all' or $frame='sides'"> + <xsl:text>|</xsl:text> + </xsl:if> + <xsl:text>} </xsl:text> + <xsl:if test="$frame!='sides' and $frame!='none' and $frame!='bottom'"> + <xsl:text>\hline </xsl:text> + </xsl:if> + <!-- APPLY TEMPLATES --> + <xsl:apply-templates/> + <!-- --> + <xsl:if test="$frame!='sides' and $frame!='none' and $frame!='top'"> + <xsl:text>\hline </xsl:text> + </xsl:if> + <xsl:choose> + <xsl:when test="$usex=1"> + <xsl:text>\end{tabularx} </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\end{tabular} </xsl:text> + <xsl:if test="$useminipage='1'"><xsl:text>\end{minipage} </xsl:text></xsl:if> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + <!-- + <xsl:template name="generate.col"> + <xsl:param name="countcol">1</xsl:param> + </xsl:template> + --> + + <xsl:template match="colspec"></xsl:template> + <xsl:template match="spanspec"></xsl:template> + + + + + <xsl:template match="thead|tfoot"> + <xsl:if test="@align"> + <xsl:attribute name="align"> + <xsl:value-of select="@align"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@char"> + <xsl:attribute name="char"> + <xsl:value-of select="@char"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@charoff"> + <xsl:attribute name="charoff"> + <xsl:value-of select="@charoff"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@valign"> + <xsl:attribute name="valign"> + <xsl:value-of select="@valign"/> + </xsl:attribute> + </xsl:if> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="thead/row/entry|tfoot/row/entry"> + <xsl:call-template name="latex.entry.prealign"/> + <xsl:call-template name="latex.thead.row.entry"/> + <xsl:call-template name="latex.entry.postalign"/> + <xsl:choose> + <xsl:when test="position()=last()"><xsl:text> \tabularnewline </xsl:text></xsl:when> + <xsl:otherwise><xsl:call-template name="generate.latex.cell.separator"/></xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="tbody"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="row"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="tbody/row|thead/row|tfoot/row"> + <xsl:apply-templates/> + <!-- The rule below the last row in the table is controlled by the + Frame attribute of the enclosing Table or InformalTable and the RowSep + of the last row is ignored. If unspecified, this attribute is + inherited from enclosing elements, rowsep=1 by default. --> + <xsl:variable name="parent_position" select="count(../preceding-sibling::node())+1"/> + <xsl:variable name="grandparent_children" select="count(../../child::node())"/> + <xsl:if test="(count(@rowsep)=0 or @rowsep='1') and (position() != last() or $parent_position < $grandparent_children)"> + <xsl:text> \hline </xsl:text> + </xsl:if> + </xsl:template> + + + <xsl:template match="tbody/row/entry"> + <xsl:call-template name="latex.entry.prealign"/> + <xsl:apply-templates/> + <xsl:call-template name="latex.entry.postalign"/> + <xsl:choose> + <xsl:when test="position()=last()"><xsl:text> \tabularnewline </xsl:text></xsl:when> + <xsl:otherwise><xsl:call-template name="generate.latex.cell.separator"/></xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <xsl:template name="latex.entry.prealign"> + <xsl:variable name="span"> + <xsl:choose> + <xsl:when test="@spanname!=''"> + <xsl:call-template name="calculate.colspan"> + <xsl:with-param name="namest" select="../../../spanspec[@spanname=@spanname]/@namest"/> + <xsl:with-param name="nameend" select="../../../spanspec[@spanname=@spanname]/@nameend"/> + </xsl:call-template> + </xsl:when> + <xsl:when test="@namest!=''"> + <xsl:call-template name="calculate.colspan"/> + </xsl:when> + <xsl:otherwise>-1</xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:if test="$span > 1"> + <xsl:text>\multicolumn{</xsl:text> + <xsl:value-of select="$span"/> + <xsl:text>|}{</xsl:text><!-- TODO take heed of @colsep --> + <xsl:choose> + <xsl:when test="@align='left'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="@align='right'"><xsl:text>r</xsl:text></xsl:when> + <xsl:when test="@align='center'"><xsl:text>c</xsl:text></xsl:when> + <xsl:when test="@align='char'">c<xsl:message>Table entry char alignment is not supported.</xsl:message></xsl:when> + <xsl:otherwise>c</xsl:otherwise> + </xsl:choose> + <!-- use this as a hook for some general warnings --> + <xsl:text>}</xsl:text> + </xsl:if> + <!-- this is used when the entry's align spec wants to override the column default --> + <xsl:if test="$span < 1"> + <xsl:choose> + <xsl:when test="@align='left'"><xsl:text>\docbooktolatexalignll </xsl:text></xsl:when> + <xsl:when test="@align='right'"><xsl:text>\docbooktolatexalignrl </xsl:text></xsl:when> + <xsl:when test="@align='center'"><xsl:text>\docbooktolatexaligncl </xsl:text></xsl:when> + <xsl:when test="@align='char'"><xsl:message>Table entry char alignment is not supported.</xsl:message></xsl:when> + </xsl:choose> + </xsl:if> + <xsl:text>{</xsl:text> + <xsl:if test="@rotate='1'"> + <xsl:text>\rotatebox{90}</xsl:text> + <xsl:if test="@align!=''"><xsl:message>entry[@rotate='1' and @align!=''] probably doesn't work.</xsl:message></xsl:if> + </xsl:if> + <xsl:text>{</xsl:text> + <!-- use this as a hook for some general warnings --> + <xsl:if test="@morerows!=''"><xsl:message>The morerows attribute is not supported.</xsl:message></xsl:if> + </xsl:template> + + <xsl:template name="latex.entry.postalign"> + <xsl:text>}}</xsl:text> + <!-- this is used when the entry's align spec wants to override the column default --> + <xsl:if test="@namest='' and @spanspec=''"><!-- TODO improve --> + <xsl:choose> + <xsl:when test="@align='left'"><xsl:text>\docbooktolatexalignlr </xsl:text></xsl:when> + <xsl:when test="@align='right'"><xsl:text>\docbooktolatexalignrr </xsl:text></xsl:when> + <xsl:when test="@align='center'"><xsl:text>\docbooktolatexaligncr </xsl:text></xsl:when> + </xsl:choose> + </xsl:if> + </xsl:template> + + + + + + + + + + + + + + <xsl:template name="process.cell"> + <xsl:param name="cellgi">td</xsl:param> + <xsl:variable name="empty.cell" select="count(node()) = 0"/> + + <xsl:element name="{$cellgi}"> + <xsl:if test="@morerows"> + <xsl:attribute name="rowspan"> + <xsl:value-of select="@morerows+1"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@namest"> + <xsl:attribute name="colspan"> + <xsl:call-template name="calculate.colspan"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@align"> + <xsl:attribute name="align"> + <xsl:value-of select="@align"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@char"> + <xsl:attribute name="char"> + <xsl:value-of select="@char"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@charoff"> + <xsl:attribute name="charoff"> + <xsl:value-of select="@charoff"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@valign"> + <xsl:attribute name="valign"> + <xsl:value-of select="@valign"/> + </xsl:attribute> + </xsl:if> + + <xsl:choose> + <xsl:when test="$empty.cell"> + <xsl:text> </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> + </xsl:element> + </xsl:template> + + <xsl:template name="generate.colgroup"> + <xsl:param name="cols" select="1"/> + <xsl:param name="count" select="1"/> + <xsl:choose> + <xsl:when test="$count>$cols"></xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.col"> + <xsl:with-param name="countcol" select="$count"/> + </xsl:call-template> + <xsl:call-template name="generate.colgroup"> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="count" select="$count+1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="generate.col"> + <xsl:param name="countcol">1</xsl:param> + <xsl:param name="colspecs" select="./colspec"/> + <xsl:param name="count">1</xsl:param> + <xsl:param name="colnum">1</xsl:param> + + <xsl:choose> + <xsl:when test="$count>count($colspecs)"> + <col/> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="colspec" select="$colspecs[$count=position()]"/> + <xsl:variable name="colspec.colnum"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$colspec.colnum=$countcol"> + <col> + <xsl:if test="$colspec/@align"> + <xsl:attribute name="align"> + <xsl:value-of select="$colspec/@align"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="$colspec/@char"> + <xsl:attribute name="char"> + <xsl:value-of select="$colspec/@char"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="$colspec/@charoff"> + <xsl:attribute name="charoff"> + <xsl:value-of select="$colspec/@charoff"/> + </xsl:attribute> + </xsl:if> + </col> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.col"> + <xsl:with-param name="countcol" select="$countcol"/> + <xsl:with-param name="colspecs" select="$colspecs"/> + <xsl:with-param name="count" select="$count+1"/> + <xsl:with-param name="colnum"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum + 1"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum + 1"/> + </xsl:otherwise> + </xsl:choose> + </xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + + </xsl:template> + + <xsl:template name="colspec.colnum"> + <!-- when this macro is called, the current context must be an entry --> + <xsl:param name="colname"></xsl:param> + <!-- .. = row, ../.. = thead|tbody, ../../.. = tgroup --> + <xsl:param name="colspecs" select="../../../../tgroup/colspec"/> + <xsl:param name="count">1</xsl:param> + <xsl:param name="colnum">1</xsl:param> + <xsl:choose> + <xsl:when test="$count>count($colspecs)"></xsl:when> + <xsl:otherwise> + <xsl:variable name="colspec" select="$colspecs[$count=position()]"/> + <!-- + <xsl:value-of select="$count"/>: + <xsl:value-of select="$colspec/@colname"/>= + <xsl:value-of select="$colnum"/> + --> + <xsl:choose> + <xsl:when test="$colspec/@colname=$colname"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum"/> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="colspec.colnum"> + <xsl:with-param name="colname" select="$colname"/> + <xsl:with-param name="colspecs" select="$colspecs"/> + <xsl:with-param name="count" select="$count+1"/> + <xsl:with-param name="colnum"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum + 1"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum + 1"/> + </xsl:otherwise> + </xsl:choose> + </xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="colspec.colwidth"> + <!-- when this macro is called, the current context must be an entry --> + <xsl:param name="colname"></xsl:param> + <!-- .. = row, ../.. = thead|tbody, ../../.. = tgroup --> + <xsl:param name="colspecs" select="../../../../tgroup/colspec"/> + <xsl:param name="count">1</xsl:param> + <xsl:choose> + <xsl:when test="$count>count($colspecs)"></xsl:when> + <xsl:otherwise> + <xsl:variable name="colspec" select="$colspecs[$count=position()]"/> + <xsl:choose> + <xsl:when test="$colspec/@colname=$colname"> + <xsl:value-of select="$colspec/@colwidth"/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="colspec.colwidth"> + <xsl:with-param name="colname" select="$colname"/> + <xsl:with-param name="colspecs" select="$colspecs"/> + <xsl:with-param name="count" select="$count+1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="calculate.colspan"> + <xsl:param name="namest" select="@namest"/> + <xsl:param name="nameend" select="@nameend"/> + <xsl:variable name="scol"> + <xsl:call-template name="colspec.colnum"> + <xsl:with-param name="colname" select="$namest"/> + </xsl:call-template> + </xsl:variable> + <xsl:variable name="ecol"> + <xsl:call-template name="colspec.colnum"> + <xsl:with-param name="colname" select="$nameend"/> + </xsl:call-template> + </xsl:variable> + <xsl:value-of select="$ecol - $scol + 1"/> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/texmath.mod.xsl b/docs/docbook/xslt/db2latex/texmath.mod.xsl new file mode 100644 index 0000000000..84becee530 --- /dev/null +++ b/docs/docbook/xslt/db2latex/texmath.mod.xsl @@ -0,0 +1,120 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: texmath.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="texmath" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: texmath.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>LaTeX Only Commands <filename>texmath.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + <xsl:template match="alt"> + <xsl:choose> + <xsl:when test="ancestor::inlineequation and (@role='tex' or @role='latex' or $latex.alt.is.latex='1')"> + <xsl:text>\ensuremath{</xsl:text> + <xsl:value-of select="."/> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:when test="ancestor::equation|ancestor::informalequation and (@role='tex' or @role='latex' or $latex.alt.is.latex='1')"> + <xsl:text>\begin{displaymath}</xsl:text> + <xsl:call-template name="label.id"/> + <xsl:value-of select="."/> + <xsl:text>\end{displaymath} </xsl:text> + </xsl:when> + <xsl:when test="$latex.alt.is.latex='1'"> + <xsl:value-of select="."/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="latex|tex"> + <xsl:value-of select="."/> + </xsl:template> + + <xsl:template match="latex[@fileref]"> + <xsl:text>\input{</xsl:text><xsl:value-of select="@fileref"/><xsl:text>} </xsl:text> + </xsl:template> + + <xsl:template match="tex[@fileref]"> + <xsl:text>\input{</xsl:text><xsl:value-of select="@fileref"/><xsl:text>} </xsl:text> + </xsl:template> + + + <xsl:template match="tm[@fileref]"> + <xsl:text>\input{</xsl:text><xsl:value-of select="@fileref"/><xsl:text>} </xsl:text> + </xsl:template> + + <xsl:template match="tm[@tex]"> + <xsl:value-of select="@tex"/> + </xsl:template> + + <xsl:template match="inlinetm[@fileref]"> + <xsl:text>\input{</xsl:text><xsl:value-of select="@fileref"/><xsl:text>} </xsl:text> + </xsl:template> + + <xsl:template match="inlinetm[@tex]"> + <xsl:value-of select="@tex"/> + </xsl:template> + + + <xsl:template match="inlineequation"> + <xsl:variable name="tex" select="alt[@role='tex' or @role='latex']|inlinemediaobject/textobject[@role='tex' or @role='latex']|inlinemediaobject/textobject/phrase[@role='tex' or @role='latex']" /> + <xsl:choose> + <xsl:when test="$tex"> + <xsl:apply-templates select="$tex"/> + </xsl:when> + <xsl:when test="alt and $latex.alt.is.preferred='1'"> + <xsl:apply-templates select="alt"/> + </xsl:when> + <xsl:when test="inlinemediaobject"> + <xsl:apply-templates select="inlinemediaobject"/> + </xsl:when> + <xsl:when test="alt"> + <xsl:apply-templates select="alt"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="graphic"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/vars.mod.xsl b/docs/docbook/xslt/db2latex/vars.mod.xsl new file mode 100644 index 0000000000..764c3a0a95 --- /dev/null +++ b/docs/docbook/xslt/db2latex/vars.mod.xsl @@ -0,0 +1,943 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: vars.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: User and stylesheets XSL variables ++ ############################################################################## --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <doc:reference id="vars" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: vars.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author><surname>Casellas</surname><firstname>Ramon</firstname></author> + <author><surname>Devenish</surname><firstname>James</firstname></author> + </authorgroup> + <copyright> + <year>2000</year><year>2001</year><year>2002</year><year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>XSL Variables and Parameters</title> + + <partintro> + <section><title>Introduction</title> + + <para>This is technical reference documentation for the DocBook XSL + Stylesheets. It documents (some of) the parameters, templates, and + other elements of the stylesheets.</para> + </section> + </partintro> + </doc:reference> + + + <!--############################################################################# + | COMMON VARIABLES + |- ############################################################################# + | $Author: ab $ + | + + ############################################################################## --> + <xsl:variable name="default-classsynopsis-language">java</xsl:variable> + + <xsl:variable name="author.othername.in.middle" select="1"/> + <xsl:variable name="refentry.xref.manvolnum" select="1"/> + <xsl:variable name="funcsynopsis.style">kr</xsl:variable> + <xsl:variable name="funcsynopsis.decoration" select="1"/> + <xsl:variable name="function.parens">0</xsl:variable> + <xsl:variable name="refentry.generate.name" select="1"/> + + <doc:param name="show.comments" xmlns=""> + <refpurpose> Display <sgmltag class="element">comment</sgmltag> elements? </refpurpose> + <refdescription> + <para>Control the display of <sgmltag class="element">comment</sgmltag>s and <sgmltag class="element">remark</sgmltag>s.</para> + </refdescription> + </doc:param> + <xsl:param name="show.comments" select="1"/> + + <xsl:variable name="section.autolabel" select="1"/> + <xsl:variable name="section.label.includes.component.label" select="0"/> + <xsl:variable name="chapter.autolabel" select="1"/> + <xsl:variable name="preface.autolabel" select="0"/> + <xsl:variable name="part.autolabel" select="1"/> + <xsl:variable name="qandadiv.autolabel" select="1"/> + <xsl:variable name="autotoc.label.separator" select="'. '"/> + <xsl:variable name="qanda.inherit.numeration" select="1"/> + <xsl:variable name="qanda.defaultlabel">number</xsl:variable> + <xsl:param name="biblioentry.item.separator">, </xsl:param> + <doc:param name="toc.section.depth" xmlns=""> + <refpurpose> Cull table-of-contents entries that are deeply nested </refpurpose> + <refdescription> + <para>Specifies the maximum depth before sections are omitted from the table of contents.</para> + </refdescription> + </doc:param> + <xsl:param name="toc.section.depth">4</xsl:param> + + <doc:param name="section.depth" xmlns=""> + <refpurpose> Control the automatic numbering of section, parts, and chapters </refpurpose> + <refdescription> + <para> + Specifies the maximum depth before sections cease to be uniquely numbered. + This is passed to LaTeX using the <literal>secnumdepth</literal> counter. + Therefore, it is possible to use a value of <quote>0</quote> (zero) to disable section numbering. + A value of <quote>-1</quote> will disable the numbering of parts and chapters, too. + </para> + </refdescription> + </doc:param> + <xsl:param name="section.depth">4</xsl:param> + <xsl:variable name="graphic.default.extension"></xsl:variable> + <xsl:variable name="check.idref">1</xsl:variable> + <!-- + <xsl:variable name="link.mailto.url"></xsl:variable> + <xsl:variable name="toc.list.type">dl</xsl:variable> + --> + + <doc:param name="use.role.for.mediaobject" xmlns=""> + <refpurpose> Control <sgmltag class="element">mediaobject</sgmltag> selection methods </refpurpose> + <refdescription> + <para>This controls how DB2LaTeX behaves when a <sgmltag class="element">figure</sgmltag> contains + multiple <sgmltag class="element">mediaobject</sgmltag>s. When enabled, DB2LaTeX will choose + the mediaobject with the "LaTeX" or "TeX" role, if present. Otherwise, the first mediaobject + is chosen.</para> + </refdescription> + </doc:param> + <xsl:param name="use.role.for.mediaobject">1</xsl:param> + + <doc:param name="preferred.mediaobject.role" xmlns=""> + <refpurpose> Control <sgmltag class="element">mediaobject</sgmltag> selection methods </refpurpose> + <refdescription> + <para>When <xref linkend="param.use.role.for.mediaobject"/> is enabled, this variable + can be used to specify the mediaobject role that your document uses for LaTeX output. + DB2LaTeX will try to use this role before using the "LaTeX" or "TeX" roles. + For example, some authors may choose to set this to "PDF".</para> + </refdescription> + </doc:param> + <xsl:param name="preferred.mediaobject.role"></xsl:param> + + <doc:param name="formal.title.placement" xmlns=""> + <refpurpose> Specifies where formal object titles should occur </refpurpose> + <refdescription> + <para> + Titles for the formal object types (figure, example, quation, table, and procedure) + can be placed before or after those objects. The keyword <quote>before</quote> + is recognised. All other strings qualify as <quote>after</quote>. + </para> + </refdescription> + </doc:param> + <xsl:param name="formal.title.placement"> + figure not_before + example before + equation not_before + table before + procedure before + </xsl:param> + + <doc:param name="insert.xref.page.number" xmlns=""> + <refpurpose> Control the appearance of page numbers in cross references </refpurpose> + <refdescription> + <para> + When enabled, <sgmltag class="element">xref</sgmltag>s will include page + numbers after their generated cross-reference text. + </para> + </refdescription> + </doc:param> + <xsl:param name="insert.xref.page.number">0</xsl:param> + + <doc:param name="ulink.show" xmlns=""> + <refpurpose> Control the display of URLs after ulinks </refpurpose> + <refdescription> + <para> + When this option is enabled, and a ulink has a URL that is different + from the displayed content, the URL will be typeset after the content. + If the URL and content are identical, only one of them will appear. + Otherwise, the URL is hyperlinked and the content is not. + </para> + </refdescription> + </doc:param> + <xsl:param name="ulink.show">0</xsl:param> + + <doc:param name="ulink.footnotes" xmlns=""> + <refpurpose> Control the generation of footnotes for ulinks </refpurpose> + <refdescription> + <para> + When this option is enabled, a ulink that has content different to its + URL will have an associated footnote. The contents of the footnote + will be the URL. If the ulink is within a footnote, the URL is shown + after the content. + </para> + </refdescription> + </doc:param> + <xsl:param name="ulink.footnotes">0</xsl:param> + + <!--############################################################################# + | LaTeX VARIABLES + |- ############################################################################# + | $Author: ab $ + | + | PURPOSE: User and stylesheets XSL variables + + ############################################################################## --> + + <doc:param name="latex.override" xmlns=""> + <refpurpose> Override DB2LaTeX's preamble with a custom preamble. </refpurpose> + <refdescription> + <para> + When this variable is set, the entire DB2LaTeX premable will be superseded. + <emphasis>You should not normally need or want to use this.</emphasis> + It may cause LaTeX typesetting problems. This is a last resort or + <quote>expert</quote> feature. + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.override"></xsl:param> + + <doc:param name="latex.entities" xmlns=""> + <refpurpose> Control Unicode character handling. </refpurpose> + <refdescription> + <para> + Normally, XSLT processors will convert SGML character entities into + Unicode characters and DB2LaTeX doesn't have much chance to do anything + toward converting them to LaTeX equivalents. We do not yet know how we + can solve this problem best. + </para> + <para> + Proposed values: 'catcode', 'unicode', 'extension'. + Currently only 'catcode' is supported. All other values will + cause no special handling except for certain mappings in MathML. + In future, perhaps the 'unicode' LaTeX package could be of assistance. + 'Extension' could be an XSLT extension that handles the characters + using a mapping table. + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.entities"></xsl:param> + + <doc:param name="latex.alt.is.latex" xmlns=""> + <refpurpose> Control the escaping of <sgmltag class="element">alt</sgmltag> text </refpurpose> + <refdescription> + <para> + Text within <sgmltag class="element">alt</sgmltag> elements is assumed to + be valid LaTeX and is passed through unescaped by default. If this is not + appropriate for your document, set this variable to something other than + '1'. + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.alt.is.latex">1</xsl:param> + + <doc:param name="latex.alt.is.preferred" xmlns=""> + <refpurpose> Control the use of <sgmltag class="element">alt</sgmltag> text </refpurpose> + <refdescription> + <para> + By default, DB2LaTeX assumes that <sgmltag class="element">alt</sgmltag> + text should be typeset in preference to any + <sgmltag class="element">mediaobject</sgmltag>s. + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.alt.is.preferred">1</xsl:param> + + <!-- + <doc:variable name="latex.figure.position" xmlns=""> + <refpurpose> How to place floats. </refpurpose> + <refdescription> + <para> + This variable is used as the positioning argument for floats. + In future, this may be replaced by a dynamic mechanism that can + honour DocBook placement attributes. + </para> + </refdescription> + </doc:variable> + <xsl:variable name="latex.figure.position">[hbt]</xsl:variable> + --> + + <doc:param name="latex.apply.title.templates" xmlns=""> + <refpurpose> Whether to apply templates for section titles. </refpurpose> + <refdescription> + <para> + Controls whether section titles will be generated by + applying templates or by conversion to string values. + When enabled, templates will be applied. This enables template + expression in titles but may have problematic side-effects such + as nested links. + </para> + <note> + <para> + This variable does not influence all <sgmltag class="element">title</sgmltag> + elements. Some may have their own variables or not be configurable. + </para> + </note> + </refdescription> + </doc:param> + <xsl:param name="latex.apply.title.templates">1</xsl:param> + + + + + + <doc:param name="latex.apply.title.templates.admonitions" xmlns=""> + <refpurpose> Whether to apply templates for admonition titles. </refpurpose> + <refdescription> + <para> + Controls whether admonition titles will be generated by + applying templates or by conversion to string values. + When enabled, templates will be applied. + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.apply.title.templates.admonitions">1</xsl:param> + + + + + + + <doc:param name="latex.graphics.formats" xmlns=""> + <refpurpose> Control <sgmltag class="element">imagedata</sgmltag> selection. </refpurpose> + <refdescription> + <para>This controls how DB2LaTeX behaves when a <sgmltag class="element">mediaobject</sgmltag> contains + multiple <sgmltag class="element">imagedata</sgmltag>. When non-empty, DB2LaTeX will exclude + imagedata that have a format no listed within this variable.</para> + </refdescription> + </doc:param> + <xsl:param name="latex.graphics.formats"></xsl:param> + + + + + + + <doc:param name="latex.caption.swapskip" xmlns=""> + <refpurpose> Improved typesetting of captions </refpurpose> + <refdescription> + <para> + DB2LaTeX supports <link linkend="param.formal.title.placement">$formal.title.placement</link> + as a mechanism for choosing whether captions will appear above or below the objects they describe. + <!-- + ($formal.title.placement is described in the <ulink + url="http://docbook.sourceforge.net/release/xsl/current/doc/html/formal.title.placement.html">DocBook + XSL Stylesheet HTML Parameter Reference</ulink>.) + --> + However, LaTeX will often produce an ugly result when captions occur + above their corresponding content. This usually arises because of + unsuitable \abovecaptionskip and \belowcaptionskip. + </para> + <para> + This variable, when set to '1', authorises DB2LaTeX to swap the caption + 'skip' lengths when a caption is placed <emphasis>above</emphasis> its + corresponding content. This is enabled by default. + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.caption.swapskip">1</xsl:param> + + + + + + <doc:param name="latex.titlepage.file" xmlns=""> + <refpurpose> DB2LaTeX allows using an (externally generated) cover page </refpurpose> + <refdescription> + <para> + You may supply a LaTeX file that will supersede DB2LaTeX's default + cover page or title. If the value of this variable is non-empty, the + generated LaTeX code includes \input{filename}. Otherwise, it uses the + \maketitle command. + </para> + <warning><para> + Bear in mind that using an external cover page breaks the + "encapsulation" of DocBook. Further revisions of these stylesheets + will add chunking support, and the automation of the cover file + generation. + </para></warning> + </refdescription> + </doc:param> + <xsl:param name="latex.titlepage.file">title</xsl:param> + + + + + <doc:param name="latex.documentclass" xmlns=""> + <refpurpose> DB2LaTeX document class </refpurpose> + <refdescription> + <para> + This variable is normally empty and the stylesheets will determine + the correct document class according to whether the document is a + book or an article. If you wish to use your own document class, + put its non-empty value in this variable. It will apply for both + books and articles. + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.documentclass"></xsl:param> + + <doc:param name="latex.documentclass.common" xmlns=""> + <refpurpose> DB2LaTeX document class options </refpurpose> + <refdescription> + <para> + These are the first options to be passed to <literal>\documentclass</literal> + The common options are set to <literal>french,english</literal> by default. + They will be augmented or superseded by article/book options (see $latex.documentclass.article and $latex.documentclass.book) and pdftex/dvips options (see $latex.documentclass.pdftex and $latex.documentclass.dvips). + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.documentclass.common">french,english</xsl:param> + + <doc:param name="latex.documentclass.article" xmlns=""> + <refpurpose> DB2LaTeX document class options for articles</refpurpose> + <refdescription> + <para> + The article options are set to <literal>a4paper,10pt,twoside,twocolumn</literal> by default. + These are the intermediate options to be passed to <literal>\documentclass</literal>, + between the common options and the pdftex/dvips options. + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.documentclass.article">a4paper,10pt,twoside,twocolumn</xsl:param> + + <doc:param name="latex.documentclass.book" xmlns=""> + <refpurpose> DB2LaTeX document class options for books</refpurpose> + <refdescription> + <para> + The book options are set to <literal>a4paper,10pt,twoside,openright</literal> by default. + These are the intermediate options to be passed to <literal>\documentclass</literal>, + between the common options and the pdftex/dvips options. + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.documentclass.book">a4paper,10pt,twoside,openright</xsl:param> + + <doc:param name="latex.documentclass.pdftex" xmlns=""> + <refpurpose> DB2LaTeX document class options for pdfTeX output</refpurpose> + <refdescription> + <para> + The pdfTeX options are empty by default. + These are the last options to be passed to <literal>\documentclass</literal> + and override the common/article/book options. + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.documentclass.pdftex"></xsl:param> + + <doc:param name="latex.documentclass.dvips" xmlns=""> + <refpurpose> DB2LaTeX document class options for dvips output</refpurpose> + <refdescription> + <para> + The dvips options are empty by default. + These are the last options to be passed to <literal>\documentclass</literal> + and override the common/article/book options. + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.documentclass.dvips"></xsl:param> + + <doc:param name="latex.admonition.path" xmlns=""> + <refpurpose> LaTeX location for admonition graphics </refpurpose> + <refdescription> + <para>The file path that will be passed to LaTeX in order to find admonition graphics.</para> + <para>An empty value suppresses the use of admonition graphics.</para> + <para>If your figures are in <quote>the current directory</quote> then use a value of + <quote>.</quote> (i.e. the full stop or period on its own) to signify this.</para> + </refdescription> + </doc:param> + <xsl:param name="latex.admonition.path">figures</xsl:param> + + + <doc:param name="latex.admonition.imagesize" xmlns=""> + <refpurpose> DB2LaTeX graphics admonitions size</refpurpose> + <refdescription> + <para> + Is passed as an optional parameter for <literal>\includegraphics</literal> and + can take on any such legal values (or be empty). + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.admonition.imagesize">width=1cm</xsl:param> + + + <!-- + <xsl:param name="latex.chapter.label">1</xsl:param> + + <doc:param name="latex.chapter.hypertarget" xmlns=""> + <refpurpose> Hypertarget Chapters </refpurpose> + <refdescription> + <para> + </para> + </refdescription> + </doc:param> + <xsl:param name="latex.chapter.hypertarget">1</xsl:param> + --> + + + <doc:param name="latex.biblio.output" xmlns=""> + <refpurpose> Control which references are cited in the bibliography </refpurpose> + <refdescription> + <para> + The DB2LaTeX generated bibliography (bibitems) may either + include all biblioentries found in the document, or only thee ones explicitly + cited with <sgmltag class="element">citation</sgmltag>. + </para> + <para>Two values are possible: <quote>all</quote> or <quote>cited</quote>.</para> + </refdescription> + </doc:param> + <xsl:param name="latex.biblio.output">all</xsl:param> + + + <doc:param name="latex.bibfiles" xmlns=""> + <refpurpose> + Control the output of the \bibliography{.bib}. + </refpurpose> + <refdescription> + <para>The value of this parameter is output.</para> + <para>An example is <quote><filename>citations.bib</filename></quote>, + if your BibTeX file has that name.</para> + </refdescription> + </doc:param> + <xsl:param name="latex.bibfiles"></xsl:param> + + + <doc:param name="latex.bibwidelabel" xmlns=""> + <refpurpose> Adjust bibliography formatting </refpurpose> + <refdescription> + <para>The environment bibliography accepts a parameter that indicates + the widest label, which is used to correctly format the bibliography + output. The value of this parameter is output inside the + <literal>\begin{thebibliography[]}</literal> LaTeX command.</para> + </refdescription> + </doc:param> + <xsl:param name="latex.bibwidelabel">WIDELABEL</xsl:param> + + <!-- + <xsl:variable name="latex.dont.label">0</xsl:variable> + <xsl:variable name="latex.dont.hypertarget">0</xsl:variable> + --> + + <doc:param name="latex.use.ucs" xmlns=""> + <refpurpose> Choose whether to use the <productname>unicode</productname> LaTeX package</refpurpose> + <refdescription><para>See the <productname>unicode</productname> documentation for details.</para></refdescription> + </doc:param> + <xsl:param name="latex.use.ucs">0</xsl:param> + + <doc:param name="latex.ucs.options" xmlns=""> + <refpurpose>Select the optional parameter(s) for the <productname>unicode</productname> LaTeX package</refpurpose> + <refdescription><para>See the <productname>unicode</productname> documentation for details.</para></refdescription> + </doc:param> + <xsl:param name="latex.ucs.options"></xsl:param> + + <doc:param name="latex.babel.language" xmlns=""> + <refpurpose>Select the optional parameter for the <productname>babel</productname> LaTeX package</refpurpose> + <refdescription><para>See the <productname>babel</productname> documentation for details.</para></refdescription> + </doc:param> + <xsl:param name="latex.babel.language">french</xsl:param> + + <doc:param name="latex.use.isolatin1" xmlns=""> + <refpurpose>Toggle the use of the <productname>isolatin1</productname> LaTeX package</refpurpose> + </doc:param> + <xsl:variable name="latex.use.isolatin1">1</xsl:variable> + + <doc:param name="latex.use.hyperref" xmlns=""> + <refpurpose>Toggle the use of the <productname>hyperref</productname> LaTeX package</refpurpose> + <refdescription><para>This is used extensively for hyperlinking within documents.</para></refdescription> + </doc:param> + <xsl:variable name="latex.use.hyperref">1</xsl:variable> + + <doc:param name="latex.use.fancybox" xmlns=""> + <refpurpose>Toggle the use of the <productname>fancybox</productname> LaTeX package</refpurpose> + <refdescription><para>This is essential for admonitions.</para></refdescription> + </doc:param> + <xsl:variable name="latex.use.fancybox">1</xsl:variable> + + <doc:param name="latex.use.fancyvrb" xmlns=""> + <refpurpose>Toggle the use of the <productname>fancyvrb</productname> LaTeX package</refpurpose> + <refdescription><para>Provides support for tabbed whitespace in verbatim environments. + See also <xref linkend="param.latex.fancyvrb.tabsize"/>.</para></refdescription> + </doc:param> + <xsl:param name="latex.use.fancyvrb">1</xsl:param> + + <doc:param name="latex.fancyvrb.tabsize" xmlns=""> + <refpurpose>Choose indentation for tabs in verbatim environments</refpurpose> + <refdescription><para>When <xref linkend="param.latex.use.fancyvrb"/> is enabled, + this variable sets the width of a tab in terms of an equivalent number of spaces.</para></refdescription> + </doc:param> + <xsl:param name="latex.fancyvrb.tabsize">3</xsl:param> + + <doc:param name="latex.use.fancyhdr" xmlns=""> + <refpurpose>Toggle the use of the <productname>fancyhdr</productname> LaTeX package</refpurpose> + <refdescription><para>Provides page headers and footers. Disabling support for + this package will make headers and footer go away.</para></refdescription> + </doc:param> + <xsl:param name="latex.use.fancyhdr">1</xsl:param> + + <doc:param name="latex.use.parskip" xmlns=""> + <refpurpose>Toggle the use of the <productname>parskip</productname> LaTeX package</refpurpose> + <refdescription><para>Support a <quote>block</quote> paragraph style as opposed to + <quote>indented</quote>.</para></refdescription> + </doc:param> + <xsl:param name="latex.use.parskip">0</xsl:param> + + <doc:param name="latex.use.subfigure" xmlns=""> + <refpurpose>Toggle the use of the <productname>subfigure</productname> LaTeX package</refpurpose> + <refdescription><para>Used to provide nice layout of multiple mediaobjects in figures.</para></refdescription> + </doc:param> + <xsl:param name="latex.use.subfigure">1</xsl:param> + + <doc:param name="latex.use.rotating" xmlns=""> + <refpurpose>Toggle the use of the <productname>rotating</productname> LaTeX package</refpurpose> + </doc:param> + <xsl:param name="latex.use.rotating">1</xsl:param> + + <doc:param name="latex.use.tabularx" xmlns=""> + <refpurpose>Toggle the use of the <productname>tabularx</productname> LaTeX package</refpurpose> + <refdescription><para>Used to provide certain table features. Has some incompatabilities + with packages, but also solves some conflicts that the regular tabular + environment has.</para></refdescription> + </doc:param> + <xsl:param name="latex.use.tabularx">1</xsl:param> + + <doc:param name="latex.use.umoline" xmlns=""> + <refpurpose>Toggle the use of the <productname>umoline</productname> LaTeX package</refpurpose> + <refdescription><para>Provide underlining.</para></refdescription> + </doc:param> + <xsl:param name="latex.use.umoline">0</xsl:param> + + <doc:param name="latex.use.url" xmlns=""> + <refpurpose>Toggle the use of the <productname>url</productname> LaTeX package</refpurpose> + <refdescription><para>Provide partial support for hyperlinks.</para></refdescription> + </doc:param> + <xsl:param name="latex.use.url">1</xsl:param> + + <doc:param name="latex.use.makeidx" xmlns=""> + <refpurpose>Toggle the use of the <productname>makeidx</productname> LaTeX package</refpurpose> + <refdescription><para>Support index generation.</para></refdescription> + </doc:param> + <xsl:param name="latex.use.makeidx">1</xsl:param> + + <doc:param name="latex.hyphenation.tttricks" xmlns=""> + <refpurpose> DB2LaTeX hyphenation linebreak tricks </refpurpose> + <refdescription> + <para> + Usually, LaTeX does not perform hyphenation in <quote>teletype</quote> (monospace) + text. This can lead to formatting problems. But certain monospace texts, such as + URLs and filenames, have <quote>natural</quote> breakpoints such as full stops + and slashes. DB2LaTeX's <quote>tttricks</quote> exploit a hyphenation trick in + order to provide line wrapping in the middle of monospace text. Set this to '1' + to enable these tricks (they are not enabled by default). See also the FAQ. + </para> + </refdescription> + </doc:param> + <xsl:variable name="latex.hyphenation.tttricks">0</xsl:variable> + + <doc:param name="latex.hyperref.param.common" xmlns=""> + <refpurpose> DB2LaTeX hyperref options</refpurpose> + <refdescription> + <para> + The hyperref options are set to <literal>bookmarksnumbered,colorlinks,backref, bookmarks, breaklinks, linktocpage</literal> by default. + You may wish to specify additional options using <literal>latex.hyperref.param.pdftex</literal> + or <literal>latex.hyperref.param.dvips</literal>. + </para> + </refdescription> + </doc:param> + <xsl:variable name="latex.hyperref.param.common">bookmarksnumbered,colorlinks,backref, bookmarks, breaklinks, linktocpage</xsl:variable> + + <doc:param name="latex.hyperref.param.pdftex" xmlns=""> + <refpurpose> DB2LaTeX hyperref options for pdfTeX output</refpurpose> + <refdescription> + <para> + This variable is empty by default. See the hyperref documentation for further information. + </para> + </refdescription> + </doc:param> + <xsl:variable name="latex.hyperref.param.pdftex">pdfstartview=FitH</xsl:variable> + + <doc:param name="latex.hyperref.param.dvips" xmlns=""> + <refpurpose> DB2LaTeX hyperref options for dvips output</refpurpose> + <refdescription> + <para> + This variable is empty by default. See the hyperref documentation for further information. + </para> + </refdescription> + </doc:param> + <xsl:variable name="latex.hyperref.param.dvips"></xsl:variable> + + <xsl:variable name="latex.fancyhdr.lh">Left Header</xsl:variable> + <xsl:variable name="latex.fancyhdr.ch">Center Header</xsl:variable> + <xsl:variable name="latex.fancyhdr.rh">Right Header</xsl:variable> + <xsl:variable name="latex.fancyhdr.lf">Left Footer</xsl:variable> + <xsl:variable name="latex.fancyhdr.cf">Center Footer</xsl:variable> + <xsl:variable name="latex.fancyhdr.rf">Right Footer</xsl:variable> + + <doc:param name="latex.step.title.style" xmlns=""> + <refpurpose> Control the style of step titles </refpurpose> + <refdescription> + <para>Step titles are typeset in small caps but if + this option is set to a LaTeX command, such as <literal>\itshape{}</literal>, then + that command will precede the title and it will be typeset accordingly.</para> + </refdescription> + </doc:param> + <xsl:variable name="latex.step.title.style">\bf</xsl:variable> + + <doc:param name="latex.book.article.title.style" xmlns=""> + <refpurpose> Control the style of article titles within books </refpurpose> + <refdescription> + </refdescription> + </doc:param> + <xsl:variable name="latex.book.article.title.style">\Large\textbf</xsl:variable> + + <doc:param name="latex.article.title.style" xmlns=""> + <refpurpose> Control the style of article titles </refpurpose> + <refdescription> + </refdescription> + </doc:param> + <xsl:variable name="latex.article.title.style">\textbf</xsl:variable> + + <doc:param name="latex.pagestyle" xmlns=""> + <refpurpose> Override DB2LaTeX's choice of LaTeX page numbering style </refpurpose> + <refdescription> + <para>By default, DB2LaTeX will choose the 'plain' or 'fancy' page styles, + depending on <xref linkend="param.latex.use.fancyhdr"/>. If non-empty, this + variable overrides the automatic selection. An example would be the literal + string 'empty', to eliminate headers and page numbers.</para> + </refdescription> + </doc:param> + <xsl:variable name="latex.pagestyle"></xsl:variable> + + <doc:param name="latex.procedure.title.style" xmlns=""> + <refpurpose> Control the style of procedure titles </refpurpose> + <refdescription> + <para>Procedure titles are typeset in small caps but if + this option is set to a LaTeX command, such as <literal>\itshape{}</literal>, then + that command will precede the title and it will be typeset accordingly.</para> + </refdescription> + </doc:param> + <xsl:variable name="latex.procedure.title.style">\sc</xsl:variable> + + <doc:param name="latex.figure.title.style" xmlns=""> + <refpurpose> Control the style of figure titles </refpurpose> + <refdescription> + <para>Figure titles are typeset in the default typeface (usually 'roman') but if + this option is set to a LaTeX command, such as <literal>\itshape{}</literal>, then + that command will precede the title and it will be typeset accordingly.</para> + </refdescription> + </doc:param> + <xsl:variable name="latex.figure.title.style"></xsl:variable> + + <doc:param name="latex.pdf.support" xmlns=""> + <refpurpose> Controls the output of LaTeX commands to support the generation + of PDF files.</refpurpose> + <refdescription> + <para>If this parameter is set to 1, the stylesheets generate code to + detect if it is either <literal>latex</literal> or <literal>pdflatex</literal> + the shell command that is being used to compile the LaTeX text file. Some + packages (<literal>graphicx</literal>, <literal>hyperref</literal>) are used + with the right parameters. Finally, the graphic extensions declared, to use in + <literal>\includegraphics</literal> commands depends also on which command is + being used. If this parameter is set to zero, such code is not generated (which + does not mean that the file cannot compile with pdflatex, but some strange issues + may appear). <emphasis>DEFAULT: 1</emphasis> Only more code is generated. + </para> + </refdescription> + </doc:param> + <xsl:variable name="latex.pdf.support">1</xsl:variable> + + + + <doc:param name="latex.thead.row.entry" xmlns=""> + <refpurpose> Format the output of tabular headings. </refpurpose> + <refdescription> + </refdescription> + </doc:param> + <xsl:template name="latex.thead.row.entry"> + <xsl:apply-templates/> + </xsl:template> + + + + <doc:param name="latex.math.support" xmlns=""> + <refpurpose> Controls the output of LaTeX packages and commands to support + documents with math commands and environments..</refpurpose> + <refdescription> + <para>If this parameter is set to 1, the stylesheets generate code to + <emphasis>DEFAULT: 1</emphasis> Only more code is generated. + </para> + </refdescription> + </doc:param> + <xsl:variable name="latex.math.support">1</xsl:variable> + + + + <doc:param name="latex.output.revhistory" xmlns=""> + <refpurpose> Controls if the revision history table is generated as the first document + table. + </refpurpose> + <refdescription> + <para>If this parameter is set to 1, the stylesheets generate code to + <emphasis>DEFAULT: 1</emphasis> Only more code is generated. + </para> + </refdescription> + </doc:param> + <xsl:variable name="latex.output.revhistory">1</xsl:variable> + + + + + <xsl:variable name="latex.book.preamble.pre"> + </xsl:variable> + + <xsl:variable name="latex.book.preamble.post"> + </xsl:variable> + + <doc:param name="latex.book.varsets" xmlns=""> + <refpurpose> + All purpose commands to change text width, height, counters, etc. + Defaults to a two-sided margin layout. + </refpurpose> + <refdescription> + </refdescription> + </doc:param> + <xsl:variable name="latex.book.varsets"> + <xsl:text>\usepackage{anysize} </xsl:text> + <xsl:text>\marginsize{3cm}{2cm}{1.25cm}{1.25cm} </xsl:text> + </xsl:variable> + + <doc:param name="latex.book.begindocument" xmlns=""> + <refpurpose> + Begin document command + </refpurpose> + <refdescription> + </refdescription> + </doc:param> + <xsl:variable name="latex.book.begindocument"> + <xsl:text>\begin{document} </xsl:text> + </xsl:variable> + + + + + + <doc:param name="latex.book.afterauthor" xmlns=""> + <refpurpose> + LaTeX code that is output after the author (e.g. + <literal>\makeindex, \makeglossary</literal> + </refpurpose> + <refdescription> + </refdescription> + </doc:param> + <xsl:variable name="latex.book.afterauthor"> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>\makeindex </xsl:text> + <xsl:text>\makeglossary </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + </xsl:variable> + + + + + <doc:param name="latex.book.end" xmlns=""> + <refpurpose> + LaTeX code that is output at the end of the document + <literal>\end{document}</literal> + </refpurpose> + <refdescription> + </refdescription> + </doc:param> + <xsl:variable name="latex.book.end"> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>% End of document </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>\end{document} </xsl:text> + </xsl:variable> + + + + <!--############################################################################# + | XSL VARIABLES FOR ARTICLES + |- ############################################################################# + | $Author: ab $ + | + + ############################################################################## --> + + + + <xsl:variable name="latex.article.preamble.pre"> + </xsl:variable> + + <xsl:variable name="latex.article.preamble.post"> + </xsl:variable> + + <doc:param name="latex.article.begindocument" xmlns=""> + <refpurpose> The begin document </refpurpose> + <refdescription>The value of this variable is output from the article template + <xref linkend="template.article"/> after the author command. The default value + (shown below) is just the begin document command. Users of the XSL LaTeX + stylesheet may override this parameter in order to output what they want. + </refdescription> + <refreturn><literal>\begin{document}</literal></refreturn> + </doc:param> + <xsl:variable name="latex.article.begindocument"> + <xsl:text>\begin{document} </xsl:text> + </xsl:variable> + + + <doc:param name="latex.article.varsets" xmlns=""> + <refpurpose> Controls what is output after the LaTeX preamble. </refpurpose> + <refdescription> + <para>Default values decrease edge margins and allow a large quantity of figures to be set on each page. </para> + </refdescription> + </doc:param> + + <xsl:variable name="latex.article.varsets"> + <xsl:text> + \usepackage{anysize} + \marginsize{2cm}{2cm}{2cm}{2cm} + \renewcommand\floatpagefraction{.9} + \renewcommand\topfraction{.9} + \renewcommand\bottomfraction{.9} + \renewcommand\textfraction{.1} + </xsl:text> + </xsl:variable> + + + + + <doc:param name="latex.maketitle" xmlns=""> + <refpurpose> The <literal>\maketitle</literal> for books and articles. </refpurpose> + <refdescription> + <para>Some users may wish to override or eliminate <literal>\maketitle</literal>.</para> + <note><para>Does not apply to <sgmltag class="element">article</sgmltag>s within <sgmltag class="element">book</sgmltag>s.</para></note> + <para>By default, uses LaTeX <literal>\maketitle</literal> with the 'empty' pagestyle + for the first page. The page style of subsequent pages is determined by + <xref linkend="template.generate.latex.pagestyle"/>.</para> + </refdescription> + </doc:param> + <xsl:variable name="latex.maketitle"> + <xsl:text>{\maketitle</xsl:text> + <xsl:call-template name="generate.latex.pagestyle"/> + <xsl:text>\thispagestyle{empty}} </xsl:text> + </xsl:variable> + + + <doc:param name="latex.article.end" xmlns=""> + <refpurpose> Controls what is output at the end of the article. Basically the <literal>\end{document}</literal> + command, with some markup comments. </refpurpose> + <refdescription> + </refdescription> + </doc:param> + <xsl:variable name="latex.article.end"> + <xsl:text> </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>% End of document </xsl:text> + <xsl:text>% -------------------------------------------- </xsl:text> + <xsl:text>\end{document} </xsl:text> + </xsl:variable> + + + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/db2latex/verbatim.mod.xsl b/docs/docbook/xslt/db2latex/verbatim.mod.xsl new file mode 100644 index 0000000000..a5bb09099a --- /dev/null +++ b/docs/docbook/xslt/db2latex/verbatim.mod.xsl @@ -0,0 +1,147 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: verbatim.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="verbatim" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: verbatim.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <author> <firstname>Ramon</firstname> <surname>Casellas</surname> </author> + <author> <firstname>James</firstname> <surname>Devenish</surname> </author> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + <title>Verbatim <filename>verbatim.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + <!--############################################################################# --> + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="literal" xmlns=""> + <refpurpose>Template for <sgmltag>literal</sgmltag></refpurpose> + <refdescription> + Template for literal template + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="literal" mode="latex.verbatim"> + <xsl:text>{\verb </xsl:text> + <xsl:apply-templates mode="latex.verbatim"/> + <xsl:text>}</xsl:text> + </xsl:template> + + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template name="verbatim.apply.templates" xmlns=""> + <refpurpose> Auxiliary template to output verbatim LaTeX code in verbatim mode </refpurpose> + <refdescription> + <para> Takes into account whether the user is using fancyvrb or not. It allows + veratim line numbering and other fancy stuff. </para> + <para> In order to use a small or large font, you may also wanto to use + the <literal>role</literal> attribute : </para> + <screen><![CDATA[ + <programlisting role="small"> + </programlisting> + <programlisting role="large"> + </programlisting> + ]]></screen> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template name="verbatim.apply.templates"> + <xsl:choose> + <xsl:when test="ancestor::entry"> + <xsl:message>Problem with <xsl:value-of select="local-name(.)"/> inside table entries.</xsl:message> + <xsl:text>\texttt{</xsl:text> + <xsl:apply-templates mode="latex.verbatim"/> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:when test="$latex.use.fancyvrb='1'"> + <xsl:variable name="not_monospaced" select="local-name(.)='literallayout' and @format!='monospaced'"/> + <xsl:text> \begin{Verbatim}[</xsl:text> + <xsl:if test="@linenumbering='numbered'"> + <xsl:text>,numbers=left</xsl:text> + </xsl:if> + <xsl:if test="$not_monospaced"> + <xsl:text>,fontfamily=default</xsl:text> + </xsl:if> + <xsl:if test="@role"> + <xsl:choose> + <xsl:when test="@role='small'"> + <xsl:text>,fontsize=\small</xsl:text> + </xsl:when> + <xsl:when test="@role='large'"> + <xsl:text>,fontsize=\large</xsl:text> + </xsl:when> + </xsl:choose> + </xsl:if> + <xsl:text>] </xsl:text> + <xsl:choose> + <xsl:when test="$not_monospaced"> + <!-- Needs to be changed to cope with regular characterset! --> + <xsl:apply-templates mode="latex.verbatim"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates mode="latex.verbatim"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text> \end{Verbatim} </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text> \begin{verbatim} </xsl:text> + <xsl:apply-templates mode="latex.verbatim"/> + <xsl:text> \end{verbatim} </xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + <xsl:template match="address"> + <xsl:call-template name="verbatim.apply.templates"/> + </xsl:template> + + <doc:template name="verbatim" match="screen|programlisting|literallayout" xmlns=""> + <refpurpose>Environments in which whitespace is significant</refpurpose> + <refdescription> + <itemizedlist> + <title>Known Bugs</title> + <listitem><simpara>Templates are not applied within programlistings.</simpara></listitem> + </itemizedlist> + </refdescription> + </doc:template> + <xsl:template match="screen|programlisting|literallayout"> + <xsl:call-template name="verbatim.apply.templates"/> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/db2latex/xref.mod.xsl b/docs/docbook/xslt/db2latex/xref.mod.xsl new file mode 100644 index 0000000000..ecd03153cb --- /dev/null +++ b/docs/docbook/xslt/db2latex/xref.mod.xsl @@ -0,0 +1,660 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: xref.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: Manage XREFs ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + +<!--############################################################################# --> +<!-- DOCUMENTATION --> +<doc:reference id="xref" xmlns=""> +<referenceinfo> +<releaseinfo role="meta"> +$Id: xref.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +</releaseinfo> +<authorgroup> +<author> <surname>Casellas</surname><firstname>Ramon</firstname> </author> +<author> <surname>James</surname><firstname>Devenish</firstname> </author> +</authorgroup> +<copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> +</copyright> +</referenceinfo> + +<title>Xref, Cross References <filename>xref.mod.xsl</filename></title> +<partintro> +<section><title>Introduction</title> +<para></para> +</section> +</partintro> +</doc:reference> + + + + +<!--############################################################################# --> +<doc:template match="anchor" xmlns=""> + <refpurpose>Anchor XSL template</refpurpose> + <refdescription> + <para>The <sgmltag>anchor</sgmltag> element + The DB2LaTeX processing of the element is quite straightforward : + Map to a <literal>\label</literal>.</para> + </refdescription> +</doc:template> +<!--############################################################################# --> + + <xsl:template match="anchor"> + <xsl:text>\hypertarget{</xsl:text> + <xsl:value-of select="@id"/> + <xsl:text>}{}</xsl:text> + </xsl:template> + + + + + +<!--############################################################################# --> +<doc:template name="id.is.xrefed" xmlns=""> + <refpurpose>Auxiliary named template</refpurpose> + <refdescription> + <para>This template returns 1 if there exists somewhere an xref + whose linkend is the target's id.</para> + </refdescription> +</doc:template> +<!--############################################################################# --> + + <xsl:template name="id.is.xrefed"> + <xsl:param name="i" select="1"/> + <xsl:param name="target" select="."/> + <xsl:param name="xrefs" select="//xref"/> + <xsl:choose> + <xsl:when test="xrefs[i]/@linkend = 'target/@id'"> + <xsl:value-of select="1"/> + </xsl:when> + <xsl:when test="i = count(xrefs)"> + <xsl:value-of select="0"/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="id.is.xrefed"> + <xsl:with-param name="i" select="i+1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + + +<!--############################################################################# --> +<doc:template name="xref.xreflabel" xmlns=""> + <refpurpose>Auxiliary named template</refpurpose> + <refdescription> + <para> Called to process an xreflabel...you might use this to make + xreflabels come out in the right font for different targets, + for example.</para> + </refdescription> +</doc:template> +<!--############################################################################# --> + + <xsl:template name="xref.xreflabel"> + <xsl:param name="target" select="."/> + <xsl:value-of select="$target/@xreflabel"/> + </xsl:template> + + + + + + +<!--############################################################################# --> +<doc:template match="xref|link" xmlns=""> + <refpurpose>Xref and Link XSL Template</refpurpose> + <refdescription> + </refdescription> +</doc:template> +<!--############################################################################# --> + + <xsl:template match="xref|link"> + <xsl:variable name="targets" select="id(@linkend)"/> + <xsl:variable name="target" select="$targets[1]"/> + <xsl:variable name="refelem" select="local-name($target)"/> + <xsl:call-template name="check.id.unique"><xsl:with-param name="linkend" select="@linkend"/></xsl:call-template> + <xsl:choose> + <xsl:when test="$refelem=''"> + <xsl:message><xsl:text>XRef to nonexistent id: </xsl:text><xsl:value-of select="@linkend"/></xsl:message> + <xsl:text>XrefId[?</xsl:text> + <xsl:if test="local-name(.)='link'"><xsl:apply-templates/></xsl:if> + <xsl:text>?]</xsl:text> + </xsl:when> + + <!-- This is a link with content ... --> + <xsl:when test="local-name(.)='link' and .!=''"> + <xsl:call-template name="generate.hyperlink"> + <xsl:with-param name="target" select="$target"/> + <xsl:with-param name="text"><xsl:apply-templates/></xsl:with-param> + </xsl:call-template> + </xsl:when> + + <xsl:otherwise> + <xsl:choose> + <xsl:when test="@endterm"> + <xsl:variable name="etargets" select="id(@endterm)"/> + <xsl:variable name="etarget" select="$etargets[1]"/> + <xsl:choose> + <xsl:when test="count($etarget) = 0"> + <xsl:message> + <xsl:value-of select="count($etargets)"/> + <xsl:text>Endterm points to nonexistent ID: </xsl:text> + <xsl:value-of select="@endterm"/> + </xsl:message> + <xsl:text>[NONEXISTENT ID]</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.hyperlink"> + <xsl:with-param name="target" select="$target"/> + <xsl:with-param name="text"><xsl:apply-templates select="$etarget" mode="xref.text"/></xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <!-- If an xreflabel has been specified for the target ... --> + <xsl:when test="local-name(.)='xref' and $target/@xreflabel"> + <xsl:call-template name="generate.hyperlink"> + <xsl:with-param name="target" select="$target"/> + <xsl:with-param name="text"> + <xsl:text>{[</xsl:text> + <xsl:call-template name="xref.xreflabel"> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + <xsl:text>]}</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.hyperlink"> + <xsl:with-param name="target" select="$target"/> + <xsl:with-param name="text"><xsl:apply-templates select="$target" mode="xref-to"/></xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="$insert.xref.page.number=1 and $refelem!='' and local-name(.)='xref'"> + <xsl:call-template name="xref.p.subst"> + <xsl:with-param name="string"> + <xsl:call-template name="gentext.xref.text"> + <xsl:with-param name="element.name" select="'page.citation'"/> + <xsl:with-param name="default"> [%p]</xsl:with-param> + </xsl:call-template> + </xsl:with-param> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:if> + </xsl:template> + + <doc:template name="generate.hyperlink" xmlns=""> + <refpurpose> Choose hyperlink syntax </refpurpose> + <refdescription> + <para>Will use hyperref, if it is available. Otherwise, just outputs + unlinked text. If the destination is a citation, a backreference is + emitted (even though it is technically a hyperlink, not a citation). + If the 'text' arises from an @endterm, then the 'optional argument' + syntax of <literal>\cite</literal> is used.</para> + </refdescription> + </doc:template> + <xsl:template name="generate.hyperlink"> + <xsl:param name="target"/> + <xsl:param name="text"/> + <xsl:variable name="element" select="local-name($target)"/> + <xsl:variable name="citation" select="$element='biblioentry' or $element='bibliomixed'"/> + <xsl:choose> + <xsl:when test="$citation and @endterm!=''"> + <xsl:text>\docbooktolatexcite</xsl:text> + <xsl:text>{</xsl:text> + <xsl:value-of select="$target/@id"/> + <xsl:text>}{</xsl:text> + <xsl:call-template name="scape-optionalarg"> + <xsl:with-param name="string" select="$text"/> + </xsl:call-template> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:if test="$latex.use.hyperref=1"> + <xsl:text>\hyperlink{</xsl:text> + <xsl:value-of select="$target/@id"/> + <xsl:text>}</xsl:text> + </xsl:if> + <xsl:text>{</xsl:text> + <xsl:if test="$citation"> + <xsl:text>\docbooktolatexbackcite{</xsl:text> + <xsl:value-of select="$target/@id"/> + <xsl:text>}</xsl:text> + </xsl:if> + <xsl:value-of select="$text"/> + <xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <doc:template name="xref.p.subst" xmlns=""> + <refpurpose>Insert page number into xrefs</refpurpose> + <refdescription><para></para></refdescription> + </doc:template> + <xsl:template name="xref.p.subst"> + <xsl:param name="string"></xsl:param> + <xsl:param name="target" select="."/> + <xsl:variable name="subst">%p</xsl:variable> + <xsl:choose> + <xsl:when test="contains($string, $subst)"> + <xsl:value-of select="substring-before($string, $subst)"/> + <xsl:text>\pageref*{</xsl:text> + <xsl:value-of select="$target/@id"/> + <xsl:text>}</xsl:text> + <xsl:value-of select="substring-after($string, $subst)"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$string"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + + + + +<!--############################################################################# --> +<doc:template name="number.xref" xmlns=""> + <refpurpose>Numbering template</refpurpose> + <refdescription> + <para> + Let LaTeX manage the numbering. Otherwise sty files that + do specify another numberic (e.g I,II) get messed + </para> + </refdescription> +</doc:template> +<!--############################################################################# --> + + <xsl:template name="number.xref"> + <xsl:text>{\ref*{</xsl:text><xsl:value-of select="@id"/><xsl:text>}}</xsl:text> + </xsl:template> + + + + + + + + +<!--############################################################################# --> +<doc:template name="cross-reference" xmlns=""> + <refpurpose>FIXME</refpurpose> + <refdescription> + <para> + FIXME + </para> + </refdescription> +</doc:template> +<!--############################################################################# --> + + <xsl:template name="cross-reference"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:param name="xref.text"> + <xsl:call-template name="gentext.xref.text"> + <xsl:with-param name="element.name" select="$refelem"/> + <xsl:with-param name="default">%g %n</xsl:with-param> + </xsl:call-template> + </xsl:param> + <xsl:call-template name="subst.xref.text"> + <xsl:with-param name="xref.text" select="$xref.text"/> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:template> + + + + + + <xsl:template match="*" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:message> + <xsl:text>[Don't know what gentext to create for xref to: "</xsl:text> + <xsl:value-of select="$refelem"/> + <xsl:text>"]</xsl:text> + </xsl:message> + <xsl:text>UNKGENTEXT</xsl:text><xsl:value-of select="$refelem"/> + </xsl:template> + + + + + + <xsl:template match="formalpara" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:call-template name="cross-reference"> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:template> + + + <xsl:template match="figure|example|table|equation" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:call-template name="cross-reference"> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:template> + + + <xsl:template match="dedication|preface|part|chapter|appendix" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:call-template name="cross-reference"> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:template> + + <xsl:template match="cmdsynopsis" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:variable name="command" select="($target//command)[1]"/> + <xsl:apply-templates select="$command" mode="xref"/> + </xsl:template> + + <xsl:template match="funcsynopsis" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:variable name="func" select="($target//function)[1]"/> + <xsl:apply-templates select="$func" mode="xref"/> + </xsl:template> + + + <xsl:template match="biblioentry" mode="xref-to"> + <!-- handles both biblioentry and bibliomixed --> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:text>[</xsl:text> + <xsl:choose> + <xsl:when test="local-name($target/*[1]) = 'abbrev'"> + <xsl:apply-templates select="$target/*[1]"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="@id"/> + </xsl:otherwise> + </xsl:choose> + <xsl:text>]</xsl:text> + </xsl:template> + + + + <xsl:template match="bibliography|glossary|index" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:call-template name="cross-reference"> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:template> + + + <xsl:template match="section|simplesect + |sect1|sect2|sect3|sect4|sect5 + |refsect1|refsect2|refsect3" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:call-template name="cross-reference"> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:template> + + <xsl:template match="question|answer" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:call-template name="cross-reference"> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:template> + + <xsl:template match="reference" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:call-template name="cross-reference"> + <xsl:with-param name="target" select="$target"/> + </xsl:call-template> + </xsl:template> + + <xsl:template match="co" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:apply-templates select="$target" mode="callout-bug"/> + </xsl:template> + + <xsl:template match="co" mode="conumber"> + <xsl:number from="literallayout|programlisting|screen|synopsis" + level="single" + format="1"/> + </xsl:template> + + + <xsl:template match="book" mode="xref-to"> + <xsl:param name="target" select="."/> + <xsl:param name="refelem" select="local-name($target)"/> + <xsl:variable name="title"> + <xsl:choose> + <xsl:when test="$target/title"> + <xsl:apply-templates select="$target/title" mode="xref"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="$target/bookinfo/title" mode="xref"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:text>{\em </xsl:text> <xsl:copy-of select="$title"/> <xsl:text>}</xsl:text> + </xsl:template> + + + <xsl:template match="command" mode="xref"> + <xsl:call-template name="inline.boldseq"/> + </xsl:template> + + <xsl:template match="function" mode="xref"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + + + +<!--############################################################################# --> +<doc:template match="ulink" xmlns=""> + <refpurpose>A link that addresses its target by means of a URL (Uniform Resource Locator)</refpurpose> + <refdescription> + <formalpara> + <title>Pertinent Variables</title> + <itemizedlist> + <listitem><simpara><xref linkend="param.ulink.show"/></simpara></listitem> + <listitem><simpara><xref linkend="param.ulink.footnotes"/></simpara></listitem> + <listitem><simpara><xref linkend="latex.hyphenation.tttricks"/></simpara></listitem> + </itemizedlist> + </formalpara> + </refdescription> +</doc:template> +<!--############################################################################# --> + + + <xsl:template match="ulink" name="ulink"> + <xsl:param name="hyphenation">\docbookhyphenateurl</xsl:param> + <xsl:param name="url" select="@url"/> + <xsl:choose> + <xsl:when test=". = '' or . = $url"> + <xsl:call-template name="generate.typeset.url"> + <xsl:with-param name="hyphenation" select="$hyphenation"/> + <xsl:with-param name="url" select="$url"/> + </xsl:call-template> + </xsl:when> + <xsl:when test="$latex.use.tabularx=1 and count(ancestor::table)>0"> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + <xsl:call-template name="generate.typeset.url"> + <xsl:with-param name="hyphenation" select="$hyphenation"/> + <xsl:with-param name="url" select="$url"/> + </xsl:call-template> + </xsl:when> + <xsl:when test="$ulink.footnotes='1' or $ulink.show='1'"> + <xsl:apply-templates/> + <xsl:if test="$ulink.footnotes='1' and count(ancestor::footnote)=0"> + <xsl:call-template name="footnote"> + <xsl:with-param name="hyphenation" select="$hyphenation"/> + <xsl:with-param name="url" select="$url"/> + </xsl:call-template> + </xsl:if> + <xsl:if test="$ulink.show='1' or ($ulink.footnotes='1' and ancestor::footnote)"> + <xsl:text> </xsl:text> + <xsl:call-template name="generate.typeset.url"> + <xsl:with-param name="hyphenation" select="$hyphenation"/> + <xsl:with-param name="url" select="$url"/> + </xsl:call-template> + </xsl:if> + </xsl:when> + <xsl:otherwise> + <xsl:text>\href{</xsl:text> + <xsl:call-template name="scape-href"> + <xsl:with-param name="string" select="$url"/> + </xsl:call-template> + <xsl:text>}</xsl:text> + <xsl:text>{</xsl:text> + <xsl:apply-templates/> + <xsl:text>}</xsl:text><!-- End Of second argument of \href --> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + +<!--############################################################################# --> +<doc:template match="olink" xmlns=""> + <refpurpose>OLink XSL template</refpurpose> + <refdescription> + <para></para> + </refdescription> +</doc:template> +<!--############################################################################# --> + + <xsl:template match="olink"> + <xsl:apply-templates/> + </xsl:template> + + + + + + + +<!--############################################################################# --> + <xsl:template name="title.xref"> + <xsl:param name="target" select="."/> + <xsl:choose> + <xsl:when test="name($target) = 'figure' + or name($target) = 'example' + or name($target) = 'equation' + or name($target) = 'table' + or name($target) = 'dedication' + or name($target) = 'preface' + or name($target) = 'bibliography' + or name($target) = 'glossary' + or name($target) = 'index' + or name($target) = 'setindex' + or name($target) = 'colophon'"> + <xsl:call-template name="gentext.startquote"/> + <xsl:apply-templates select="$target" mode="title.content"/> + <xsl:call-template name="gentext.endquote"/> + </xsl:when> + <xsl:otherwise> + <xsl:text>{\em </xsl:text><xsl:apply-templates select="$target" mode="title.content"/><xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + +<!--############################################################################# --> + <xsl:template match="title" mode="xref"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="command" mode="xref"> + <xsl:call-template name="inline.boldseq"/> + </xsl:template> + + <xsl:template match="function" mode="xref"> + <xsl:call-template name="inline.monoseq"/> + </xsl:template> + + <xsl:template name="generate.typeset.url"> + <xsl:param name="hyphenation"/> + <xsl:param name="url" select="@url"/> + <xsl:choose> + <xsl:when test="$latex.use.url='1'"> + <xsl:text>\url{</xsl:text> + <xsl:value-of select="$url"/> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\href{</xsl:text> + <xsl:call-template name="scape-href"> + <xsl:with-param name="string" select="$url"/> + </xsl:call-template> + <xsl:text>}{\texttt{</xsl:text> + <xsl:call-template name="generate.string.url"> + <xsl:with-param name="hyphenation" select="$hyphenation"/> + <xsl:with-param name="string" select="$url"/> + </xsl:call-template> + <xsl:text>}}</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + +<!--############################################################################# --> + <doc:template name="generate.string.url" xmlns=""> + <refpurpose>Escape and hyphenate a string as a teletype URL.</refpurpose> + <refdescription> + <para> + This template typsets teletype text using slash.hyphen if + $latex.hyphenation.tttricks is disabled. + Has two parameters: 'hyphenation' and 'string'. + </para> + </refdescription> + </doc:template> +<!--############################################################################# --> + <xsl:template name="generate.string.url"> + <xsl:param name="hyphenation" /> + <xsl:param name="string" /> + <xsl:param name="url" select="$string"/> + <xsl:choose> + <xsl:when test="$latex.hyphenation.tttricks=1"> + <xsl:value-of select="$hyphenation" /> + <xsl:text>{</xsl:text> + <xsl:call-template name="normalize-scape"><xsl:with-param name="string" select="$string"/></xsl:call-template> + <xsl:text>}</xsl:text> + </xsl:when> + <xsl:otherwise> + <!-- LaTeX chars are scaped. Each / except the :// is mapped to a /\- --> + <xsl:call-template name="scape.slash.hyphen"><xsl:with-param name="string" select="$url"/></xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/figures/caution.eps b/docs/docbook/xslt/figures/caution.eps new file mode 100644 index 0000000000..0c10b371b1 --- /dev/null +++ b/docs/docbook/xslt/figures/caution.eps @@ -0,0 +1 @@ +%!PS-Adobe-2.0 EPSF-1.2
%%Title: Untitled-3
%%Creator: FreeHand 9.0
%%CreationDate: 2002/12/05 8:20 PM
%%BoundingBox: 0 0 29 29
%%FHPathName:Untitled:FreeHand 9:English:Untitled-3
%ALDOriginalFile:Untitled:FreeHand 9:English:Untitled-3
%ALDBoundingBox: -2 -2 29 29
%%FHPageNum:1
%%DocumentSuppliedResources: procset Altsys_header 4 0
%%ColorUsage: Color
%%DocumentProcessColors: Black
%%EndComments
%%BeginResource: procset Altsys_header 4 0
userdict begin /AltsysDict 300 dict def end
AltsysDict begin
/bdf{bind def}bind def
/xdf{exch def}bdf
/defed{where{pop true}{false}ifelse}bdf
/ndf{1 index where{pop pop pop}{dup xcheck{bind}if def}ifelse}bdf
/d{setdash}bdf
/h{closepath}bdf
/H{}bdf
/J{setlinecap}bdf
/j{setlinejoin}bdf
/M{setmiterlimit}bdf
/n{newpath}bdf
/N{newpath}bdf
/q{gsave}bdf
/Q{grestore}bdf
/w{setlinewidth}bdf
/Xic{matrix invertmatrix concat}bdf
/Xq{matrix currentmatrix mark}bdf
/XQ{cleartomark setmatrix}bdf
/sepdef{
dup where not
{
AltsysSepDict
}
if
3 1 roll exch put
}bdf
/st{settransfer}bdf
/colorimage defed /_rci xdf
/cntr 0 def
/readbinarystring{
/cntr 0 def
2 copy readstring
{
{
dup
(\034) search
{
length exch pop exch
dup length 0 ne
{
dup dup 0 get 32 sub 0 exch put
/cntr cntr 1 add def
}
{
pop 1 string dup
0 6 index read pop 32 sub put
}ifelse
3 copy
putinterval pop
1 add
1 index length 1 sub
1 index sub
dup 0 le {pop pop exit}if
getinterval
}
{
pop exit
} ifelse
} loop
}if
cntr 0 gt
{
pop 2 copy
dup length cntr sub cntr getinterval
readbinarystring
} if
pop exch pop
} bdf
/_NXLevel2 defed {
_NXLevel2 not {
/colorimage where {
userdict eq {
/_rci false def
} if
} if
} if
} if
/md defed{
md type /dicttype eq {
/colorimage where {
md eq {
/_rci false def
}if
}if
/settransfer where {
md eq {
/st systemdict /settransfer get def
}if
}if
}if
}if
/setstrokeadjust defed
{
true setstrokeadjust
/C{curveto}bdf
/L{lineto}bdf
/m{moveto}bdf
}
{
/dr{transform .25 sub round .25 add
exch .25 sub round .25 add exch itransform}bdf
/C{dr curveto}bdf
/L{dr lineto}bdf
/m{dr moveto}bdf
/setstrokeadjust{pop}bdf
}ifelse
/privrectpath {
4 -2 roll m
dtransform round exch round exch idtransform
2 copy 0 lt exch 0 lt xor
{dup 0 exch rlineto exch 0 rlineto neg 0 exch rlineto}
{exch dup 0 rlineto exch 0 exch rlineto neg 0 rlineto}
ifelse
closepath
}bdf
/rectclip{newpath privrectpath clip newpath}def
/rectfill{gsave newpath privrectpath fill grestore}def
/rectstroke{gsave newpath privrectpath stroke grestore}def
/_fonthacksave false def
/currentpacking defed
{
/_bfh {/_fonthacksave currentpacking def false setpacking} bdf
/_efh {_fonthacksave setpacking} bdf
}
{
/_bfh {} bdf
/_efh {} bdf
}ifelse
/packedarray{array astore readonly}ndf
/`
{
false setoverprint
/-save0- save def
5 index concat
pop
storerect left bottom width height rectclip
pop
/MMdict_count countdictstack def
/MMop_count count 1 sub def
userdict begin
/showpage {} def
0 setgray 0 setlinecap 1 setlinewidth
0 setlinejoin 10 setmiterlimit [] 0 setdash newpath
} bdf
/currentpacking defed{true setpacking}if
/min{2 copy gt{exch}if pop}bdf
/max{2 copy lt{exch}if pop}bdf
/xformfont { currentfont exch makefont setfont } bdf
/fhnumcolors 1
statusdict begin
/processcolors defed
{
pop processcolors
}
{
/deviceinfo defed {
deviceinfo /Colors known {
pop deviceinfo /Colors get
} if
} if
} ifelse
end
def
/printerRes
gsave
matrix defaultmatrix setmatrix
72 72 dtransform
abs exch abs
max
grestore
def
/graycalcs
[
{Angle Frequency}
{GrayAngle GrayFrequency}
{0 Width Height matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
{0 GrayWidth GrayHeight matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
] def
/calcgraysteps {
forcemaxsteps
{
maxsteps
}
{
/currenthalftone defed
{currenthalftone /dicttype eq}{false}ifelse
{
currenthalftone begin
HalftoneType 4 le
{graycalcs HalftoneType 1 sub get exec}
{
HalftoneType 5 eq
{
Default begin
{graycalcs HalftoneType 1 sub get exec}
end
}
{0 60}
ifelse
}
ifelse
end
}
{
currentscreen pop exch
}
ifelse
printerRes 300 max exch div exch
2 copy
sin mul round dup mul
3 1 roll
cos mul round dup mul
add 1 add
dup maxsteps gt {pop maxsteps} if
dup minsteps lt {pop minsteps} if
}
ifelse
} bdf
/nextrelease defed {
/languagelevel defed not {
/framebuffer defed {
0 40 string framebuffer 9 1 roll 8 {pop} repeat
dup 516 eq exch 520 eq or
{
/fhnumcolors 3 def
/currentscreen {60 0 {pop pop 1}}bdf
/calcgraysteps {maxsteps} bdf
}if
}if
}if
}if
fhnumcolors 1 ne {
/calcgraysteps {maxsteps} bdf
} if
/currentpagedevice defed {
currentpagedevice /PreRenderingEnhance known
{
currentpagedevice /PreRenderingEnhance get
{
/calcgraysteps
{
forcemaxsteps
{maxsteps}
{256 maxsteps min}
ifelse
} def
} if
} if
} if
/gradfrequency 144 def
printerRes 1000 lt {
/gradfrequency 72 def
} if
/adjnumsteps {
dup dtransform abs exch abs max
printerRes div
gradfrequency mul
round
5 max
min
}bdf
/goodsep {
spots exch get 4 get dup sepname eq exch (_vc_Registration) eq or
}bdf
/BeginGradation defed
{/bb{BeginGradation}bdf}
{/bb{}bdf}
ifelse
/EndGradation defed
{/eb{EndGradation}bdf}
{/eb{}bdf}
ifelse
/bottom -0 def
/delta -0 def
/frac -0 def
/height -0 def
/left -0 def
/numsteps1 -0 def
/radius -0 def
/right -0 def
/top -0 def
/width -0 def
/xt -0 def
/yt -0 def
/df currentflat def
/tempstr 1 string def
/clipflatness currentflat def
/inverted?
0 currenttransfer exec .5 ge def
/tc1 [0 0 0 1] def
/tc2 [0 0 0 1] def
/storerect{/top xdf /right xdf /bottom xdf /left xdf
/width right left sub def /height top bottom sub def}bdf
/concatprocs{
systemdict /packedarray known
{dup type /packedarraytype eq 2 index type /packedarraytype eq or}{false}ifelse
{
/proc2 exch cvlit def /proc1 exch cvlit def
proc1 aload pop proc2 aload pop
proc1 length proc2 length add packedarray cvx
}
{
/proc2 exch cvlit def /proc1 exch cvlit def
/newproc proc1 length proc2 length add array def
newproc 0 proc1 putinterval newproc proc1 length proc2 putinterval
newproc cvx
}ifelse
}bdf
/i{dup 0 eq
{pop df dup}
{dup} ifelse
/clipflatness xdf setflat
}bdf
version cvr 38.0 le
{/setrgbcolor{
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
setrgbcolor}bdf}if
/vms {/vmsv save def} bdf
/vmr {vmsv restore} bdf
/vmrs{vmsv restore /vmsv save def}bdf
/eomode{
{/filler /eofill load def /clipper /eoclip load def}
{/filler /fill load def /clipper /clip load def}
ifelse
}bdf
/normtaper{}bdf
/logtaper{9 mul 1 add log}bdf
/CD{
/NF exch def
{
exch dup
/FID ne 1 index/UniqueID ne and
{exch NF 3 1 roll put}
{pop pop}
ifelse
}forall
NF
}bdf
/MN{
1 index length
/Len exch def
dup length Len add
string dup
Len
4 -1 roll
putinterval
dup
0
4 -1 roll
putinterval
}bdf
/RC{4 -1 roll /ourvec xdf 256 string cvs(|______)anchorsearch
{1 index MN cvn/NewN exch def cvn
findfont dup maxlength dict CD dup/FontName NewN put dup
/Encoding ourvec put NewN exch definefont pop}{pop}ifelse}bdf
/RF{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RC}
ifelse
}bdf
/FF{dup 256 string cvs(|______)exch MN cvn dup FontDirectory exch known
{exch pop findfont 3 -1 roll pop}
{pop dup findfont dup maxlength dict CD dup dup
/Encoding exch /Encoding get 256 array copy 7 -1 roll
{3 -1 roll dup 4 -2 roll put}forall put definefont}
ifelse}bdf
/RCJ{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFJ
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFJ{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCJ}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFJ
{
dup
hasfont
not
{
pop
/Ryumin-Light-83pv-RKSJ-H
hasfont
{
/Ryumin-Light-83pv-RKSJ-H
}
{
/Courier
}
ifelse
}
if
}bdf
/FFJ{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFJ
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/GS {
dup
hasfont
{
findfont
exch makesetfont
exch
pop
ts
}
{
pop pop pop
ts
} ifelse
} bdf
/RCK{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFK
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFK{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCK}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFK
{
dup
hasfont
not
{
pop
/JCsm
hasfont
{
/JCsm
}
{
/Courier
}
ifelse
}
if
}bdf
/FFK{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFK
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/RCTC{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFTC
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFTC{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCTC}
ifelse
}bdf
/FDFTC
{
dup
hasfont
not
{
pop
/DFMing-Lt-HK-BF
hasfont
{
/DFMing-Lt-HK-BF
}
{
/Courier
}
ifelse
}
if
}bdf
/FFTC{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFTC
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/fps{
currentflat
exch
dup 0 le{pop 1}if
{
dup setflat 3 index stopped
{1.3 mul dup 3 index gt{pop setflat pop pop stop}if}
{exit}
ifelse
}loop
pop setflat pop pop
}bdf
/fp{100 currentflat fps}bdf
/clipper{clip}bdf
/W{/clipper load 100 clipflatness dup setflat fps}bdf
userdict begin /BDFontDict 29 dict def end
BDFontDict begin
/bu{}def
/bn{}def
/setTxMode{av 70 ge{pop}if pop}def
/gm{m}def
/show{pop}def
/gr{pop}def
/fnt{pop pop pop}def
/fs{pop}def
/fz{pop}def
/lin{pop pop}def
/:M {pop pop} def
/sf {pop} def
/S {pop} def
/@b {pop pop pop pop pop pop pop pop} def
/_bdsave /save load def
/_bdrestore /restore load def
/save { dup /fontsave eq {null} {_bdsave} ifelse } def
/restore { dup null eq { pop } { _bdrestore } ifelse } def
/fontsave null def
end
/MacVec 256 array def
MacVec 0 /Helvetica findfont
/Encoding get 0 128 getinterval putinterval
MacVec 127 /DEL put MacVec 16#27 /quotesingle put MacVec 16#60 /grave put
/NUL/SOH/STX/ETX/EOT/ENQ/ACK/BEL/BS/HT/LF/VT/FF/CR/SO/SI
/DLE/DC1/DC2/DC3/DC4/NAK/SYN/ETB/CAN/EM/SUB/ESC/FS/GS/RS/US
MacVec 0 32 getinterval astore pop
/Adieresis/Aring/Ccedilla/Eacute/Ntilde/Odieresis/Udieresis/aacute
/agrave/acircumflex/adieresis/atilde/aring/ccedilla/eacute/egrave
/ecircumflex/edieresis/iacute/igrave/icircumflex/idieresis/ntilde/oacute
/ograve/ocircumflex/odieresis/otilde/uacute/ugrave/ucircumflex/udieresis
/dagger/degree/cent/sterling/section/bullet/paragraph/germandbls
/registered/copyright/trademark/acute/dieresis/notequal/AE/Oslash
/infinity/plusminus/lessequal/greaterequal/yen/mu/partialdiff/summation
/product/pi/integral/ordfeminine/ordmasculine/Omega/ae/oslash
/questiondown/exclamdown/logicalnot/radical/florin/approxequal/Delta/guillemotleft
/guillemotright/ellipsis/nbspace/Agrave/Atilde/Otilde/OE/oe
/endash/emdash/quotedblleft/quotedblright/quoteleft/quoteright/divide/lozenge
/ydieresis/Ydieresis/fraction/currency/guilsinglleft/guilsinglright/fi/fl
/daggerdbl/periodcentered/quotesinglbase/quotedblbase
/perthousand/Acircumflex/Ecircumflex/Aacute
/Edieresis/Egrave/Iacute/Icircumflex/Idieresis/Igrave/Oacute/Ocircumflex
/apple/Ograve/Uacute/Ucircumflex/Ugrave/dotlessi/circumflex/tilde
/macron/breve/dotaccent/ring/cedilla/hungarumlaut/ogonek/caron
MacVec 128 128 getinterval astore pop
/findheaderfont {
/Helvetica findfont
} def
end %. AltsysDict
%%EndResource
%%EndProlog
%%BeginSetup
AltsysDict begin
_bfh
_efh
end %. AltsysDict
%%EndSetup
AltsysDict begin
/onlyk4{false}ndf
/ccmyk{dup 5 -1 roll sub 0 max exch}ndf
/cmyk2gray{
4 -1 roll 0.3 mul 4 -1 roll 0.59 mul 4 -1 roll 0.11 mul
add add add 1 min neg 1 add
}bdf
/setcmykcolor{1 exch sub ccmyk ccmyk ccmyk pop setrgbcolor}ndf
/maxcolor {
max max max
} ndf
/maxspot {
pop
} ndf
/setcmykcoloroverprint{4{dup -1 eq{pop 0}if 4 1 roll}repeat setcmykcolor}ndf
/findcmykcustomcolor{5 packedarray}ndf
/setcustomcolor{exch aload pop pop 4{4 index mul 4 1 roll}repeat setcmykcolor pop}ndf
/setseparationgray{setgray}ndf
/setoverprint{pop}ndf
/currentoverprint false ndf
/cmykbufs2gray{
0 1 2 index length 1 sub
{
4 index 1 index get 0.3 mul
4 index 2 index get 0.59 mul
4 index 3 index get 0.11 mul
4 index 4 index get
add add add cvi 255 min
255 exch sub
2 index 3 1 roll put
}for
4 1 roll pop pop pop
}bdf
/colorimage{
pop pop
[
5 -1 roll/exec cvx
6 -1 roll/exec cvx
7 -1 roll/exec cvx
8 -1 roll/exec cvx
/cmykbufs2gray cvx
]cvx
image
}
%. version 47.1 on Linotronic of Postscript defines colorimage incorrectly (rgb model only)
version cvr 47.1 le
statusdict /product get (Lino) anchorsearch{pop pop true}{pop false}ifelse
and{userdict begin bdf end}{ndf}ifelse
fhnumcolors 1 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
ic im iy ik cmyk2gray /xt xdf
currenttransfer
{dup 1.0 exch sub xt mul add}concatprocs
st
image
}
ifelse
}ndf
fhnumcolors 1 ne {yt restore} if
fhnumcolors 3 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
1.0 dup ic ik add min sub
1.0 dup im ik add min sub
1.0 dup iy ik add min sub
/ic xdf /iy xdf /im xdf
currentcolortransfer
4 1 roll
{dup 1.0 exch sub ic mul add}concatprocs 4 1 roll
{dup 1.0 exch sub iy mul add}concatprocs 4 1 roll
{dup 1.0 exch sub im mul add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}true 3 colorimage
}
ifelse
}ndf
fhnumcolors 3 ne {yt restore} if
fhnumcolors 4 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
currentcolortransfer
{1.0 exch sub ik mul ik sub 1 add}concatprocs 4 1 roll
{1.0 exch sub iy mul iy sub 1 add}concatprocs 4 1 roll
{1.0 exch sub im mul im sub 1 add}concatprocs 4 1 roll
{1.0 exch sub ic mul ic sub 1 add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}{dummy}
true 4 colorimage
}
ifelse
}ndf
fhnumcolors 4 ne {yt restore} if
/separationimage{image}ndf
/spotascmyk false ndf
/newcmykcustomcolor{6 packedarray}ndf
/inkoverprint false ndf
/setinkoverprint{pop}ndf
/setspotcolor {
spots exch get
dup 4 get (_vc_Registration) eq
{pop 1 exch sub setseparationgray}
{0 5 getinterval exch setcustomcolor}
ifelse
}ndf
/currentcolortransfer{currenttransfer dup dup dup}ndf
/setcolortransfer{st pop pop pop}ndf
/fas{}ndf
/sas{}ndf
/fhsetspreadsize{pop}ndf
/filler{fill}bdf
/F{gsave {filler}fp grestore}bdf
/f{closepath F}bdf
/S{gsave {stroke}fp grestore}bdf
/s{closepath S}bdf
userdict /islevel2
systemdict /languagelevel known dup
{
pop systemdict /languagelevel get 2 ge
} if
put
islevel2 not
{
/currentcmykcolor
{
0 0 0 1 currentgray sub
} ndf
} if
/tc
{
gsave
setcmykcolor currentcmykcolor
grestore
} bind def
/testCMYKColorThrough
{
tc add add add 0 ne
} bind def
/fhiscomposite where not {
userdict /fhiscomposite
islevel2
{
gsave 1 1 1 1 setcmykcolor currentcmykcolor grestore
add add add 4 eq
}
{
1 0 0 0 testCMYKColorThrough
0 1 0 0 testCMYKColorThrough
0 0 1 0 testCMYKColorThrough
0 0 0 1 testCMYKColorThrough
and and and
} ifelse
put
}
{ pop }
ifelse
/bc4 [0 0 0 0] def
/_lfp4 {
1 pop
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
height abs adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
taperfcn /frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/bcs [0 0] def
/_lfs4 {
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
height abs adjnumsteps
dup 2 lt {pop 2} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 div taperfcn /frac xdf
bcs 0
1.0 tint2 tint1 sub frac mul tint1 add sub
put bcs vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfs6 {
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bcs 0
tint2 tint1 sub frac mul tint1 add
put bcs vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfp6 {
1 pop
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/lfp4{_lfp4}ndf
/lfs4{_lfs4}ndf
/rfs6{_rfs6}ndf
/rfp6{_rfp6}ndf
/cvc [0 0 0 1] def
/vc{
AltsysDict /cvc 2 index put
aload length dup 4 eq
{pop dup -1 eq{pop setrgbcolor}{setcmykcolor}ifelse}
{6 eq {sethexcolor} {setspotcolor} ifelse }
ifelse
}bdf
0 setseparationgray
/imgr {1692.47 1570.59 1723.65 1601.77 } def
/bleed 0 def
/clpr {1692.47 1570.59 1723.65 1601.77 } def
/xs 1 def
/ys 1 def
/botx 0 def
/overlap 0 def
/wdist 18 def
0 2 mul fhsetspreadsize
0 0 ne {/df 0 def /clipflatness 0 def} if
/maxsteps 256 def
/forcemaxsteps false def
/minsteps 0 def
userdict begin /AGDOrigMtx matrix currentmatrix def end
vms
-1694 -1572 translate
/currentpacking defed{false setpacking}if
/spots[
1 0 0 0 (Process Cyan) false newcmykcustomcolor
0 1 0 0 (Process Magenta) false newcmykcustomcolor
0 0 1 0 (Process Yellow) false newcmykcustomcolor
0 0 0 1 (Process Black) false newcmykcustomcolor
]def
n
[] 0 d
3.863708 M
1 w
0 j
0 J
false setoverprint
0 i
false eomode
[0 0 0 1]vc
vms
q
[1 0 0 1 -249.981674 -586.867554] concat
vms
1946.9506 2177.5114 m
1954.4907 2185.0516 L
1956.7047 2187.2656 1960.2943 2187.2656 1962.5083 2185.0516 C
1970.0485 2177.5114 L
1972.2625 2175.2974 1972.2625 2171.7078 1970.0485 2169.4938 C
1962.5083 2161.9537 L
1960.2943 2159.7396 1956.7047 2159.7396 1954.4907 2161.9537 C
1946.9506 2169.4938 L
1944.7365 2171.7078 1944.7365 2175.2974 1946.9506 2177.5114 C
s
n
true eomode
1958.5469 2181.0039 m
1959.2148 2181.0039 1959.7012 2180.9296 1960.0059 2180.7813 C
1960.3142 2180.6326 1960.4684 2180.363 1960.4688 2179.9727 C
1960.4688 2179.7383 1960.3398 2178.8026 1960.082 2177.166 C
1959.0742 2170.4219 L
1958.9373 2170.3241 1958.7615 2170.2754 1958.5469 2170.2754 C
1958.3319 2170.2754 1958.1561 2170.3241 1958.0195 2170.4219 C
1957.0117 2177.166 L
1956.7539 2178.8026 1956.625 2179.7379 1956.625 2179.9727 C
1956.625 2180.363 1956.7792 2180.6326 1957.0879 2180.7813 C
1957.4003 2180.9296 1957.8866 2181.0035 1958.5469 2181.0039 C
h
1958.5469 2165.166 m
1958.0389 2165.166 1957.5878 2165.3499 1957.1934 2165.7168 C
1956.7986 2166.0837 1956.6016 2166.5485 1956.6016 2167.1113 C
1956.6016 2167.6698 1956.7891 2168.1404 1957.1641 2168.5234 C
1957.5427 2168.9102 1958.0038 2169.1035 1958.5469 2169.1035 C
1959.1094 2169.1035 1959.5741 2168.9043 1959.9414 2168.5059 C
1960.3083 2168.1074 1960.4918 2167.6423 1960.4922 2167.1113 C
1960.4922 2166.748 1960.4102 2166.4177 1960.2461 2166.1211 C
1960.082 2165.8241 1959.8513 2165.5916 1959.5547 2165.4238 C
1959.2577 2165.2521 1958.9219 2165.1664 1958.5469 2165.166 C
true setoverprint
f
false setoverprint
n
vmr
Q
false eomode
vmr
vmr
end
%%Trailer
\ No newline at end of file diff --git a/docs/docbook/xslt/figures/caution.pdf b/docs/docbook/xslt/figures/caution.pdf Binary files differnew file mode 100644 index 0000000000..a0afabfa23 --- /dev/null +++ b/docs/docbook/xslt/figures/caution.pdf diff --git a/docs/docbook/xslt/figures/important.eps b/docs/docbook/xslt/figures/important.eps new file mode 100644 index 0000000000..0c10b371b1 --- /dev/null +++ b/docs/docbook/xslt/figures/important.eps @@ -0,0 +1 @@ +%!PS-Adobe-2.0 EPSF-1.2
%%Title: Untitled-3
%%Creator: FreeHand 9.0
%%CreationDate: 2002/12/05 8:20 PM
%%BoundingBox: 0 0 29 29
%%FHPathName:Untitled:FreeHand 9:English:Untitled-3
%ALDOriginalFile:Untitled:FreeHand 9:English:Untitled-3
%ALDBoundingBox: -2 -2 29 29
%%FHPageNum:1
%%DocumentSuppliedResources: procset Altsys_header 4 0
%%ColorUsage: Color
%%DocumentProcessColors: Black
%%EndComments
%%BeginResource: procset Altsys_header 4 0
userdict begin /AltsysDict 300 dict def end
AltsysDict begin
/bdf{bind def}bind def
/xdf{exch def}bdf
/defed{where{pop true}{false}ifelse}bdf
/ndf{1 index where{pop pop pop}{dup xcheck{bind}if def}ifelse}bdf
/d{setdash}bdf
/h{closepath}bdf
/H{}bdf
/J{setlinecap}bdf
/j{setlinejoin}bdf
/M{setmiterlimit}bdf
/n{newpath}bdf
/N{newpath}bdf
/q{gsave}bdf
/Q{grestore}bdf
/w{setlinewidth}bdf
/Xic{matrix invertmatrix concat}bdf
/Xq{matrix currentmatrix mark}bdf
/XQ{cleartomark setmatrix}bdf
/sepdef{
dup where not
{
AltsysSepDict
}
if
3 1 roll exch put
}bdf
/st{settransfer}bdf
/colorimage defed /_rci xdf
/cntr 0 def
/readbinarystring{
/cntr 0 def
2 copy readstring
{
{
dup
(\034) search
{
length exch pop exch
dup length 0 ne
{
dup dup 0 get 32 sub 0 exch put
/cntr cntr 1 add def
}
{
pop 1 string dup
0 6 index read pop 32 sub put
}ifelse
3 copy
putinterval pop
1 add
1 index length 1 sub
1 index sub
dup 0 le {pop pop exit}if
getinterval
}
{
pop exit
} ifelse
} loop
}if
cntr 0 gt
{
pop 2 copy
dup length cntr sub cntr getinterval
readbinarystring
} if
pop exch pop
} bdf
/_NXLevel2 defed {
_NXLevel2 not {
/colorimage where {
userdict eq {
/_rci false def
} if
} if
} if
} if
/md defed{
md type /dicttype eq {
/colorimage where {
md eq {
/_rci false def
}if
}if
/settransfer where {
md eq {
/st systemdict /settransfer get def
}if
}if
}if
}if
/setstrokeadjust defed
{
true setstrokeadjust
/C{curveto}bdf
/L{lineto}bdf
/m{moveto}bdf
}
{
/dr{transform .25 sub round .25 add
exch .25 sub round .25 add exch itransform}bdf
/C{dr curveto}bdf
/L{dr lineto}bdf
/m{dr moveto}bdf
/setstrokeadjust{pop}bdf
}ifelse
/privrectpath {
4 -2 roll m
dtransform round exch round exch idtransform
2 copy 0 lt exch 0 lt xor
{dup 0 exch rlineto exch 0 rlineto neg 0 exch rlineto}
{exch dup 0 rlineto exch 0 exch rlineto neg 0 rlineto}
ifelse
closepath
}bdf
/rectclip{newpath privrectpath clip newpath}def
/rectfill{gsave newpath privrectpath fill grestore}def
/rectstroke{gsave newpath privrectpath stroke grestore}def
/_fonthacksave false def
/currentpacking defed
{
/_bfh {/_fonthacksave currentpacking def false setpacking} bdf
/_efh {_fonthacksave setpacking} bdf
}
{
/_bfh {} bdf
/_efh {} bdf
}ifelse
/packedarray{array astore readonly}ndf
/`
{
false setoverprint
/-save0- save def
5 index concat
pop
storerect left bottom width height rectclip
pop
/MMdict_count countdictstack def
/MMop_count count 1 sub def
userdict begin
/showpage {} def
0 setgray 0 setlinecap 1 setlinewidth
0 setlinejoin 10 setmiterlimit [] 0 setdash newpath
} bdf
/currentpacking defed{true setpacking}if
/min{2 copy gt{exch}if pop}bdf
/max{2 copy lt{exch}if pop}bdf
/xformfont { currentfont exch makefont setfont } bdf
/fhnumcolors 1
statusdict begin
/processcolors defed
{
pop processcolors
}
{
/deviceinfo defed {
deviceinfo /Colors known {
pop deviceinfo /Colors get
} if
} if
} ifelse
end
def
/printerRes
gsave
matrix defaultmatrix setmatrix
72 72 dtransform
abs exch abs
max
grestore
def
/graycalcs
[
{Angle Frequency}
{GrayAngle GrayFrequency}
{0 Width Height matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
{0 GrayWidth GrayHeight matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
] def
/calcgraysteps {
forcemaxsteps
{
maxsteps
}
{
/currenthalftone defed
{currenthalftone /dicttype eq}{false}ifelse
{
currenthalftone begin
HalftoneType 4 le
{graycalcs HalftoneType 1 sub get exec}
{
HalftoneType 5 eq
{
Default begin
{graycalcs HalftoneType 1 sub get exec}
end
}
{0 60}
ifelse
}
ifelse
end
}
{
currentscreen pop exch
}
ifelse
printerRes 300 max exch div exch
2 copy
sin mul round dup mul
3 1 roll
cos mul round dup mul
add 1 add
dup maxsteps gt {pop maxsteps} if
dup minsteps lt {pop minsteps} if
}
ifelse
} bdf
/nextrelease defed {
/languagelevel defed not {
/framebuffer defed {
0 40 string framebuffer 9 1 roll 8 {pop} repeat
dup 516 eq exch 520 eq or
{
/fhnumcolors 3 def
/currentscreen {60 0 {pop pop 1}}bdf
/calcgraysteps {maxsteps} bdf
}if
}if
}if
}if
fhnumcolors 1 ne {
/calcgraysteps {maxsteps} bdf
} if
/currentpagedevice defed {
currentpagedevice /PreRenderingEnhance known
{
currentpagedevice /PreRenderingEnhance get
{
/calcgraysteps
{
forcemaxsteps
{maxsteps}
{256 maxsteps min}
ifelse
} def
} if
} if
} if
/gradfrequency 144 def
printerRes 1000 lt {
/gradfrequency 72 def
} if
/adjnumsteps {
dup dtransform abs exch abs max
printerRes div
gradfrequency mul
round
5 max
min
}bdf
/goodsep {
spots exch get 4 get dup sepname eq exch (_vc_Registration) eq or
}bdf
/BeginGradation defed
{/bb{BeginGradation}bdf}
{/bb{}bdf}
ifelse
/EndGradation defed
{/eb{EndGradation}bdf}
{/eb{}bdf}
ifelse
/bottom -0 def
/delta -0 def
/frac -0 def
/height -0 def
/left -0 def
/numsteps1 -0 def
/radius -0 def
/right -0 def
/top -0 def
/width -0 def
/xt -0 def
/yt -0 def
/df currentflat def
/tempstr 1 string def
/clipflatness currentflat def
/inverted?
0 currenttransfer exec .5 ge def
/tc1 [0 0 0 1] def
/tc2 [0 0 0 1] def
/storerect{/top xdf /right xdf /bottom xdf /left xdf
/width right left sub def /height top bottom sub def}bdf
/concatprocs{
systemdict /packedarray known
{dup type /packedarraytype eq 2 index type /packedarraytype eq or}{false}ifelse
{
/proc2 exch cvlit def /proc1 exch cvlit def
proc1 aload pop proc2 aload pop
proc1 length proc2 length add packedarray cvx
}
{
/proc2 exch cvlit def /proc1 exch cvlit def
/newproc proc1 length proc2 length add array def
newproc 0 proc1 putinterval newproc proc1 length proc2 putinterval
newproc cvx
}ifelse
}bdf
/i{dup 0 eq
{pop df dup}
{dup} ifelse
/clipflatness xdf setflat
}bdf
version cvr 38.0 le
{/setrgbcolor{
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
setrgbcolor}bdf}if
/vms {/vmsv save def} bdf
/vmr {vmsv restore} bdf
/vmrs{vmsv restore /vmsv save def}bdf
/eomode{
{/filler /eofill load def /clipper /eoclip load def}
{/filler /fill load def /clipper /clip load def}
ifelse
}bdf
/normtaper{}bdf
/logtaper{9 mul 1 add log}bdf
/CD{
/NF exch def
{
exch dup
/FID ne 1 index/UniqueID ne and
{exch NF 3 1 roll put}
{pop pop}
ifelse
}forall
NF
}bdf
/MN{
1 index length
/Len exch def
dup length Len add
string dup
Len
4 -1 roll
putinterval
dup
0
4 -1 roll
putinterval
}bdf
/RC{4 -1 roll /ourvec xdf 256 string cvs(|______)anchorsearch
{1 index MN cvn/NewN exch def cvn
findfont dup maxlength dict CD dup/FontName NewN put dup
/Encoding ourvec put NewN exch definefont pop}{pop}ifelse}bdf
/RF{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RC}
ifelse
}bdf
/FF{dup 256 string cvs(|______)exch MN cvn dup FontDirectory exch known
{exch pop findfont 3 -1 roll pop}
{pop dup findfont dup maxlength dict CD dup dup
/Encoding exch /Encoding get 256 array copy 7 -1 roll
{3 -1 roll dup 4 -2 roll put}forall put definefont}
ifelse}bdf
/RCJ{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFJ
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFJ{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCJ}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFJ
{
dup
hasfont
not
{
pop
/Ryumin-Light-83pv-RKSJ-H
hasfont
{
/Ryumin-Light-83pv-RKSJ-H
}
{
/Courier
}
ifelse
}
if
}bdf
/FFJ{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFJ
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/GS {
dup
hasfont
{
findfont
exch makesetfont
exch
pop
ts
}
{
pop pop pop
ts
} ifelse
} bdf
/RCK{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFK
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFK{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCK}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFK
{
dup
hasfont
not
{
pop
/JCsm
hasfont
{
/JCsm
}
{
/Courier
}
ifelse
}
if
}bdf
/FFK{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFK
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/RCTC{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFTC
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFTC{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCTC}
ifelse
}bdf
/FDFTC
{
dup
hasfont
not
{
pop
/DFMing-Lt-HK-BF
hasfont
{
/DFMing-Lt-HK-BF
}
{
/Courier
}
ifelse
}
if
}bdf
/FFTC{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFTC
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/fps{
currentflat
exch
dup 0 le{pop 1}if
{
dup setflat 3 index stopped
{1.3 mul dup 3 index gt{pop setflat pop pop stop}if}
{exit}
ifelse
}loop
pop setflat pop pop
}bdf
/fp{100 currentflat fps}bdf
/clipper{clip}bdf
/W{/clipper load 100 clipflatness dup setflat fps}bdf
userdict begin /BDFontDict 29 dict def end
BDFontDict begin
/bu{}def
/bn{}def
/setTxMode{av 70 ge{pop}if pop}def
/gm{m}def
/show{pop}def
/gr{pop}def
/fnt{pop pop pop}def
/fs{pop}def
/fz{pop}def
/lin{pop pop}def
/:M {pop pop} def
/sf {pop} def
/S {pop} def
/@b {pop pop pop pop pop pop pop pop} def
/_bdsave /save load def
/_bdrestore /restore load def
/save { dup /fontsave eq {null} {_bdsave} ifelse } def
/restore { dup null eq { pop } { _bdrestore } ifelse } def
/fontsave null def
end
/MacVec 256 array def
MacVec 0 /Helvetica findfont
/Encoding get 0 128 getinterval putinterval
MacVec 127 /DEL put MacVec 16#27 /quotesingle put MacVec 16#60 /grave put
/NUL/SOH/STX/ETX/EOT/ENQ/ACK/BEL/BS/HT/LF/VT/FF/CR/SO/SI
/DLE/DC1/DC2/DC3/DC4/NAK/SYN/ETB/CAN/EM/SUB/ESC/FS/GS/RS/US
MacVec 0 32 getinterval astore pop
/Adieresis/Aring/Ccedilla/Eacute/Ntilde/Odieresis/Udieresis/aacute
/agrave/acircumflex/adieresis/atilde/aring/ccedilla/eacute/egrave
/ecircumflex/edieresis/iacute/igrave/icircumflex/idieresis/ntilde/oacute
/ograve/ocircumflex/odieresis/otilde/uacute/ugrave/ucircumflex/udieresis
/dagger/degree/cent/sterling/section/bullet/paragraph/germandbls
/registered/copyright/trademark/acute/dieresis/notequal/AE/Oslash
/infinity/plusminus/lessequal/greaterequal/yen/mu/partialdiff/summation
/product/pi/integral/ordfeminine/ordmasculine/Omega/ae/oslash
/questiondown/exclamdown/logicalnot/radical/florin/approxequal/Delta/guillemotleft
/guillemotright/ellipsis/nbspace/Agrave/Atilde/Otilde/OE/oe
/endash/emdash/quotedblleft/quotedblright/quoteleft/quoteright/divide/lozenge
/ydieresis/Ydieresis/fraction/currency/guilsinglleft/guilsinglright/fi/fl
/daggerdbl/periodcentered/quotesinglbase/quotedblbase
/perthousand/Acircumflex/Ecircumflex/Aacute
/Edieresis/Egrave/Iacute/Icircumflex/Idieresis/Igrave/Oacute/Ocircumflex
/apple/Ograve/Uacute/Ucircumflex/Ugrave/dotlessi/circumflex/tilde
/macron/breve/dotaccent/ring/cedilla/hungarumlaut/ogonek/caron
MacVec 128 128 getinterval astore pop
/findheaderfont {
/Helvetica findfont
} def
end %. AltsysDict
%%EndResource
%%EndProlog
%%BeginSetup
AltsysDict begin
_bfh
_efh
end %. AltsysDict
%%EndSetup
AltsysDict begin
/onlyk4{false}ndf
/ccmyk{dup 5 -1 roll sub 0 max exch}ndf
/cmyk2gray{
4 -1 roll 0.3 mul 4 -1 roll 0.59 mul 4 -1 roll 0.11 mul
add add add 1 min neg 1 add
}bdf
/setcmykcolor{1 exch sub ccmyk ccmyk ccmyk pop setrgbcolor}ndf
/maxcolor {
max max max
} ndf
/maxspot {
pop
} ndf
/setcmykcoloroverprint{4{dup -1 eq{pop 0}if 4 1 roll}repeat setcmykcolor}ndf
/findcmykcustomcolor{5 packedarray}ndf
/setcustomcolor{exch aload pop pop 4{4 index mul 4 1 roll}repeat setcmykcolor pop}ndf
/setseparationgray{setgray}ndf
/setoverprint{pop}ndf
/currentoverprint false ndf
/cmykbufs2gray{
0 1 2 index length 1 sub
{
4 index 1 index get 0.3 mul
4 index 2 index get 0.59 mul
4 index 3 index get 0.11 mul
4 index 4 index get
add add add cvi 255 min
255 exch sub
2 index 3 1 roll put
}for
4 1 roll pop pop pop
}bdf
/colorimage{
pop pop
[
5 -1 roll/exec cvx
6 -1 roll/exec cvx
7 -1 roll/exec cvx
8 -1 roll/exec cvx
/cmykbufs2gray cvx
]cvx
image
}
%. version 47.1 on Linotronic of Postscript defines colorimage incorrectly (rgb model only)
version cvr 47.1 le
statusdict /product get (Lino) anchorsearch{pop pop true}{pop false}ifelse
and{userdict begin bdf end}{ndf}ifelse
fhnumcolors 1 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
ic im iy ik cmyk2gray /xt xdf
currenttransfer
{dup 1.0 exch sub xt mul add}concatprocs
st
image
}
ifelse
}ndf
fhnumcolors 1 ne {yt restore} if
fhnumcolors 3 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
1.0 dup ic ik add min sub
1.0 dup im ik add min sub
1.0 dup iy ik add min sub
/ic xdf /iy xdf /im xdf
currentcolortransfer
4 1 roll
{dup 1.0 exch sub ic mul add}concatprocs 4 1 roll
{dup 1.0 exch sub iy mul add}concatprocs 4 1 roll
{dup 1.0 exch sub im mul add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}true 3 colorimage
}
ifelse
}ndf
fhnumcolors 3 ne {yt restore} if
fhnumcolors 4 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
currentcolortransfer
{1.0 exch sub ik mul ik sub 1 add}concatprocs 4 1 roll
{1.0 exch sub iy mul iy sub 1 add}concatprocs 4 1 roll
{1.0 exch sub im mul im sub 1 add}concatprocs 4 1 roll
{1.0 exch sub ic mul ic sub 1 add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}{dummy}
true 4 colorimage
}
ifelse
}ndf
fhnumcolors 4 ne {yt restore} if
/separationimage{image}ndf
/spotascmyk false ndf
/newcmykcustomcolor{6 packedarray}ndf
/inkoverprint false ndf
/setinkoverprint{pop}ndf
/setspotcolor {
spots exch get
dup 4 get (_vc_Registration) eq
{pop 1 exch sub setseparationgray}
{0 5 getinterval exch setcustomcolor}
ifelse
}ndf
/currentcolortransfer{currenttransfer dup dup dup}ndf
/setcolortransfer{st pop pop pop}ndf
/fas{}ndf
/sas{}ndf
/fhsetspreadsize{pop}ndf
/filler{fill}bdf
/F{gsave {filler}fp grestore}bdf
/f{closepath F}bdf
/S{gsave {stroke}fp grestore}bdf
/s{closepath S}bdf
userdict /islevel2
systemdict /languagelevel known dup
{
pop systemdict /languagelevel get 2 ge
} if
put
islevel2 not
{
/currentcmykcolor
{
0 0 0 1 currentgray sub
} ndf
} if
/tc
{
gsave
setcmykcolor currentcmykcolor
grestore
} bind def
/testCMYKColorThrough
{
tc add add add 0 ne
} bind def
/fhiscomposite where not {
userdict /fhiscomposite
islevel2
{
gsave 1 1 1 1 setcmykcolor currentcmykcolor grestore
add add add 4 eq
}
{
1 0 0 0 testCMYKColorThrough
0 1 0 0 testCMYKColorThrough
0 0 1 0 testCMYKColorThrough
0 0 0 1 testCMYKColorThrough
and and and
} ifelse
put
}
{ pop }
ifelse
/bc4 [0 0 0 0] def
/_lfp4 {
1 pop
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
height abs adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
taperfcn /frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/bcs [0 0] def
/_lfs4 {
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
height abs adjnumsteps
dup 2 lt {pop 2} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 div taperfcn /frac xdf
bcs 0
1.0 tint2 tint1 sub frac mul tint1 add sub
put bcs vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfs6 {
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bcs 0
tint2 tint1 sub frac mul tint1 add
put bcs vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfp6 {
1 pop
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/lfp4{_lfp4}ndf
/lfs4{_lfs4}ndf
/rfs6{_rfs6}ndf
/rfp6{_rfp6}ndf
/cvc [0 0 0 1] def
/vc{
AltsysDict /cvc 2 index put
aload length dup 4 eq
{pop dup -1 eq{pop setrgbcolor}{setcmykcolor}ifelse}
{6 eq {sethexcolor} {setspotcolor} ifelse }
ifelse
}bdf
0 setseparationgray
/imgr {1692.47 1570.59 1723.65 1601.77 } def
/bleed 0 def
/clpr {1692.47 1570.59 1723.65 1601.77 } def
/xs 1 def
/ys 1 def
/botx 0 def
/overlap 0 def
/wdist 18 def
0 2 mul fhsetspreadsize
0 0 ne {/df 0 def /clipflatness 0 def} if
/maxsteps 256 def
/forcemaxsteps false def
/minsteps 0 def
userdict begin /AGDOrigMtx matrix currentmatrix def end
vms
-1694 -1572 translate
/currentpacking defed{false setpacking}if
/spots[
1 0 0 0 (Process Cyan) false newcmykcustomcolor
0 1 0 0 (Process Magenta) false newcmykcustomcolor
0 0 1 0 (Process Yellow) false newcmykcustomcolor
0 0 0 1 (Process Black) false newcmykcustomcolor
]def
n
[] 0 d
3.863708 M
1 w
0 j
0 J
false setoverprint
0 i
false eomode
[0 0 0 1]vc
vms
q
[1 0 0 1 -249.981674 -586.867554] concat
vms
1946.9506 2177.5114 m
1954.4907 2185.0516 L
1956.7047 2187.2656 1960.2943 2187.2656 1962.5083 2185.0516 C
1970.0485 2177.5114 L
1972.2625 2175.2974 1972.2625 2171.7078 1970.0485 2169.4938 C
1962.5083 2161.9537 L
1960.2943 2159.7396 1956.7047 2159.7396 1954.4907 2161.9537 C
1946.9506 2169.4938 L
1944.7365 2171.7078 1944.7365 2175.2974 1946.9506 2177.5114 C
s
n
true eomode
1958.5469 2181.0039 m
1959.2148 2181.0039 1959.7012 2180.9296 1960.0059 2180.7813 C
1960.3142 2180.6326 1960.4684 2180.363 1960.4688 2179.9727 C
1960.4688 2179.7383 1960.3398 2178.8026 1960.082 2177.166 C
1959.0742 2170.4219 L
1958.9373 2170.3241 1958.7615 2170.2754 1958.5469 2170.2754 C
1958.3319 2170.2754 1958.1561 2170.3241 1958.0195 2170.4219 C
1957.0117 2177.166 L
1956.7539 2178.8026 1956.625 2179.7379 1956.625 2179.9727 C
1956.625 2180.363 1956.7792 2180.6326 1957.0879 2180.7813 C
1957.4003 2180.9296 1957.8866 2181.0035 1958.5469 2181.0039 C
h
1958.5469 2165.166 m
1958.0389 2165.166 1957.5878 2165.3499 1957.1934 2165.7168 C
1956.7986 2166.0837 1956.6016 2166.5485 1956.6016 2167.1113 C
1956.6016 2167.6698 1956.7891 2168.1404 1957.1641 2168.5234 C
1957.5427 2168.9102 1958.0038 2169.1035 1958.5469 2169.1035 C
1959.1094 2169.1035 1959.5741 2168.9043 1959.9414 2168.5059 C
1960.3083 2168.1074 1960.4918 2167.6423 1960.4922 2167.1113 C
1960.4922 2166.748 1960.4102 2166.4177 1960.2461 2166.1211 C
1960.082 2165.8241 1959.8513 2165.5916 1959.5547 2165.4238 C
1959.2577 2165.2521 1958.9219 2165.1664 1958.5469 2165.166 C
true setoverprint
f
false setoverprint
n
vmr
Q
false eomode
vmr
vmr
end
%%Trailer
\ No newline at end of file diff --git a/docs/docbook/xslt/figures/important.pdf b/docs/docbook/xslt/figures/important.pdf Binary files differnew file mode 100644 index 0000000000..a0afabfa23 --- /dev/null +++ b/docs/docbook/xslt/figures/important.pdf diff --git a/docs/docbook/xslt/figures/note.eps b/docs/docbook/xslt/figures/note.eps new file mode 100644 index 0000000000..39be23fa77 --- /dev/null +++ b/docs/docbook/xslt/figures/note.eps @@ -0,0 +1,1387 @@ +%!PS-Adobe-2.0 EPSF-1.2 +%%Title: Untitled-1 +%%Creator: FreeHand 9.0 +%%CreationDate: 2002/07/16 10:41 PM +%%BoundingBox: 0 0 27 27 +%%FHPathName:Untitled:FreeHand 9:English:Untitled-1 +%ALDOriginalFile:Untitled:FreeHand 9:English:Untitled-1 +%ALDBoundingBox: -153 -436 442 406 +%%FHPageNum:1 +%%DocumentSuppliedResources: procset Altsys_header 4 0 +%%ColorUsage: Color +%%DocumentProcessColors: Black +%%EndComments +%%BeginResource: procset Altsys_header 4 0 +userdict begin /AltsysDict 300 dict def end +AltsysDict begin +/bdf{bind def}bind def +/xdf{exch def}bdf +/defed{where{pop true}{false}ifelse}bdf +/ndf{1 index where{pop pop pop}{dup xcheck{bind}if def}ifelse}bdf +/d{setdash}bdf +/h{closepath}bdf +/H{}bdf +/J{setlinecap}bdf +/j{setlinejoin}bdf +/M{setmiterlimit}bdf +/n{newpath}bdf +/N{newpath}bdf +/q{gsave}bdf +/Q{grestore}bdf +/w{setlinewidth}bdf +/Xic{matrix invertmatrix concat}bdf +/Xq{matrix currentmatrix mark}bdf +/XQ{cleartomark setmatrix}bdf +/sepdef{ +dup where not +{ +AltsysSepDict +} +if +3 1 roll exch put +}bdf +/st{settransfer}bdf +/colorimage defed /_rci xdf +/cntr 0 def +/readbinarystring{ +/cntr 0 def +2 copy readstring +{ +{ +dup +(\034) search +{ +length exch pop exch +dup length 0 ne +{ +dup dup 0 get 32 sub 0 exch put +/cntr cntr 1 add def +} +{ +pop 1 string dup +0 6 index read pop 32 sub put +}ifelse +3 copy +putinterval pop +1 add +1 index length 1 sub +1 index sub +dup 0 le {pop pop exit}if +getinterval +} +{ +pop exit +} ifelse +} loop +}if +cntr 0 gt +{ +pop 2 copy +dup length cntr sub cntr getinterval +readbinarystring +} if +pop exch pop +} bdf +/_NXLevel2 defed { +_NXLevel2 not { +/colorimage where { +userdict eq { +/_rci false def +} if +} if +} if +} if +/md defed{ +md type /dicttype eq { +/colorimage where { +md eq { +/_rci false def +}if +}if +/settransfer where { +md eq { +/st systemdict /settransfer get def +}if +}if +}if +}if +/setstrokeadjust defed +{ +true setstrokeadjust +/C{curveto}bdf +/L{lineto}bdf +/m{moveto}bdf +} +{ +/dr{transform .25 sub round .25 add +exch .25 sub round .25 add exch itransform}bdf +/C{dr curveto}bdf +/L{dr lineto}bdf +/m{dr moveto}bdf +/setstrokeadjust{pop}bdf +}ifelse +/privrectpath { +4 -2 roll m +dtransform round exch round exch idtransform +2 copy 0 lt exch 0 lt xor +{dup 0 exch rlineto exch 0 rlineto neg 0 exch rlineto} +{exch dup 0 rlineto exch 0 exch rlineto neg 0 rlineto} +ifelse +closepath +}bdf +/rectclip{newpath privrectpath clip newpath}def +/rectfill{gsave newpath privrectpath fill grestore}def +/rectstroke{gsave newpath privrectpath stroke grestore}def +/_fonthacksave false def +/currentpacking defed +{ +/_bfh {/_fonthacksave currentpacking def false setpacking} bdf +/_efh {_fonthacksave setpacking} bdf +} +{ +/_bfh {} bdf +/_efh {} bdf +}ifelse +/packedarray{array astore readonly}ndf +/` +{ +false setoverprint +/-save0- save def +5 index concat +pop +storerect left bottom width height rectclip +pop +/MMdict_count countdictstack def +/MMop_count count 1 sub def +userdict begin +/showpage {} def +0 setgray 0 setlinecap 1 setlinewidth +0 setlinejoin 10 setmiterlimit [] 0 setdash newpath +} bdf +/currentpacking defed{true setpacking}if +/min{2 copy gt{exch}if pop}bdf +/max{2 copy lt{exch}if pop}bdf +/xformfont { currentfont exch makefont setfont } bdf +/fhnumcolors 1 +statusdict begin +/processcolors defed +{ +pop processcolors +} +{ +/deviceinfo defed { +deviceinfo /Colors known { +pop deviceinfo /Colors get +} if +} if +} ifelse +end +def +/printerRes +gsave +matrix defaultmatrix setmatrix +72 72 dtransform +abs exch abs +max +grestore +def +/graycalcs +[ +{Angle Frequency} +{GrayAngle GrayFrequency} +{0 Width Height matrix defaultmatrix idtransform +dup mul exch dup mul add sqrt 72 exch div} +{0 GrayWidth GrayHeight matrix defaultmatrix idtransform +dup mul exch dup mul add sqrt 72 exch div} +] def +/calcgraysteps { +forcemaxsteps +{ +maxsteps +} +{ +/currenthalftone defed +{currenthalftone /dicttype eq}{false}ifelse +{ +currenthalftone begin +HalftoneType 4 le +{graycalcs HalftoneType 1 sub get exec} +{ +HalftoneType 5 eq +{ +Default begin +{graycalcs HalftoneType 1 sub get exec} +end +} +{0 60} +ifelse +} +ifelse +end +} +{ +currentscreen pop exch +} +ifelse +printerRes 300 max exch div exch +2 copy +sin mul round dup mul +3 1 roll +cos mul round dup mul +add 1 add +dup maxsteps gt {pop maxsteps} if +dup minsteps lt {pop minsteps} if +} +ifelse +} bdf +/nextrelease defed { +/languagelevel defed not { +/framebuffer defed { +0 40 string framebuffer 9 1 roll 8 {pop} repeat +dup 516 eq exch 520 eq or +{ +/fhnumcolors 3 def +/currentscreen {60 0 {pop pop 1}}bdf +/calcgraysteps {maxsteps} bdf +}if +}if +}if +}if +fhnumcolors 1 ne { +/calcgraysteps {maxsteps} bdf +} if +/currentpagedevice defed { +currentpagedevice /PreRenderingEnhance known +{ +currentpagedevice /PreRenderingEnhance get +{ +/calcgraysteps +{ +forcemaxsteps +{maxsteps} +{256 maxsteps min} +ifelse +} def +} if +} if +} if +/gradfrequency 144 def +printerRes 1000 lt { +/gradfrequency 72 def +} if +/adjnumsteps { +dup dtransform abs exch abs max +printerRes div +gradfrequency mul +round +5 max +min +}bdf +/goodsep { +spots exch get 4 get dup sepname eq exch (_vc_Registration) eq or +}bdf +/BeginGradation defed +{/bb{BeginGradation}bdf} +{/bb{}bdf} +ifelse +/EndGradation defed +{/eb{EndGradation}bdf} +{/eb{}bdf} +ifelse +/bottom -0 def +/delta -0 def +/frac -0 def +/height -0 def +/left -0 def +/numsteps1 -0 def +/radius -0 def +/right -0 def +/top -0 def +/width -0 def +/xt -0 def +/yt -0 def +/df currentflat def +/tempstr 1 string def +/clipflatness currentflat def +/inverted? +0 currenttransfer exec .5 ge def +/tc1 [0 0 0 1] def +/tc2 [0 0 0 1] def +/storerect{/top xdf /right xdf /bottom xdf /left xdf +/width right left sub def /height top bottom sub def}bdf +/concatprocs{ +systemdict /packedarray known +{dup type /packedarraytype eq 2 index type /packedarraytype eq or}{false}ifelse +{ +/proc2 exch cvlit def /proc1 exch cvlit def +proc1 aload pop proc2 aload pop +proc1 length proc2 length add packedarray cvx +} +{ +/proc2 exch cvlit def /proc1 exch cvlit def +/newproc proc1 length proc2 length add array def +newproc 0 proc1 putinterval newproc proc1 length proc2 putinterval +newproc cvx +}ifelse +}bdf +/i{dup 0 eq +{pop df dup} +{dup} ifelse +/clipflatness xdf setflat +}bdf +version cvr 38.0 le +{/setrgbcolor{ +currenttransfer exec 3 1 roll +currenttransfer exec 3 1 roll +currenttransfer exec 3 1 roll +setrgbcolor}bdf}if +/vms {/vmsv save def} bdf +/vmr {vmsv restore} bdf +/vmrs{vmsv restore /vmsv save def}bdf +/eomode{ +{/filler /eofill load def /clipper /eoclip load def} +{/filler /fill load def /clipper /clip load def} +ifelse +}bdf +/normtaper{}bdf +/logtaper{9 mul 1 add log}bdf +/CD{ +/NF exch def +{ +exch dup +/FID ne 1 index/UniqueID ne and +{exch NF 3 1 roll put} +{pop pop} +ifelse +}forall +NF +}bdf +/MN{ +1 index length +/Len exch def +dup length Len add +string dup +Len +4 -1 roll +putinterval +dup +0 +4 -1 roll +putinterval +}bdf +/RC{4 -1 roll /ourvec xdf 256 string cvs(|______)anchorsearch +{1 index MN cvn/NewN exch def cvn +findfont dup maxlength dict CD dup/FontName NewN put dup +/Encoding ourvec put NewN exch definefont pop}{pop}ifelse}bdf +/RF{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RC} +ifelse +}bdf +/FF{dup 256 string cvs(|______)exch MN cvn dup FontDirectory exch known +{exch pop findfont 3 -1 roll pop} +{pop dup findfont dup maxlength dict CD dup dup +/Encoding exch /Encoding get 256 array copy 7 -1 roll +{3 -1 roll dup 4 -2 roll put}forall put definefont} +ifelse}bdf +/RCJ{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFJ +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFJ{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCJ} +ifelse +}bdf +/hasfont +{ +/resourcestatus where +{ +pop +/Font resourcestatus +{ +pop pop true +} +{ +false +} +ifelse +} +{ +dup FontDirectory exch known +{pop true} +{ +256 string +cvs +(fonts/) exch MN +status +{pop pop pop pop true} +{false} +ifelse +} +ifelse +} +ifelse +}bdf +/FDFJ +{ +dup +hasfont +not +{ +pop +/Ryumin-Light-83pv-RKSJ-H +hasfont +{ +/Ryumin-Light-83pv-RKSJ-H +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFJ{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFJ +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/GS { +dup +hasfont +{ +findfont +exch makesetfont +exch +pop +ts +} +{ +pop pop pop +ts +} ifelse +} bdf +/RCK{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFK +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFK{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCK} +ifelse +}bdf +/hasfont +{ +/resourcestatus where +{ +pop +/Font resourcestatus +{ +pop pop true +} +{ +false +} +ifelse +} +{ +dup FontDirectory exch known +{pop true} +{ +256 string +cvs +(fonts/) exch MN +status +{pop pop pop pop true} +{false} +ifelse +} +ifelse +} +ifelse +}bdf +/FDFK +{ +dup +hasfont +not +{ +pop +/JCsm +hasfont +{ +/JCsm +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFK{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFK +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/RCTC{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFTC +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFTC{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCTC} +ifelse +}bdf +/FDFTC +{ +dup +hasfont +not +{ +pop +/DFMing-Lt-HK-BF +hasfont +{ +/DFMing-Lt-HK-BF +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFTC{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFTC +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/fps{ +currentflat +exch +dup 0 le{pop 1}if +{ +dup setflat 3 index stopped +{1.3 mul dup 3 index gt{pop setflat pop pop stop}if} +{exit} +ifelse +}loop +pop setflat pop pop +}bdf +/fp{100 currentflat fps}bdf +/clipper{clip}bdf +/W{/clipper load 100 clipflatness dup setflat fps}bdf + +userdict begin /BDFontDict 29 dict def end +BDFontDict begin +/bu{}def +/bn{}def +/setTxMode{av 70 ge{pop}if pop}def +/gm{m}def +/show{pop}def +/gr{pop}def +/fnt{pop pop pop}def +/fs{pop}def +/fz{pop}def +/lin{pop pop}def +/:M {pop pop} def +/sf {pop} def +/S {pop} def +/@b {pop pop pop pop pop pop pop pop} def +/_bdsave /save load def +/_bdrestore /restore load def +/save { dup /fontsave eq {null} {_bdsave} ifelse } def +/restore { dup null eq { pop } { _bdrestore } ifelse } def +/fontsave null def +end +/MacVec 256 array def +MacVec 0 /Helvetica findfont +/Encoding get 0 128 getinterval putinterval +MacVec 127 /DEL put MacVec 16#27 /quotesingle put MacVec 16#60 /grave put +/NUL/SOH/STX/ETX/EOT/ENQ/ACK/BEL/BS/HT/LF/VT/FF/CR/SO/SI +/DLE/DC1/DC2/DC3/DC4/NAK/SYN/ETB/CAN/EM/SUB/ESC/FS/GS/RS/US +MacVec 0 32 getinterval astore pop +/Adieresis/Aring/Ccedilla/Eacute/Ntilde/Odieresis/Udieresis/aacute +/agrave/acircumflex/adieresis/atilde/aring/ccedilla/eacute/egrave +/ecircumflex/edieresis/iacute/igrave/icircumflex/idieresis/ntilde/oacute +/ograve/ocircumflex/odieresis/otilde/uacute/ugrave/ucircumflex/udieresis +/dagger/degree/cent/sterling/section/bullet/paragraph/germandbls +/registered/copyright/trademark/acute/dieresis/notequal/AE/Oslash +/infinity/plusminus/lessequal/greaterequal/yen/mu/partialdiff/summation +/product/pi/integral/ordfeminine/ordmasculine/Omega/ae/oslash +/questiondown/exclamdown/logicalnot/radical/florin/approxequal/Delta/guillemotleft +/guillemotright/ellipsis/nbspace/Agrave/Atilde/Otilde/OE/oe +/endash/emdash/quotedblleft/quotedblright/quoteleft/quoteright/divide/lozenge +/ydieresis/Ydieresis/fraction/currency/guilsinglleft/guilsinglright/fi/fl +/daggerdbl/periodcentered/quotesinglbase/quotedblbase +/perthousand/Acircumflex/Ecircumflex/Aacute +/Edieresis/Egrave/Iacute/Icircumflex/Idieresis/Igrave/Oacute/Ocircumflex +/apple/Ograve/Uacute/Ucircumflex/Ugrave/dotlessi/circumflex/tilde +/macron/breve/dotaccent/ring/cedilla/hungarumlaut/ogonek/caron +MacVec 128 128 getinterval astore pop +/findheaderfont { +/Helvetica findfont +} def +end %. AltsysDict +%%EndResource +%%EndProlog + +%%BeginSetup + +AltsysDict begin +_bfh + +_efh +end %. AltsysDict + +%%EndSetup +AltsysDict begin + +/onlyk4{false}ndf +/ccmyk{dup 5 -1 roll sub 0 max exch}ndf +/cmyk2gray{ +4 -1 roll 0.3 mul 4 -1 roll 0.59 mul 4 -1 roll 0.11 mul +add add add 1 min neg 1 add +}bdf +/setcmykcolor{1 exch sub ccmyk ccmyk ccmyk pop setrgbcolor}ndf +/maxcolor { +max max max +} ndf +/maxspot { +pop +} ndf +/setcmykcoloroverprint{4{dup -1 eq{pop 0}if 4 1 roll}repeat setcmykcolor}ndf +/findcmykcustomcolor{5 packedarray}ndf +/setcustomcolor{exch aload pop pop 4{4 index mul 4 1 roll}repeat setcmykcolor pop}ndf +/setseparationgray{setgray}ndf +/setoverprint{pop}ndf +/currentoverprint false ndf +/cmykbufs2gray{ +0 1 2 index length 1 sub +{ +4 index 1 index get 0.3 mul +4 index 2 index get 0.59 mul +4 index 3 index get 0.11 mul +4 index 4 index get +add add add cvi 255 min +255 exch sub +2 index 3 1 roll put +}for +4 1 roll pop pop pop +}bdf +/colorimage{ +pop pop +[ +5 -1 roll/exec cvx +6 -1 roll/exec cvx +7 -1 roll/exec cvx +8 -1 roll/exec cvx +/cmykbufs2gray cvx +]cvx +image +} +%. version 47.1 on Linotronic of Postscript defines colorimage incorrectly (rgb model only) +version cvr 47.1 le +statusdict /product get (Lino) anchorsearch{pop pop true}{pop false}ifelse +and{userdict begin bdf end}{ndf}ifelse +fhnumcolors 1 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +ic im iy ik cmyk2gray /xt xdf +currenttransfer +{dup 1.0 exch sub xt mul add}concatprocs +st +image +} +ifelse +}ndf +fhnumcolors 1 ne {yt restore} if +fhnumcolors 3 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +1.0 dup ic ik add min sub +1.0 dup im ik add min sub +1.0 dup iy ik add min sub +/ic xdf /iy xdf /im xdf +currentcolortransfer +4 1 roll +{dup 1.0 exch sub ic mul add}concatprocs 4 1 roll +{dup 1.0 exch sub iy mul add}concatprocs 4 1 roll +{dup 1.0 exch sub im mul add}concatprocs 4 1 roll +setcolortransfer +{/dummy xdf dummy}concatprocs{dummy}{dummy}true 3 colorimage +} +ifelse +}ndf +fhnumcolors 3 ne {yt restore} if +fhnumcolors 4 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +currentcolortransfer +{1.0 exch sub ik mul ik sub 1 add}concatprocs 4 1 roll +{1.0 exch sub iy mul iy sub 1 add}concatprocs 4 1 roll +{1.0 exch sub im mul im sub 1 add}concatprocs 4 1 roll +{1.0 exch sub ic mul ic sub 1 add}concatprocs 4 1 roll +setcolortransfer +{/dummy xdf dummy}concatprocs{dummy}{dummy}{dummy} +true 4 colorimage +} +ifelse +}ndf +fhnumcolors 4 ne {yt restore} if +/separationimage{image}ndf +/spotascmyk false ndf +/newcmykcustomcolor{6 packedarray}ndf +/inkoverprint false ndf +/setinkoverprint{pop}ndf +/setspotcolor { +spots exch get +dup 4 get (_vc_Registration) eq +{pop 1 exch sub setseparationgray} +{0 5 getinterval exch setcustomcolor} +ifelse +}ndf +/currentcolortransfer{currenttransfer dup dup dup}ndf +/setcolortransfer{st pop pop pop}ndf +/fas{}ndf +/sas{}ndf +/fhsetspreadsize{pop}ndf +/filler{fill}bdf +/F{gsave {filler}fp grestore}bdf +/f{closepath F}bdf +/S{gsave {stroke}fp grestore}bdf +/s{closepath S}bdf +userdict /islevel2 +systemdict /languagelevel known dup +{ +pop systemdict /languagelevel get 2 ge +} if +put +islevel2 not +{ +/currentcmykcolor +{ +0 0 0 1 currentgray sub +} ndf +} if +/tc +{ +gsave +setcmykcolor currentcmykcolor +grestore +} bind def +/testCMYKColorThrough +{ +tc add add add 0 ne +} bind def +/fhiscomposite where not { +userdict /fhiscomposite +islevel2 +{ +gsave 1 1 1 1 setcmykcolor currentcmykcolor grestore +add add add 4 eq +} +{ +1 0 0 0 testCMYKColorThrough +0 1 0 0 testCMYKColorThrough +0 0 1 0 testCMYKColorThrough +0 0 0 1 testCMYKColorThrough +and and and +} ifelse +put +} +{ pop } +ifelse +/bc4 [0 0 0 0] def +/_lfp4 { +1 pop +/yt xdf +/xt xdf +/ang xdf +storerect +/taperfcn xdf +/k2 xdf /y2 xdf /m2 xdf /c2 xdf +/k1 xdf /y1 xdf /m1 xdf /c1 xdf +c1 c2 sub abs +m1 m2 sub abs +y1 y2 sub abs +k1 k2 sub abs +maxcolor +calcgraysteps mul abs round +height abs adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +currentflat mark +currentflat clipflatness +/delta top bottom sub numsteps1 1 add div def +/right right left sub def +/botsv top delta sub def +{ +{ +W +xt yt translate +ang rotate +xt neg yt neg translate +dup setflat +/bottom botsv def +0 1 numsteps1 +{ +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +taperfcn /frac xdf +bc4 0 c2 c1 sub frac mul c1 add put +bc4 1 m2 m1 sub frac mul m1 add put +bc4 2 y2 y1 sub frac mul y1 add put +bc4 3 k2 k1 sub frac mul k1 add put +bc4 vc +1 index setflat +{ +mark {newpath left bottom right delta rectfill}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +/bottom bottom delta sub def +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/bcs [0 0] def +/_lfs4 { +/yt xdf +/xt xdf +/ang xdf +storerect +/taperfcn xdf +/tint2 xdf +/tint1 xdf +bcs exch 1 exch put +tint1 tint2 sub abs +bcs 1 get maxspot +calcgraysteps mul abs round +height abs adjnumsteps +dup 2 lt {pop 2} if +1 sub /numsteps1 xdf +currentflat mark +currentflat clipflatness +/delta top bottom sub numsteps1 1 add div def +/right right left sub def +/botsv top delta sub def +{ +{ +W +xt yt translate +ang rotate +xt neg yt neg translate +dup setflat +/bottom botsv def +0 1 numsteps1 +{ +numsteps1 div taperfcn /frac xdf +bcs 0 +1.0 tint2 tint1 sub frac mul tint1 add sub +put bcs vc +1 index setflat +{ +mark {newpath left bottom right delta rectfill}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +/bottom bottom delta sub def +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/_rfs6 { +/tint2 xdf +/tint1 xdf +bcs exch 1 exch put +/inrad xdf +/radius xdf +/yt xdf +/xt xdf +tint1 tint2 sub abs +bcs 1 get maxspot +calcgraysteps mul abs round +radius inrad sub abs +adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse +2 div /halfstep xdf +currentflat mark +currentflat clipflatness +{ +{ +dup setflat +W +0 1 numsteps1 +{ +dup /radindex xdf +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +/frac xdf +bcs 0 +tint2 tint1 sub frac mul tint1 add +put bcs vc +1 index setflat +{ +newpath mark +xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360 +{ arc +radindex numsteps1 ne +inrad 0 gt or +{ +xt yt +numsteps1 0 eq +{ inrad } +{ +radindex 1 add numsteps1 div 1 exch sub +radius inrad sub mul halfstep add inrad add +}ifelse +dup xt add yt moveto +360 0 arcn +} if +fill +}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/_rfp6 { +1 pop +/k2 xdf /y2 xdf /m2 xdf /c2 xdf +/k1 xdf /y1 xdf /m1 xdf /c1 xdf +/inrad xdf +/radius xdf +/yt xdf +/xt xdf +c1 c2 sub abs +m1 m2 sub abs +y1 y2 sub abs +k1 k2 sub abs +maxcolor +calcgraysteps mul abs round +radius inrad sub abs +adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse +2 div /halfstep xdf +currentflat mark +currentflat clipflatness +{ +{ +dup setflat +W +0 1 numsteps1 +{ +dup /radindex xdf +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +/frac xdf +bc4 0 c2 c1 sub frac mul c1 add put +bc4 1 m2 m1 sub frac mul m1 add put +bc4 2 y2 y1 sub frac mul y1 add put +bc4 3 k2 k1 sub frac mul k1 add put +bc4 vc +1 index setflat +{ +newpath mark +xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360 +{ arc +radindex numsteps1 ne +inrad 0 gt or +{ +xt yt +numsteps1 0 eq +{ inrad } +{ +radindex 1 add numsteps1 div 1 exch sub +radius inrad sub mul halfstep add inrad add +}ifelse +dup xt add yt moveto +360 0 arcn +} if +fill +}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/lfp4{_lfp4}ndf +/lfs4{_lfs4}ndf +/rfs6{_rfs6}ndf +/rfp6{_rfp6}ndf +/cvc [0 0 0 1] def +/vc{ +AltsysDict /cvc 2 index put +aload length dup 4 eq +{pop dup -1 eq{pop setrgbcolor}{setcmykcolor}ifelse} +{6 eq {sethexcolor} {setspotcolor} ifelse } +ifelse +}bdf +0 setseparationgray +/imgr {1692.47 1570.59 2287.75 2412.48 } def +/bleed 0 def +/clpr {1692.47 1570.59 2287.75 2412.48 } def +/xs 1 def +/ys 1 def +/botx 0 def +/overlap 0 def +/wdist 18 def +0 2 mul fhsetspreadsize +0 0 ne {/df 0 def /clipflatness 0 def} if +/maxsteps 256 def +/forcemaxsteps false def +/minsteps 0 def + +userdict begin /AGDOrigMtx matrix currentmatrix def end +vms +0.15 0.15 scale %JND +-1845 -2006 translate + +/currentpacking defed{false setpacking}if +/spots[ + +1 0 0 0 (Process Cyan) false newcmykcustomcolor + +0 1 0 0 (Process Magenta) false newcmykcustomcolor + +0 0 1 0 (Process Yellow) false newcmykcustomcolor + +0 0 0 1 (Process Black) false newcmykcustomcolor +]def +n +[] 0 d +3.863708 M +1 w +0 j +0 J +false setoverprint +0 i +false eomode +[0 0 0 1]vc +vms +1848.4365 2094.0422 m +1848.4365 2140.987 1886.4917 2179.0422 1933.4365 2179.0422 C +1980.3813 2179.0422 2018.4365 2140.987 2018.4365 2094.0422 C +2018.4365 2047.0974 1980.3813 2009.0422 1933.4365 2009.0422 C +1886.4917 2009.0422 1848.4365 2047.0974 1848.4365 2094.0422 C +5.3858 w +3.863693 M +s +n +true eomode +1880.5612 2118.7403 m +1880.5612 2121.7396 1881.6862 2124.8795 1883.9362 2128.1622 C +1886.1862 2131.4889 1888.4581 2133.1522 1890.7565 2133.1544 C +1892.2089 2133.1544 1893.4042 2132.5677 1894.3424 2131.3966 C +1895.3268 2130.2233 1895.819 2128.7467 1895.819 2126.9669 C +1895.819 2124.0599 1894.6237 2121.0826 1892.233 2118.0372 C +1889.8885 2114.9896 1887.6144 2113.4669 1885.4127 2113.4669 C +1884.0526 2113.4669 1882.9034 2113.9591 1881.9674 2114.9435 C +1881.0292 2115.974 1880.5612 2117.2396 1880.5612 2118.7403 C +h +1948.2018 2061.1544 m +1978.4362 2061.0138 L +1980.451 2062.6068 1981.9034 2064.3163 1982.7955 2066.1466 C +1983.7316 2068.0209 1984.1996 2070.2005 1984.2018 2072.6857 C +1984.2018 2073.2482 L +1969.2252 2099.6153 L +1969.2252 2099.3341 1969.2472 2098.8639 1969.2955 2098.2091 C +1969.3417 2097.5983 1969.3636 2097.1544 1969.3658 2096.8732 C +1969.3658 2089.888 1967.5597 2083.3732 1963.9518 2077.3263 C +1960.3878 2071.2794 1955.1385 2065.8873 1948.2018 2061.1544 C +h +1905.8737 2139.4825 m +1910.0924 2124.2247 L +1964.233 2092.5841 L +1964.6066 2094.3177 1964.8636 2095.724 1965.0065 2096.8028 C +1965.1471 2097.9278 1965.2174 2098.9122 1965.2174 2099.756 C +1965.2174 2100.4108 1965.1691 2101.5599 1965.0768 2103.2013 C +1964.9823 2103.5748 1964.9362 2103.8561 1964.9362 2104.045 C +1905.8737 2139.4825 L +h +1908.4752 2120.3575 m +1898.983 2105.5216 L +1954.3893 2072.8263 L +1956.4987 2074.7005 1958.2565 2076.8561 1959.6627 2079.295 C +1961.1151 2081.7779 1962.2863 2084.6608 1963.1783 2087.9435 C +1908.4752 2120.3575 L +h +1896.2408 2102.3575 m +1880.5612 2099.0528 L +1942.9283 2062.631 L +1944.5675 2063.5209 1946.0682 2064.5272 1947.4283 2065.6544 C +1948.7863 2066.7794 1950.0057 2068.0209 1951.0846 2069.381 C +1896.2408 2102.3575 L +h +1871.2096 2120.7794 m +1876.3424 2102.3575 L +1894.2018 2105.9435 L +1906.1549 2125.2794 L +1900.8815 2142.506 L +1882.7408 2139.2013 L +1871.2096 2120.7794 L +h +1866.7096 2121.4825 m +1880.1393 2142.3653 L +1901.3033 2146.5841 L +1963.6705 2109.3888 L +1968.0299 2106.8092 1971.005 2103.9747 1972.6002 2100.881 C +1972.8815 2100.2701 1973.1144 2099.8021 1973.3033 2099.4747 C +1991.444 2068.256 L +1991.6769 2067.8341 1992.0043 2067.2474 1992.4283 2066.4982 C +1994.0675 2064.013 1994.8871 2062.0904 1994.8893 2060.7325 C +1994.8893 2059.4186 1994.3971 2058.4825 1993.4127 2057.92 C +1992.4745 2057.4037 1990.6705 2057.1466 1987.9987 2057.1466 C +1948.0612 2057.1466 L +1946.4198 2057.1466 1944.7784 2057.4037 1943.1393 2057.92 C +1941.4979 2058.4825 1939.4127 2059.513 1936.8815 2061.0138 C +1873.6705 2098.631 L +1866.7096 2121.4825 L +true setoverprint +f +false setoverprint +n +vmr +vmr +end +%%Trailer diff --git a/docs/docbook/xslt/figures/note.pdf b/docs/docbook/xslt/figures/note.pdf Binary files differnew file mode 100644 index 0000000000..ec6c248a2a --- /dev/null +++ b/docs/docbook/xslt/figures/note.pdf diff --git a/docs/docbook/xslt/figures/tip.eps b/docs/docbook/xslt/figures/tip.eps new file mode 100644 index 0000000000..a28ad883eb --- /dev/null +++ b/docs/docbook/xslt/figures/tip.eps @@ -0,0 +1,1503 @@ +%!PS-Adobe-2.0 EPSF-1.2 +%%Title: Untitled-1 +%%Creator: FreeHand 9.0 +%%CreationDate: 2002/07/16 10:41 PM +%%BoundingBox: 0 0 27 27 +%%FHPathName:Untitled:FreeHand 9:English:Untitled-1 +%ALDOriginalFile:Untitled:FreeHand 9:English:Untitled-1 +%ALDBoundingBox: -153 -436 442 406 +%%FHPageNum:1 +%%DocumentSuppliedResources: procset Altsys_header 4 0 +%%ColorUsage: Color +%%DocumentProcessColors: Black +%%EndComments +%%BeginResource: procset Altsys_header 4 0 +userdict begin /AltsysDict 300 dict def end +AltsysDict begin +/bdf{bind def}bind def +/xdf{exch def}bdf +/defed{where{pop true}{false}ifelse}bdf +/ndf{1 index where{pop pop pop}{dup xcheck{bind}if def}ifelse}bdf +/d{setdash}bdf +/h{closepath}bdf +/H{}bdf +/J{setlinecap}bdf +/j{setlinejoin}bdf +/M{setmiterlimit}bdf +/n{newpath}bdf +/N{newpath}bdf +/q{gsave}bdf +/Q{grestore}bdf +/w{setlinewidth}bdf +/Xic{matrix invertmatrix concat}bdf +/Xq{matrix currentmatrix mark}bdf +/XQ{cleartomark setmatrix}bdf +/sepdef{ +dup where not +{ +AltsysSepDict +} +if +3 1 roll exch put +}bdf +/st{settransfer}bdf +/colorimage defed /_rci xdf +/cntr 0 def +/readbinarystring{ +/cntr 0 def +2 copy readstring +{ +{ +dup +(\034) search +{ +length exch pop exch +dup length 0 ne +{ +dup dup 0 get 32 sub 0 exch put +/cntr cntr 1 add def +} +{ +pop 1 string dup +0 6 index read pop 32 sub put +}ifelse +3 copy +putinterval pop +1 add +1 index length 1 sub +1 index sub +dup 0 le {pop pop exit}if +getinterval +} +{ +pop exit +} ifelse +} loop +}if +cntr 0 gt +{ +pop 2 copy +dup length cntr sub cntr getinterval +readbinarystring +} if +pop exch pop +} bdf +/_NXLevel2 defed { +_NXLevel2 not { +/colorimage where { +userdict eq { +/_rci false def +} if +} if +} if +} if +/md defed{ +md type /dicttype eq { +/colorimage where { +md eq { +/_rci false def +}if +}if +/settransfer where { +md eq { +/st systemdict /settransfer get def +}if +}if +}if +}if +/setstrokeadjust defed +{ +true setstrokeadjust +/C{curveto}bdf +/L{lineto}bdf +/m{moveto}bdf +} +{ +/dr{transform .25 sub round .25 add +exch .25 sub round .25 add exch itransform}bdf +/C{dr curveto}bdf +/L{dr lineto}bdf +/m{dr moveto}bdf +/setstrokeadjust{pop}bdf +}ifelse +/privrectpath { +4 -2 roll m +dtransform round exch round exch idtransform +2 copy 0 lt exch 0 lt xor +{dup 0 exch rlineto exch 0 rlineto neg 0 exch rlineto} +{exch dup 0 rlineto exch 0 exch rlineto neg 0 rlineto} +ifelse +closepath +}bdf +/rectclip{newpath privrectpath clip newpath}def +/rectfill{gsave newpath privrectpath fill grestore}def +/rectstroke{gsave newpath privrectpath stroke grestore}def +/_fonthacksave false def +/currentpacking defed +{ +/_bfh {/_fonthacksave currentpacking def false setpacking} bdf +/_efh {_fonthacksave setpacking} bdf +} +{ +/_bfh {} bdf +/_efh {} bdf +}ifelse +/packedarray{array astore readonly}ndf +/` +{ +false setoverprint +/-save0- save def +5 index concat +pop +storerect left bottom width height rectclip +pop +/MMdict_count countdictstack def +/MMop_count count 1 sub def +userdict begin +/showpage {} def +0 setgray 0 setlinecap 1 setlinewidth +0 setlinejoin 10 setmiterlimit [] 0 setdash newpath +} bdf +/currentpacking defed{true setpacking}if +/min{2 copy gt{exch}if pop}bdf +/max{2 copy lt{exch}if pop}bdf +/xformfont { currentfont exch makefont setfont } bdf +/fhnumcolors 1 +statusdict begin +/processcolors defed +{ +pop processcolors +} +{ +/deviceinfo defed { +deviceinfo /Colors known { +pop deviceinfo /Colors get +} if +} if +} ifelse +end +def +/printerRes +gsave +matrix defaultmatrix setmatrix +72 72 dtransform +abs exch abs +max +grestore +def +/graycalcs +[ +{Angle Frequency} +{GrayAngle GrayFrequency} +{0 Width Height matrix defaultmatrix idtransform +dup mul exch dup mul add sqrt 72 exch div} +{0 GrayWidth GrayHeight matrix defaultmatrix idtransform +dup mul exch dup mul add sqrt 72 exch div} +] def +/calcgraysteps { +forcemaxsteps +{ +maxsteps +} +{ +/currenthalftone defed +{currenthalftone /dicttype eq}{false}ifelse +{ +currenthalftone begin +HalftoneType 4 le +{graycalcs HalftoneType 1 sub get exec} +{ +HalftoneType 5 eq +{ +Default begin +{graycalcs HalftoneType 1 sub get exec} +end +} +{0 60} +ifelse +} +ifelse +end +} +{ +currentscreen pop exch +} +ifelse +printerRes 300 max exch div exch +2 copy +sin mul round dup mul +3 1 roll +cos mul round dup mul +add 1 add +dup maxsteps gt {pop maxsteps} if +dup minsteps lt {pop minsteps} if +} +ifelse +} bdf +/nextrelease defed { +/languagelevel defed not { +/framebuffer defed { +0 40 string framebuffer 9 1 roll 8 {pop} repeat +dup 516 eq exch 520 eq or +{ +/fhnumcolors 3 def +/currentscreen {60 0 {pop pop 1}}bdf +/calcgraysteps {maxsteps} bdf +}if +}if +}if +}if +fhnumcolors 1 ne { +/calcgraysteps {maxsteps} bdf +} if +/currentpagedevice defed { +currentpagedevice /PreRenderingEnhance known +{ +currentpagedevice /PreRenderingEnhance get +{ +/calcgraysteps +{ +forcemaxsteps +{maxsteps} +{256 maxsteps min} +ifelse +} def +} if +} if +} if +/gradfrequency 144 def +printerRes 1000 lt { +/gradfrequency 72 def +} if +/adjnumsteps { +dup dtransform abs exch abs max +printerRes div +gradfrequency mul +round +5 max +min +}bdf +/goodsep { +spots exch get 4 get dup sepname eq exch (_vc_Registration) eq or +}bdf +/BeginGradation defed +{/bb{BeginGradation}bdf} +{/bb{}bdf} +ifelse +/EndGradation defed +{/eb{EndGradation}bdf} +{/eb{}bdf} +ifelse +/bottom -0 def +/delta -0 def +/frac -0 def +/height -0 def +/left -0 def +/numsteps1 -0 def +/radius -0 def +/right -0 def +/top -0 def +/width -0 def +/xt -0 def +/yt -0 def +/df currentflat def +/tempstr 1 string def +/clipflatness currentflat def +/inverted? +0 currenttransfer exec .5 ge def +/tc1 [0 0 0 1] def +/tc2 [0 0 0 1] def +/storerect{/top xdf /right xdf /bottom xdf /left xdf +/width right left sub def /height top bottom sub def}bdf +/concatprocs{ +systemdict /packedarray known +{dup type /packedarraytype eq 2 index type /packedarraytype eq or}{false}ifelse +{ +/proc2 exch cvlit def /proc1 exch cvlit def +proc1 aload pop proc2 aload pop +proc1 length proc2 length add packedarray cvx +} +{ +/proc2 exch cvlit def /proc1 exch cvlit def +/newproc proc1 length proc2 length add array def +newproc 0 proc1 putinterval newproc proc1 length proc2 putinterval +newproc cvx +}ifelse +}bdf +/i{dup 0 eq +{pop df dup} +{dup} ifelse +/clipflatness xdf setflat +}bdf +version cvr 38.0 le +{/setrgbcolor{ +currenttransfer exec 3 1 roll +currenttransfer exec 3 1 roll +currenttransfer exec 3 1 roll +setrgbcolor}bdf}if +/vms {/vmsv save def} bdf +/vmr {vmsv restore} bdf +/vmrs{vmsv restore /vmsv save def}bdf +/eomode{ +{/filler /eofill load def /clipper /eoclip load def} +{/filler /fill load def /clipper /clip load def} +ifelse +}bdf +/normtaper{}bdf +/logtaper{9 mul 1 add log}bdf +/CD{ +/NF exch def +{ +exch dup +/FID ne 1 index/UniqueID ne and +{exch NF 3 1 roll put} +{pop pop} +ifelse +}forall +NF +}bdf +/MN{ +1 index length +/Len exch def +dup length Len add +string dup +Len +4 -1 roll +putinterval +dup +0 +4 -1 roll +putinterval +}bdf +/RC{4 -1 roll /ourvec xdf 256 string cvs(|______)anchorsearch +{1 index MN cvn/NewN exch def cvn +findfont dup maxlength dict CD dup/FontName NewN put dup +/Encoding ourvec put NewN exch definefont pop}{pop}ifelse}bdf +/RF{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RC} +ifelse +}bdf +/FF{dup 256 string cvs(|______)exch MN cvn dup FontDirectory exch known +{exch pop findfont 3 -1 roll pop} +{pop dup findfont dup maxlength dict CD dup dup +/Encoding exch /Encoding get 256 array copy 7 -1 roll +{3 -1 roll dup 4 -2 roll put}forall put definefont} +ifelse}bdf +/RCJ{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFJ +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFJ{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCJ} +ifelse +}bdf +/hasfont +{ +/resourcestatus where +{ +pop +/Font resourcestatus +{ +pop pop true +} +{ +false +} +ifelse +} +{ +dup FontDirectory exch known +{pop true} +{ +256 string +cvs +(fonts/) exch MN +status +{pop pop pop pop true} +{false} +ifelse +} +ifelse +} +ifelse +}bdf +/FDFJ +{ +dup +hasfont +not +{ +pop +/Ryumin-Light-83pv-RKSJ-H +hasfont +{ +/Ryumin-Light-83pv-RKSJ-H +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFJ{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFJ +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/GS { +dup +hasfont +{ +findfont +exch makesetfont +exch +pop +ts +} +{ +pop pop pop +ts +} ifelse +} bdf +/RCK{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFK +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFK{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCK} +ifelse +}bdf +/hasfont +{ +/resourcestatus where +{ +pop +/Font resourcestatus +{ +pop pop true +} +{ +false +} +ifelse +} +{ +dup FontDirectory exch known +{pop true} +{ +256 string +cvs +(fonts/) exch MN +status +{pop pop pop pop true} +{false} +ifelse +} +ifelse +} +ifelse +}bdf +/FDFK +{ +dup +hasfont +not +{ +pop +/JCsm +hasfont +{ +/JCsm +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFK{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFK +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/RCTC{4 -1 roll +/ourvec xdf +256 string cvs +(|______) anchorsearch +{pop +cvn +dup FDFTC +exch +1 index +eq +{ +_bfh findfont _efh +dup +maxlength dict +CD +dup +/FontName +3 index +put +dup +/Encoding ourvec put +1 index +exch +definefont +pop +} +{exch pop} +ifelse +} +{pop} +ifelse +}bdf +/RFTC{ +dup +FontDirectory exch +known +{pop 3 -1 roll pop} +{RCTC} +ifelse +}bdf +/FDFTC +{ +dup +hasfont +not +{ +pop +/DFMing-Lt-HK-BF +hasfont +{ +/DFMing-Lt-HK-BF +} +{ +/Courier +} +ifelse +} +if +}bdf +/FFTC{ +_bfh +dup +256 string cvs +(|______)exch MN +cvn +dup +FontDirectory +exch known +{ +exch +pop +findfont +3 -1 roll +pop +} +{ +pop +FDFTC +dup findfont +dup maxlength dict +CD +dup dup +/Encoding exch +/Encoding get +256 array copy +7 -1 roll +{ +3 -1 roll +dup +4 -2 roll +put +}forall +put +definefont +} +ifelse +_efh +}bdf +/fps{ +currentflat +exch +dup 0 le{pop 1}if +{ +dup setflat 3 index stopped +{1.3 mul dup 3 index gt{pop setflat pop pop stop}if} +{exit} +ifelse +}loop +pop setflat pop pop +}bdf +/fp{100 currentflat fps}bdf +/clipper{clip}bdf +/W{/clipper load 100 clipflatness dup setflat fps}bdf + +userdict begin /BDFontDict 29 dict def end +BDFontDict begin +/bu{}def +/bn{}def +/setTxMode{av 70 ge{pop}if pop}def +/gm{m}def +/show{pop}def +/gr{pop}def +/fnt{pop pop pop}def +/fs{pop}def +/fz{pop}def +/lin{pop pop}def +/:M {pop pop} def +/sf {pop} def +/S {pop} def +/@b {pop pop pop pop pop pop pop pop} def +/_bdsave /save load def +/_bdrestore /restore load def +/save { dup /fontsave eq {null} {_bdsave} ifelse } def +/restore { dup null eq { pop } { _bdrestore } ifelse } def +/fontsave null def +end +/MacVec 256 array def +MacVec 0 /Helvetica findfont +/Encoding get 0 128 getinterval putinterval +MacVec 127 /DEL put MacVec 16#27 /quotesingle put MacVec 16#60 /grave put +/NUL/SOH/STX/ETX/EOT/ENQ/ACK/BEL/BS/HT/LF/VT/FF/CR/SO/SI +/DLE/DC1/DC2/DC3/DC4/NAK/SYN/ETB/CAN/EM/SUB/ESC/FS/GS/RS/US +MacVec 0 32 getinterval astore pop +/Adieresis/Aring/Ccedilla/Eacute/Ntilde/Odieresis/Udieresis/aacute +/agrave/acircumflex/adieresis/atilde/aring/ccedilla/eacute/egrave +/ecircumflex/edieresis/iacute/igrave/icircumflex/idieresis/ntilde/oacute +/ograve/ocircumflex/odieresis/otilde/uacute/ugrave/ucircumflex/udieresis +/dagger/degree/cent/sterling/section/bullet/paragraph/germandbls +/registered/copyright/trademark/acute/dieresis/notequal/AE/Oslash +/infinity/plusminus/lessequal/greaterequal/yen/mu/partialdiff/summation +/product/pi/integral/ordfeminine/ordmasculine/Omega/ae/oslash +/questiondown/exclamdown/logicalnot/radical/florin/approxequal/Delta/guillemotleft +/guillemotright/ellipsis/nbspace/Agrave/Atilde/Otilde/OE/oe +/endash/emdash/quotedblleft/quotedblright/quoteleft/quoteright/divide/lozenge +/ydieresis/Ydieresis/fraction/currency/guilsinglleft/guilsinglright/fi/fl +/daggerdbl/periodcentered/quotesinglbase/quotedblbase +/perthousand/Acircumflex/Ecircumflex/Aacute +/Edieresis/Egrave/Iacute/Icircumflex/Idieresis/Igrave/Oacute/Ocircumflex +/apple/Ograve/Uacute/Ucircumflex/Ugrave/dotlessi/circumflex/tilde +/macron/breve/dotaccent/ring/cedilla/hungarumlaut/ogonek/caron +MacVec 128 128 getinterval astore pop +/findheaderfont { +/Helvetica findfont +} def +end %. AltsysDict +%%EndResource +%%EndProlog + +%%BeginSetup + +AltsysDict begin +_bfh + +_efh +end %. AltsysDict + +%%EndSetup +AltsysDict begin + +/onlyk4{false}ndf +/ccmyk{dup 5 -1 roll sub 0 max exch}ndf +/cmyk2gray{ +4 -1 roll 0.3 mul 4 -1 roll 0.59 mul 4 -1 roll 0.11 mul +add add add 1 min neg 1 add +}bdf +/setcmykcolor{1 exch sub ccmyk ccmyk ccmyk pop setrgbcolor}ndf +/maxcolor { +max max max +} ndf +/maxspot { +pop +} ndf +/setcmykcoloroverprint{4{dup -1 eq{pop 0}if 4 1 roll}repeat setcmykcolor}ndf +/findcmykcustomcolor{5 packedarray}ndf +/setcustomcolor{exch aload pop pop 4{4 index mul 4 1 roll}repeat setcmykcolor pop}ndf +/setseparationgray{setgray}ndf +/setoverprint{pop}ndf +/currentoverprint false ndf +/cmykbufs2gray{ +0 1 2 index length 1 sub +{ +4 index 1 index get 0.3 mul +4 index 2 index get 0.59 mul +4 index 3 index get 0.11 mul +4 index 4 index get +add add add cvi 255 min +255 exch sub +2 index 3 1 roll put +}for +4 1 roll pop pop pop +}bdf +/colorimage{ +pop pop +[ +5 -1 roll/exec cvx +6 -1 roll/exec cvx +7 -1 roll/exec cvx +8 -1 roll/exec cvx +/cmykbufs2gray cvx +]cvx +image +} +%. version 47.1 on Linotronic of Postscript defines colorimage incorrectly (rgb model only) +version cvr 47.1 le +statusdict /product get (Lino) anchorsearch{pop pop true}{pop false}ifelse +and{userdict begin bdf end}{ndf}ifelse +fhnumcolors 1 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +ic im iy ik cmyk2gray /xt xdf +currenttransfer +{dup 1.0 exch sub xt mul add}concatprocs +st +image +} +ifelse +}ndf +fhnumcolors 1 ne {yt restore} if +fhnumcolors 3 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +1.0 dup ic ik add min sub +1.0 dup im ik add min sub +1.0 dup iy ik add min sub +/ic xdf /iy xdf /im xdf +currentcolortransfer +4 1 roll +{dup 1.0 exch sub ic mul add}concatprocs 4 1 roll +{dup 1.0 exch sub iy mul add}concatprocs 4 1 roll +{dup 1.0 exch sub im mul add}concatprocs 4 1 roll +setcolortransfer +{/dummy xdf dummy}concatprocs{dummy}{dummy}true 3 colorimage +} +ifelse +}ndf +fhnumcolors 3 ne {yt restore} if +fhnumcolors 4 ne {/yt save def} if +/customcolorimage{ +aload pop +(_vc_Registration) eq +{ +pop pop pop pop separationimage +} +{ +/ik xdf /iy xdf /im xdf /ic xdf +currentcolortransfer +{1.0 exch sub ik mul ik sub 1 add}concatprocs 4 1 roll +{1.0 exch sub iy mul iy sub 1 add}concatprocs 4 1 roll +{1.0 exch sub im mul im sub 1 add}concatprocs 4 1 roll +{1.0 exch sub ic mul ic sub 1 add}concatprocs 4 1 roll +setcolortransfer +{/dummy xdf dummy}concatprocs{dummy}{dummy}{dummy} +true 4 colorimage +} +ifelse +}ndf +fhnumcolors 4 ne {yt restore} if +/separationimage{image}ndf +/spotascmyk false ndf +/newcmykcustomcolor{6 packedarray}ndf +/inkoverprint false ndf +/setinkoverprint{pop}ndf +/setspotcolor { +spots exch get +dup 4 get (_vc_Registration) eq +{pop 1 exch sub setseparationgray} +{0 5 getinterval exch setcustomcolor} +ifelse +}ndf +/currentcolortransfer{currenttransfer dup dup dup}ndf +/setcolortransfer{st pop pop pop}ndf +/fas{}ndf +/sas{}ndf +/fhsetspreadsize{pop}ndf +/filler{fill}bdf +/F{gsave {filler}fp grestore}bdf +/f{closepath F}bdf +/S{gsave {stroke}fp grestore}bdf +/s{closepath S}bdf +userdict /islevel2 +systemdict /languagelevel known dup +{ +pop systemdict /languagelevel get 2 ge +} if +put +islevel2 not +{ +/currentcmykcolor +{ +0 0 0 1 currentgray sub +} ndf +} if +/tc +{ +gsave +setcmykcolor currentcmykcolor +grestore +} bind def +/testCMYKColorThrough +{ +tc add add add 0 ne +} bind def +/fhiscomposite where not { +userdict /fhiscomposite +islevel2 +{ +gsave 1 1 1 1 setcmykcolor currentcmykcolor grestore +add add add 4 eq +} +{ +1 0 0 0 testCMYKColorThrough +0 1 0 0 testCMYKColorThrough +0 0 1 0 testCMYKColorThrough +0 0 0 1 testCMYKColorThrough +and and and +} ifelse +put +} +{ pop } +ifelse +/bc4 [0 0 0 0] def +/_lfp4 { +1 pop +/yt xdf +/xt xdf +/ang xdf +storerect +/taperfcn xdf +/k2 xdf /y2 xdf /m2 xdf /c2 xdf +/k1 xdf /y1 xdf /m1 xdf /c1 xdf +c1 c2 sub abs +m1 m2 sub abs +y1 y2 sub abs +k1 k2 sub abs +maxcolor +calcgraysteps mul abs round +height abs adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +currentflat mark +currentflat clipflatness +/delta top bottom sub numsteps1 1 add div def +/right right left sub def +/botsv top delta sub def +{ +{ +W +xt yt translate +ang rotate +xt neg yt neg translate +dup setflat +/bottom botsv def +0 1 numsteps1 +{ +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +taperfcn /frac xdf +bc4 0 c2 c1 sub frac mul c1 add put +bc4 1 m2 m1 sub frac mul m1 add put +bc4 2 y2 y1 sub frac mul y1 add put +bc4 3 k2 k1 sub frac mul k1 add put +bc4 vc +1 index setflat +{ +mark {newpath left bottom right delta rectfill}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +/bottom bottom delta sub def +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/bcs [0 0] def +/_lfs4 { +/yt xdf +/xt xdf +/ang xdf +storerect +/taperfcn xdf +/tint2 xdf +/tint1 xdf +bcs exch 1 exch put +tint1 tint2 sub abs +bcs 1 get maxspot +calcgraysteps mul abs round +height abs adjnumsteps +dup 2 lt {pop 2} if +1 sub /numsteps1 xdf +currentflat mark +currentflat clipflatness +/delta top bottom sub numsteps1 1 add div def +/right right left sub def +/botsv top delta sub def +{ +{ +W +xt yt translate +ang rotate +xt neg yt neg translate +dup setflat +/bottom botsv def +0 1 numsteps1 +{ +numsteps1 div taperfcn /frac xdf +bcs 0 +1.0 tint2 tint1 sub frac mul tint1 add sub +put bcs vc +1 index setflat +{ +mark {newpath left bottom right delta rectfill}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +/bottom bottom delta sub def +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/_rfs6 { +/tint2 xdf +/tint1 xdf +bcs exch 1 exch put +/inrad xdf +/radius xdf +/yt xdf +/xt xdf +tint1 tint2 sub abs +bcs 1 get maxspot +calcgraysteps mul abs round +radius inrad sub abs +adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse +2 div /halfstep xdf +currentflat mark +currentflat clipflatness +{ +{ +dup setflat +W +0 1 numsteps1 +{ +dup /radindex xdf +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +/frac xdf +bcs 0 +tint2 tint1 sub frac mul tint1 add +put bcs vc +1 index setflat +{ +newpath mark +xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360 +{ arc +radindex numsteps1 ne +inrad 0 gt or +{ +xt yt +numsteps1 0 eq +{ inrad } +{ +radindex 1 add numsteps1 div 1 exch sub +radius inrad sub mul halfstep add inrad add +}ifelse +dup xt add yt moveto +360 0 arcn +} if +fill +}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/_rfp6 { +1 pop +/k2 xdf /y2 xdf /m2 xdf /c2 xdf +/k1 xdf /y1 xdf /m1 xdf /c1 xdf +/inrad xdf +/radius xdf +/yt xdf +/xt xdf +c1 c2 sub abs +m1 m2 sub abs +y1 y2 sub abs +k1 k2 sub abs +maxcolor +calcgraysteps mul abs round +radius inrad sub abs +adjnumsteps +dup 1 lt {pop 1} if +1 sub /numsteps1 xdf +radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse +2 div /halfstep xdf +currentflat mark +currentflat clipflatness +{ +{ +dup setflat +W +0 1 numsteps1 +{ +dup /radindex xdf +numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse +/frac xdf +bc4 0 c2 c1 sub frac mul c1 add put +bc4 1 m2 m1 sub frac mul m1 add put +bc4 2 y2 y1 sub frac mul y1 add put +bc4 3 k2 k1 sub frac mul k1 add put +bc4 vc +1 index setflat +{ +newpath mark +xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360 +{ arc +radindex numsteps1 ne +inrad 0 gt or +{ +xt yt +numsteps1 0 eq +{ inrad } +{ +radindex 1 add numsteps1 div 1 exch sub +radius inrad sub mul halfstep add inrad add +}ifelse +dup xt add yt moveto +360 0 arcn +} if +fill +}stopped +{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if} +{cleartomark exit}ifelse +}loop +}for +} +gsave stopped grestore +{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if} +{exit}ifelse +}loop +cleartomark setflat +}bdf +/lfp4{_lfp4}ndf +/lfs4{_lfs4}ndf +/rfs6{_rfs6}ndf +/rfp6{_rfp6}ndf +/cvc [0 0 0 1] def +/vc{ +AltsysDict /cvc 2 index put +aload length dup 4 eq +{pop dup -1 eq{pop setrgbcolor}{setcmykcolor}ifelse} +{6 eq {sethexcolor} {setspotcolor} ifelse } +ifelse +}bdf +0 setseparationgray +/imgr {1692.47 1570.59 2287.75 2412.48 } def +/bleed 0 def +/clpr {1692.47 1570.59 2287.75 2412.48 } def +/xs 1 def +/ys 1 def +/botx 0 def +/overlap 0 def +/wdist 18 def +0 2 mul fhsetspreadsize +0 0 ne {/df 0 def /clipflatness 0 def} if +/maxsteps 256 def +/forcemaxsteps false def +/minsteps 0 def + +userdict begin /AGDOrigMtx matrix currentmatrix def end +vms +0.15 0.15 scale %JND +-1845 -2006 translate + +/currentpacking defed{false setpacking}if +/spots[ + +1 0 0 0 (Process Cyan) false newcmykcustomcolor + +0 1 0 0 (Process Magenta) false newcmykcustomcolor + +0 0 1 0 (Process Yellow) false newcmykcustomcolor + +0 0 0 1 (Process Black) false newcmykcustomcolor +]def +n +[] 0 d +3.863708 M +1 w +0 j +0 J +false setoverprint +0 i +false eomode +[0 0 0 1]vc +vms +1848.4365 2094.0422 m +1848.4365 2140.987 1886.4917 2179.0422 1933.4365 2179.0422 C +1980.3813 2179.0422 2018.4365 2140.987 2018.4365 2094.0422 C +2018.4365 2047.0974 1980.3813 2009.0422 1933.4365 2009.0422 C +1886.4917 2009.0422 1848.4365 2047.0974 1848.4365 2094.0422 C +5.3858 w +3.863693 M +s +n +true eomode +1897.6516 2067.1709 m +1897.6087 2066.5538 L +1885.3743 2066.1319 L +1883.1946 2062.4053 L +1869.9055 2063.9522 L +1869.9055 2067.1712 L +1897.6516 2067.1709 L +h +1944.0852 2067.1709 m +1944.0852 2067.0077 1944.0852 2066.8741 1944.0852 2066.7647 C +1944.1314 2066.5757 1944.1775 2066.4131 1944.2258 2066.2725 C +1945.0213 2065.0992 1946.0056 2064.2554 1947.179 2063.7413 C +1948.3963 2063.2249 1950.0134 2062.9678 1952.0305 2062.9678 C +1956.0142 2062.9678 1959.7627 2063.9522 1963.2805 2065.9209 C +1964.0204 2066.3353 1964.6824 2066.7527 1965.2665 2067.1732 C +1971.313 2067.1709 L +1970.2122 2065.693 1968.5893 2064.3153 1966.4446 2063.0381 C +1962.0369 2060.4585 1956.8821 2059.1709 1950.9758 2059.1709 C +1948.6775 2059.1709 1946.7791 2059.5445 1945.2805 2060.2959 C +1943.7798 2061.0914 1942.5142 2062.357 1941.4837 2064.0928 C +1941.2486 2064.0928 1940.8728 2064.0928 1940.3587 2064.0928 C +1937.5462 2063.9039 1935.4829 2063.8116 1934.1712 2063.8116 C +1929.2954 2063.8116 1925.1228 2064.2796 1921.6555 2065.2178 C +1919.9787 2065.6936 1918.2362 2066.3443 1916.4282 2067.1704 C +1944.0852 2067.1709 L +true setoverprint +f +false setoverprint +n +1884.4125 2075.1709 m +1884.4602 2073.585 L +1893.1087 2073.0225 L +1893.1087 2075.1712 L +1910.8456 2075.1709 L +1910.98 2075.0913 1911.1146 2075.0069 1911.2493 2074.9209 C +1911.9986 2074.3584 1912.583 2073.9585 1913.0071 2073.7256 C +1916.804 2071.4756 1920.2954 2069.9288 1923.4837 2069.085 C +1926.718 2068.2413 1931.0071 2067.8194 1936.3508 2067.8194 C +1940.3587 2067.8194 L +1940.7805 2070.7022 L +1938.9524 2070.8428 1937.522 2071.4053 1936.4915 2072.3897 C +1935.7726 2073.1422 1935.3163 2074.0693 1935.1223 2075.1726 C +1940.1696 2075.1709 L +1940.3293 2074.9768 1940.5095 2074.8018 1940.7102 2074.6397 C +1941.7407 2073.8421 1943.147 2073.4444 1944.929 2073.4444 C +1948.4128 2073.4444 1951.8259 2074.0193 1955.1674 2075.169 C +1963.5704 2075.1709 L +1962.8877 2074.843 1962.0411 2074.4337 1961.0305 2073.9366 C +1958.1697 2072.5303 1955.2166 2071.4976 1952.1712 2070.8428 C +1951.3274 2070.7022 1950.2244 2070.5132 1948.8665 2070.2803 C +1945.6782 2069.7178 1944.0852 2068.8038 1944.0852 2067.5381 C +1944.0852 2067.4017 1944.0852 2067.2776 1944.0852 2067.1658 C +1916.4282 2067.1709 L +1914.4953 2068.0535 1912.4877 2069.1369 1910.4055 2070.4209 C +1910.0759 2070.6539 1909.6321 2070.9593 1909.0696 2071.335 C +1905.9275 2073.5367 1902.9041 2074.6375 1899.9993 2074.6397 C +1899.9509 2074.6397 1899.6939 2074.6155 1899.2258 2074.5694 C +1898.7556 2074.521 1898.4041 2074.5452 1898.1712 2074.6397 C +1897.6516 2067.1709 L +1869.9055 2067.1709 L +1869.9055 2075.1714 L +1884.4125 2075.1709 L +h +1972.5022 2075.1709 m +1972.8687 2074.2606 1973.0523 2073.2652 1973.054 2072.1788 C +1973.054 2070.3983 1972.4736 2068.7289 1971.313 2067.1709 C +1965.2666 2067.1709 L +1967.4581 2068.751 1968.554 2070.3727 1968.554 2072.0381 C +1968.554 2073.0686 1968.2486 2073.9827 1967.6399 2074.7803 C +1967.5373 2074.922 1967.4334 2075.0518 1967.3283 2075.1698 C +1972.5022 2075.1709 L +true setoverprint +f +false setoverprint +n +1869.9055 2075.1709 m +1869.9055 2119.0772 L +1897.1868 2119.8506 L +1897.8899 2114.2256 L +1899.2962 2114.2256 L +1901.0759 2114.2256 1902.7876 2114.5069 1904.429 2115.0694 C +1906.1165 2115.678 1908.2478 2116.825 1910.8274 2118.5147 C +1911.9524 2119.2178 L +1919.5923 2124.1397 1925.4041 2126.6006 1929.3899 2126.6006 C +1930.8423 2126.6006 1932.3408 2126.3655 1933.8899 2125.8975 C +1935.4368 2125.4756 1937.1463 2124.7945 1939.0227 2123.8584 C +1940.1939 2123.9046 1941.8814 2123.9507 1944.0852 2123.9991 C +1950.0376 2124.0914 1954.0674 2124.1375 1956.179 2124.1397 C +1972.7244 2124.1397 1984.583 2123.1311 1991.7571 2121.1163 C +1998.9751 2119.1475 2002.583 2115.9351 2002.5852 2111.4834 C +2002.5852 2107.8272 2000.2869 2105.2959 1995.6946 2103.8897 C +1991.1463 2102.5296 1981.865 2101.8506 1967.8508 2101.8506 C +1963.5618 2101.8506 L +1964.6384 2100.8179 1965.4361 2099.8116 1965.9524 2098.8272 C +1966.4666 2097.8428 1966.7236 2096.8343 1966.7258 2095.8038 C +1966.7258 2095.3335 1966.6314 2094.7952 1966.4446 2094.1866 C +1966.2556 2093.6241 1965.9041 2092.8506 1965.3899 2091.8663 C +1967.1697 2091.1631 1968.5056 2090.1788 1969.3977 2088.9131 C +1970.2876 2087.6936 1970.7315 2086.1929 1970.7337 2084.4131 C +1970.7337 2083.521 1970.615 2082.6311 1970.3821 2081.7413 C +1970.147 2080.8492 1969.7954 2079.9593 1969.3274 2079.0694 C +1970.5447 2078.2256 1971.4588 2077.2171 1972.0696 2076.0459 C +1972.2346 2075.7625 1972.3788 2075.4685 1972.5022 2075.1642 C +1967.3284 2075.1709 L +1966.8077 2075.7539 1966.2562 2076.0459 1965.6712 2076.0459 C +1965.5191 2076.0459 1964.8189 2075.7521 1963.5704 2075.1643 C +1955.1674 2075.1709 L +1956.5004 2075.6277 1957.8219 2076.1778 1959.1321 2076.8194 C +1963.7727 2079.1155 1966.093 2081.5523 1966.093 2084.1319 C +1966.093 2085.303 1965.7173 2086.2632 1964.968 2087.0147 C +1964.2649 2087.764 1963.3508 2088.1375 1962.2258 2088.1397 C +1961.7556 2088.1397 1959.0838 2086.9905 1954.2102 2084.6944 C +1949.3806 2082.396 1944.4368 2080.6624 1939.3743 2079.4913 C +1939.2798 2079.3023 1939.2337 2079.0914 1939.2337 2078.8584 C +1939.2337 2078.6695 1939.2337 2078.3663 1939.2337 2077.9444 C +1939.2337 2076.8248 1939.5456 2075.8974 1940.1695 2075.1644 C +1935.1224 2075.1709 L +1935.0507 2075.5803 1935.0149 2076.012 1935.0149 2076.4678 C +1935.0149 2076.8414 1935.0369 2077.2391 1935.0852 2077.6631 C +1935.1775 2078.085 1935.294 2078.5992 1935.4368 2079.21 C +1934.7337 2079.21 L +1931.9673 2079.21 1929.7876 2080.0296 1928.1946 2081.6709 C +1926.5994 2083.3101 1925.804 2085.514 1925.804 2088.2803 C +1925.804 2088.9834 L +1924.3032 2088.6077 1922.9673 2088.3265 1921.7962 2088.1397 C +1920.6712 2087.9507 1919.6626 2087.8584 1918.7727 2087.8584 C +1916.8501 2087.8584 1914.9517 2088.232 1913.0774 2088.9834 C +1911.2493 2089.7789 1909.2102 2091.0906 1906.9602 2092.9209 C +1906.8196 2094.6084 L +1909.1619 2093.7647 1911.2713 2093.1077 1913.1477 2092.6397 C +1915.022 2092.2178 1916.7556 2092.0069 1918.3508 2092.0069 C +1920.6931 2092.0069 1922.9431 2092.521 1925.1008 2093.5538 C +1927.3025 2094.5843 1929.5986 2096.2476 1931.9915 2098.5459 C +1925.804 2107.7569 L +1927.0696 2109.4444 L +1928.4275 2108.3655 1930.2556 2106.7945 1932.554 2104.7334 C +1938.2251 2099.6226 1942.9361 2097.0694 1946.6868 2097.0694 C +1948.5149 2097.0694 1950.1782 2097.5132 1951.679 2098.4053 C +1953.2258 2099.2952 1953.9993 2100.1851 1953.9993 2101.0772 C +1953.9993 2101.6397 1952.9446 2103.1866 1950.8352 2105.7178 C +1948.772 2108.2491 1946.1946 2111.0374 1943.1008 2114.085 C +1939.4446 2117.6006 1936.7244 2119.8023 1934.9446 2120.6944 C +1933.2088 2121.6304 1931.3103 2122.0984 1929.2493 2122.1006 C +1925.3579 2122.1006 1920.3657 2120.0374 1914.2727 2115.9131 C +1913.5696 2115.4913 1913.0532 2115.1617 1912.7258 2114.9288 C +1909.6321 2112.8194 1907.1228 2111.4131 1905.2024 2110.71 C +1903.2798 2110.053 1901.2166 2109.7256 1899.0149 2109.7256 C +1898.0305 2109.7256 L +1898.0305 2078.6475 L +1899.8587 2078.6475 L +1903.4329 2078.6475 1907.0952 2077.4884 1910.8456 2075.1742 C +1893.1087 2075.1709 L +1893.1087 2115.7725 L +1883.1946 2115.6319 L +1884.4125 2075.171 L +1869.9055 2075.1709 L +h +1957.9368 2101.0772 m +1957.3259 2098.5459 1956.0603 2096.6695 1954.1399 2095.4522 C +1952.2634 2094.2327 1949.6399 2093.6241 1946.2649 2093.6241 C +1945.1861 2093.6241 1943.615 2093.9273 1941.554 2094.5381 C +1939.5369 2095.1929 1938.0383 2095.5203 1937.054 2095.5225 C +1935.3665 2095.5225 1933.679 2094.8194 1931.9915 2093.4131 C +1930.3501 2092.0069 1929.5305 2090.5765 1929.5305 2089.1241 C +1929.5305 2087.107 1930.0447 2085.5601 1931.0774 2084.4834 C +1932.1079 2083.4507 1933.6065 2082.9366 1935.5774 2082.9366 C +1937.5462 2082.9366 1940.1477 2083.4046 1943.3821 2084.3428 C +1946.6626 2085.3272 1949.9673 2086.5928 1953.2962 2088.1397 C +1956.3416 2089.5459 1958.5674 2090.8819 1959.9758 2092.1475 C +1961.3821 2093.4131 1962.0852 2094.6788 1962.0852 2095.9444 C +1962.0852 2096.8343 1961.7556 2097.678 1961.1008 2098.4756 C +1960.4439 2099.3194 1959.3892 2100.1851 1957.9368 2101.0772 C +h +1943.3821 2119.71 m +1946.054 2117.1788 1948.3501 2114.8584 1950.2727 2112.7491 C +1952.2415 2110.6397 1954.0213 2108.5303 1955.6165 2106.4209 C +1958.5696 2106.1397 1961.2876 2105.9288 1963.7727 2105.7881 C +1966.304 2105.6475 1968.6243 2105.5772 1970.7337 2105.5772 C +1980.7642 2105.5772 1987.7471 2106.021 1991.6868 2106.9131 C +1995.6704 2107.803 1997.6611 2109.3719 1997.6633 2111.6241 C +1997.6633 2114.4366 1994.2883 2116.5459 1987.5383 2117.9522 C +1980.8345 2119.4046 1970.8259 2120.1297 1957.5149 2120.1319 C +1955.4055 2120.1319 1953.1555 2120.0835 1950.7649 2119.9913 C +1948.4204 2119.9429 1945.9595 2119.8506 1943.3821 2119.71 C +true setoverprint +f +false setoverprint +n +vmr +vmr +end +%%Trailer diff --git a/docs/docbook/xslt/figures/tip.pdf b/docs/docbook/xslt/figures/tip.pdf Binary files differnew file mode 100644 index 0000000000..54f5dedb5d --- /dev/null +++ b/docs/docbook/xslt/figures/tip.pdf diff --git a/docs/docbook/xslt/figures/warning.eps b/docs/docbook/xslt/figures/warning.eps new file mode 100644 index 0000000000..0c10b371b1 --- /dev/null +++ b/docs/docbook/xslt/figures/warning.eps @@ -0,0 +1 @@ +%!PS-Adobe-2.0 EPSF-1.2
%%Title: Untitled-3
%%Creator: FreeHand 9.0
%%CreationDate: 2002/12/05 8:20 PM
%%BoundingBox: 0 0 29 29
%%FHPathName:Untitled:FreeHand 9:English:Untitled-3
%ALDOriginalFile:Untitled:FreeHand 9:English:Untitled-3
%ALDBoundingBox: -2 -2 29 29
%%FHPageNum:1
%%DocumentSuppliedResources: procset Altsys_header 4 0
%%ColorUsage: Color
%%DocumentProcessColors: Black
%%EndComments
%%BeginResource: procset Altsys_header 4 0
userdict begin /AltsysDict 300 dict def end
AltsysDict begin
/bdf{bind def}bind def
/xdf{exch def}bdf
/defed{where{pop true}{false}ifelse}bdf
/ndf{1 index where{pop pop pop}{dup xcheck{bind}if def}ifelse}bdf
/d{setdash}bdf
/h{closepath}bdf
/H{}bdf
/J{setlinecap}bdf
/j{setlinejoin}bdf
/M{setmiterlimit}bdf
/n{newpath}bdf
/N{newpath}bdf
/q{gsave}bdf
/Q{grestore}bdf
/w{setlinewidth}bdf
/Xic{matrix invertmatrix concat}bdf
/Xq{matrix currentmatrix mark}bdf
/XQ{cleartomark setmatrix}bdf
/sepdef{
dup where not
{
AltsysSepDict
}
if
3 1 roll exch put
}bdf
/st{settransfer}bdf
/colorimage defed /_rci xdf
/cntr 0 def
/readbinarystring{
/cntr 0 def
2 copy readstring
{
{
dup
(\034) search
{
length exch pop exch
dup length 0 ne
{
dup dup 0 get 32 sub 0 exch put
/cntr cntr 1 add def
}
{
pop 1 string dup
0 6 index read pop 32 sub put
}ifelse
3 copy
putinterval pop
1 add
1 index length 1 sub
1 index sub
dup 0 le {pop pop exit}if
getinterval
}
{
pop exit
} ifelse
} loop
}if
cntr 0 gt
{
pop 2 copy
dup length cntr sub cntr getinterval
readbinarystring
} if
pop exch pop
} bdf
/_NXLevel2 defed {
_NXLevel2 not {
/colorimage where {
userdict eq {
/_rci false def
} if
} if
} if
} if
/md defed{
md type /dicttype eq {
/colorimage where {
md eq {
/_rci false def
}if
}if
/settransfer where {
md eq {
/st systemdict /settransfer get def
}if
}if
}if
}if
/setstrokeadjust defed
{
true setstrokeadjust
/C{curveto}bdf
/L{lineto}bdf
/m{moveto}bdf
}
{
/dr{transform .25 sub round .25 add
exch .25 sub round .25 add exch itransform}bdf
/C{dr curveto}bdf
/L{dr lineto}bdf
/m{dr moveto}bdf
/setstrokeadjust{pop}bdf
}ifelse
/privrectpath {
4 -2 roll m
dtransform round exch round exch idtransform
2 copy 0 lt exch 0 lt xor
{dup 0 exch rlineto exch 0 rlineto neg 0 exch rlineto}
{exch dup 0 rlineto exch 0 exch rlineto neg 0 rlineto}
ifelse
closepath
}bdf
/rectclip{newpath privrectpath clip newpath}def
/rectfill{gsave newpath privrectpath fill grestore}def
/rectstroke{gsave newpath privrectpath stroke grestore}def
/_fonthacksave false def
/currentpacking defed
{
/_bfh {/_fonthacksave currentpacking def false setpacking} bdf
/_efh {_fonthacksave setpacking} bdf
}
{
/_bfh {} bdf
/_efh {} bdf
}ifelse
/packedarray{array astore readonly}ndf
/`
{
false setoverprint
/-save0- save def
5 index concat
pop
storerect left bottom width height rectclip
pop
/MMdict_count countdictstack def
/MMop_count count 1 sub def
userdict begin
/showpage {} def
0 setgray 0 setlinecap 1 setlinewidth
0 setlinejoin 10 setmiterlimit [] 0 setdash newpath
} bdf
/currentpacking defed{true setpacking}if
/min{2 copy gt{exch}if pop}bdf
/max{2 copy lt{exch}if pop}bdf
/xformfont { currentfont exch makefont setfont } bdf
/fhnumcolors 1
statusdict begin
/processcolors defed
{
pop processcolors
}
{
/deviceinfo defed {
deviceinfo /Colors known {
pop deviceinfo /Colors get
} if
} if
} ifelse
end
def
/printerRes
gsave
matrix defaultmatrix setmatrix
72 72 dtransform
abs exch abs
max
grestore
def
/graycalcs
[
{Angle Frequency}
{GrayAngle GrayFrequency}
{0 Width Height matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
{0 GrayWidth GrayHeight matrix defaultmatrix idtransform
dup mul exch dup mul add sqrt 72 exch div}
] def
/calcgraysteps {
forcemaxsteps
{
maxsteps
}
{
/currenthalftone defed
{currenthalftone /dicttype eq}{false}ifelse
{
currenthalftone begin
HalftoneType 4 le
{graycalcs HalftoneType 1 sub get exec}
{
HalftoneType 5 eq
{
Default begin
{graycalcs HalftoneType 1 sub get exec}
end
}
{0 60}
ifelse
}
ifelse
end
}
{
currentscreen pop exch
}
ifelse
printerRes 300 max exch div exch
2 copy
sin mul round dup mul
3 1 roll
cos mul round dup mul
add 1 add
dup maxsteps gt {pop maxsteps} if
dup minsteps lt {pop minsteps} if
}
ifelse
} bdf
/nextrelease defed {
/languagelevel defed not {
/framebuffer defed {
0 40 string framebuffer 9 1 roll 8 {pop} repeat
dup 516 eq exch 520 eq or
{
/fhnumcolors 3 def
/currentscreen {60 0 {pop pop 1}}bdf
/calcgraysteps {maxsteps} bdf
}if
}if
}if
}if
fhnumcolors 1 ne {
/calcgraysteps {maxsteps} bdf
} if
/currentpagedevice defed {
currentpagedevice /PreRenderingEnhance known
{
currentpagedevice /PreRenderingEnhance get
{
/calcgraysteps
{
forcemaxsteps
{maxsteps}
{256 maxsteps min}
ifelse
} def
} if
} if
} if
/gradfrequency 144 def
printerRes 1000 lt {
/gradfrequency 72 def
} if
/adjnumsteps {
dup dtransform abs exch abs max
printerRes div
gradfrequency mul
round
5 max
min
}bdf
/goodsep {
spots exch get 4 get dup sepname eq exch (_vc_Registration) eq or
}bdf
/BeginGradation defed
{/bb{BeginGradation}bdf}
{/bb{}bdf}
ifelse
/EndGradation defed
{/eb{EndGradation}bdf}
{/eb{}bdf}
ifelse
/bottom -0 def
/delta -0 def
/frac -0 def
/height -0 def
/left -0 def
/numsteps1 -0 def
/radius -0 def
/right -0 def
/top -0 def
/width -0 def
/xt -0 def
/yt -0 def
/df currentflat def
/tempstr 1 string def
/clipflatness currentflat def
/inverted?
0 currenttransfer exec .5 ge def
/tc1 [0 0 0 1] def
/tc2 [0 0 0 1] def
/storerect{/top xdf /right xdf /bottom xdf /left xdf
/width right left sub def /height top bottom sub def}bdf
/concatprocs{
systemdict /packedarray known
{dup type /packedarraytype eq 2 index type /packedarraytype eq or}{false}ifelse
{
/proc2 exch cvlit def /proc1 exch cvlit def
proc1 aload pop proc2 aload pop
proc1 length proc2 length add packedarray cvx
}
{
/proc2 exch cvlit def /proc1 exch cvlit def
/newproc proc1 length proc2 length add array def
newproc 0 proc1 putinterval newproc proc1 length proc2 putinterval
newproc cvx
}ifelse
}bdf
/i{dup 0 eq
{pop df dup}
{dup} ifelse
/clipflatness xdf setflat
}bdf
version cvr 38.0 le
{/setrgbcolor{
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
currenttransfer exec 3 1 roll
setrgbcolor}bdf}if
/vms {/vmsv save def} bdf
/vmr {vmsv restore} bdf
/vmrs{vmsv restore /vmsv save def}bdf
/eomode{
{/filler /eofill load def /clipper /eoclip load def}
{/filler /fill load def /clipper /clip load def}
ifelse
}bdf
/normtaper{}bdf
/logtaper{9 mul 1 add log}bdf
/CD{
/NF exch def
{
exch dup
/FID ne 1 index/UniqueID ne and
{exch NF 3 1 roll put}
{pop pop}
ifelse
}forall
NF
}bdf
/MN{
1 index length
/Len exch def
dup length Len add
string dup
Len
4 -1 roll
putinterval
dup
0
4 -1 roll
putinterval
}bdf
/RC{4 -1 roll /ourvec xdf 256 string cvs(|______)anchorsearch
{1 index MN cvn/NewN exch def cvn
findfont dup maxlength dict CD dup/FontName NewN put dup
/Encoding ourvec put NewN exch definefont pop}{pop}ifelse}bdf
/RF{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RC}
ifelse
}bdf
/FF{dup 256 string cvs(|______)exch MN cvn dup FontDirectory exch known
{exch pop findfont 3 -1 roll pop}
{pop dup findfont dup maxlength dict CD dup dup
/Encoding exch /Encoding get 256 array copy 7 -1 roll
{3 -1 roll dup 4 -2 roll put}forall put definefont}
ifelse}bdf
/RCJ{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFJ
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFJ{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCJ}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFJ
{
dup
hasfont
not
{
pop
/Ryumin-Light-83pv-RKSJ-H
hasfont
{
/Ryumin-Light-83pv-RKSJ-H
}
{
/Courier
}
ifelse
}
if
}bdf
/FFJ{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFJ
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/GS {
dup
hasfont
{
findfont
exch makesetfont
exch
pop
ts
}
{
pop pop pop
ts
} ifelse
} bdf
/RCK{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFK
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFK{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCK}
ifelse
}bdf
/hasfont
{
/resourcestatus where
{
pop
/Font resourcestatus
{
pop pop true
}
{
false
}
ifelse
}
{
dup FontDirectory exch known
{pop true}
{
256 string
cvs
(fonts/) exch MN
status
{pop pop pop pop true}
{false}
ifelse
}
ifelse
}
ifelse
}bdf
/FDFK
{
dup
hasfont
not
{
pop
/JCsm
hasfont
{
/JCsm
}
{
/Courier
}
ifelse
}
if
}bdf
/FFK{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFK
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/RCTC{4 -1 roll
/ourvec xdf
256 string cvs
(|______) anchorsearch
{pop
cvn
dup FDFTC
exch
1 index
eq
{
_bfh findfont _efh
dup
maxlength dict
CD
dup
/FontName
3 index
put
dup
/Encoding ourvec put
1 index
exch
definefont
pop
}
{exch pop}
ifelse
}
{pop}
ifelse
}bdf
/RFTC{
dup
FontDirectory exch
known
{pop 3 -1 roll pop}
{RCTC}
ifelse
}bdf
/FDFTC
{
dup
hasfont
not
{
pop
/DFMing-Lt-HK-BF
hasfont
{
/DFMing-Lt-HK-BF
}
{
/Courier
}
ifelse
}
if
}bdf
/FFTC{
_bfh
dup
256 string cvs
(|______)exch MN
cvn
dup
FontDirectory
exch known
{
exch
pop
findfont
3 -1 roll
pop
}
{
pop
FDFTC
dup findfont
dup maxlength dict
CD
dup dup
/Encoding exch
/Encoding get
256 array copy
7 -1 roll
{
3 -1 roll
dup
4 -2 roll
put
}forall
put
definefont
}
ifelse
_efh
}bdf
/fps{
currentflat
exch
dup 0 le{pop 1}if
{
dup setflat 3 index stopped
{1.3 mul dup 3 index gt{pop setflat pop pop stop}if}
{exit}
ifelse
}loop
pop setflat pop pop
}bdf
/fp{100 currentflat fps}bdf
/clipper{clip}bdf
/W{/clipper load 100 clipflatness dup setflat fps}bdf
userdict begin /BDFontDict 29 dict def end
BDFontDict begin
/bu{}def
/bn{}def
/setTxMode{av 70 ge{pop}if pop}def
/gm{m}def
/show{pop}def
/gr{pop}def
/fnt{pop pop pop}def
/fs{pop}def
/fz{pop}def
/lin{pop pop}def
/:M {pop pop} def
/sf {pop} def
/S {pop} def
/@b {pop pop pop pop pop pop pop pop} def
/_bdsave /save load def
/_bdrestore /restore load def
/save { dup /fontsave eq {null} {_bdsave} ifelse } def
/restore { dup null eq { pop } { _bdrestore } ifelse } def
/fontsave null def
end
/MacVec 256 array def
MacVec 0 /Helvetica findfont
/Encoding get 0 128 getinterval putinterval
MacVec 127 /DEL put MacVec 16#27 /quotesingle put MacVec 16#60 /grave put
/NUL/SOH/STX/ETX/EOT/ENQ/ACK/BEL/BS/HT/LF/VT/FF/CR/SO/SI
/DLE/DC1/DC2/DC3/DC4/NAK/SYN/ETB/CAN/EM/SUB/ESC/FS/GS/RS/US
MacVec 0 32 getinterval astore pop
/Adieresis/Aring/Ccedilla/Eacute/Ntilde/Odieresis/Udieresis/aacute
/agrave/acircumflex/adieresis/atilde/aring/ccedilla/eacute/egrave
/ecircumflex/edieresis/iacute/igrave/icircumflex/idieresis/ntilde/oacute
/ograve/ocircumflex/odieresis/otilde/uacute/ugrave/ucircumflex/udieresis
/dagger/degree/cent/sterling/section/bullet/paragraph/germandbls
/registered/copyright/trademark/acute/dieresis/notequal/AE/Oslash
/infinity/plusminus/lessequal/greaterequal/yen/mu/partialdiff/summation
/product/pi/integral/ordfeminine/ordmasculine/Omega/ae/oslash
/questiondown/exclamdown/logicalnot/radical/florin/approxequal/Delta/guillemotleft
/guillemotright/ellipsis/nbspace/Agrave/Atilde/Otilde/OE/oe
/endash/emdash/quotedblleft/quotedblright/quoteleft/quoteright/divide/lozenge
/ydieresis/Ydieresis/fraction/currency/guilsinglleft/guilsinglright/fi/fl
/daggerdbl/periodcentered/quotesinglbase/quotedblbase
/perthousand/Acircumflex/Ecircumflex/Aacute
/Edieresis/Egrave/Iacute/Icircumflex/Idieresis/Igrave/Oacute/Ocircumflex
/apple/Ograve/Uacute/Ucircumflex/Ugrave/dotlessi/circumflex/tilde
/macron/breve/dotaccent/ring/cedilla/hungarumlaut/ogonek/caron
MacVec 128 128 getinterval astore pop
/findheaderfont {
/Helvetica findfont
} def
end %. AltsysDict
%%EndResource
%%EndProlog
%%BeginSetup
AltsysDict begin
_bfh
_efh
end %. AltsysDict
%%EndSetup
AltsysDict begin
/onlyk4{false}ndf
/ccmyk{dup 5 -1 roll sub 0 max exch}ndf
/cmyk2gray{
4 -1 roll 0.3 mul 4 -1 roll 0.59 mul 4 -1 roll 0.11 mul
add add add 1 min neg 1 add
}bdf
/setcmykcolor{1 exch sub ccmyk ccmyk ccmyk pop setrgbcolor}ndf
/maxcolor {
max max max
} ndf
/maxspot {
pop
} ndf
/setcmykcoloroverprint{4{dup -1 eq{pop 0}if 4 1 roll}repeat setcmykcolor}ndf
/findcmykcustomcolor{5 packedarray}ndf
/setcustomcolor{exch aload pop pop 4{4 index mul 4 1 roll}repeat setcmykcolor pop}ndf
/setseparationgray{setgray}ndf
/setoverprint{pop}ndf
/currentoverprint false ndf
/cmykbufs2gray{
0 1 2 index length 1 sub
{
4 index 1 index get 0.3 mul
4 index 2 index get 0.59 mul
4 index 3 index get 0.11 mul
4 index 4 index get
add add add cvi 255 min
255 exch sub
2 index 3 1 roll put
}for
4 1 roll pop pop pop
}bdf
/colorimage{
pop pop
[
5 -1 roll/exec cvx
6 -1 roll/exec cvx
7 -1 roll/exec cvx
8 -1 roll/exec cvx
/cmykbufs2gray cvx
]cvx
image
}
%. version 47.1 on Linotronic of Postscript defines colorimage incorrectly (rgb model only)
version cvr 47.1 le
statusdict /product get (Lino) anchorsearch{pop pop true}{pop false}ifelse
and{userdict begin bdf end}{ndf}ifelse
fhnumcolors 1 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
ic im iy ik cmyk2gray /xt xdf
currenttransfer
{dup 1.0 exch sub xt mul add}concatprocs
st
image
}
ifelse
}ndf
fhnumcolors 1 ne {yt restore} if
fhnumcolors 3 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
1.0 dup ic ik add min sub
1.0 dup im ik add min sub
1.0 dup iy ik add min sub
/ic xdf /iy xdf /im xdf
currentcolortransfer
4 1 roll
{dup 1.0 exch sub ic mul add}concatprocs 4 1 roll
{dup 1.0 exch sub iy mul add}concatprocs 4 1 roll
{dup 1.0 exch sub im mul add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}true 3 colorimage
}
ifelse
}ndf
fhnumcolors 3 ne {yt restore} if
fhnumcolors 4 ne {/yt save def} if
/customcolorimage{
aload pop
(_vc_Registration) eq
{
pop pop pop pop separationimage
}
{
/ik xdf /iy xdf /im xdf /ic xdf
currentcolortransfer
{1.0 exch sub ik mul ik sub 1 add}concatprocs 4 1 roll
{1.0 exch sub iy mul iy sub 1 add}concatprocs 4 1 roll
{1.0 exch sub im mul im sub 1 add}concatprocs 4 1 roll
{1.0 exch sub ic mul ic sub 1 add}concatprocs 4 1 roll
setcolortransfer
{/dummy xdf dummy}concatprocs{dummy}{dummy}{dummy}
true 4 colorimage
}
ifelse
}ndf
fhnumcolors 4 ne {yt restore} if
/separationimage{image}ndf
/spotascmyk false ndf
/newcmykcustomcolor{6 packedarray}ndf
/inkoverprint false ndf
/setinkoverprint{pop}ndf
/setspotcolor {
spots exch get
dup 4 get (_vc_Registration) eq
{pop 1 exch sub setseparationgray}
{0 5 getinterval exch setcustomcolor}
ifelse
}ndf
/currentcolortransfer{currenttransfer dup dup dup}ndf
/setcolortransfer{st pop pop pop}ndf
/fas{}ndf
/sas{}ndf
/fhsetspreadsize{pop}ndf
/filler{fill}bdf
/F{gsave {filler}fp grestore}bdf
/f{closepath F}bdf
/S{gsave {stroke}fp grestore}bdf
/s{closepath S}bdf
userdict /islevel2
systemdict /languagelevel known dup
{
pop systemdict /languagelevel get 2 ge
} if
put
islevel2 not
{
/currentcmykcolor
{
0 0 0 1 currentgray sub
} ndf
} if
/tc
{
gsave
setcmykcolor currentcmykcolor
grestore
} bind def
/testCMYKColorThrough
{
tc add add add 0 ne
} bind def
/fhiscomposite where not {
userdict /fhiscomposite
islevel2
{
gsave 1 1 1 1 setcmykcolor currentcmykcolor grestore
add add add 4 eq
}
{
1 0 0 0 testCMYKColorThrough
0 1 0 0 testCMYKColorThrough
0 0 1 0 testCMYKColorThrough
0 0 0 1 testCMYKColorThrough
and and and
} ifelse
put
}
{ pop }
ifelse
/bc4 [0 0 0 0] def
/_lfp4 {
1 pop
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
height abs adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
taperfcn /frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/bcs [0 0] def
/_lfs4 {
/yt xdf
/xt xdf
/ang xdf
storerect
/taperfcn xdf
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
height abs adjnumsteps
dup 2 lt {pop 2} if
1 sub /numsteps1 xdf
currentflat mark
currentflat clipflatness
/delta top bottom sub numsteps1 1 add div def
/right right left sub def
/botsv top delta sub def
{
{
W
xt yt translate
ang rotate
xt neg yt neg translate
dup setflat
/bottom botsv def
0 1 numsteps1
{
numsteps1 div taperfcn /frac xdf
bcs 0
1.0 tint2 tint1 sub frac mul tint1 add sub
put bcs vc
1 index setflat
{
mark {newpath left bottom right delta rectfill}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
/bottom bottom delta sub def
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfs6 {
/tint2 xdf
/tint1 xdf
bcs exch 1 exch put
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
tint1 tint2 sub abs
bcs 1 get maxspot
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bcs 0
tint2 tint1 sub frac mul tint1 add
put bcs vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/_rfp6 {
1 pop
/k2 xdf /y2 xdf /m2 xdf /c2 xdf
/k1 xdf /y1 xdf /m1 xdf /c1 xdf
/inrad xdf
/radius xdf
/yt xdf
/xt xdf
c1 c2 sub abs
m1 m2 sub abs
y1 y2 sub abs
k1 k2 sub abs
maxcolor
calcgraysteps mul abs round
radius inrad sub abs
adjnumsteps
dup 1 lt {pop 1} if
1 sub /numsteps1 xdf
radius inrad sub numsteps1 dup 0 eq {pop} {div} ifelse
2 div /halfstep xdf
currentflat mark
currentflat clipflatness
{
{
dup setflat
W
0 1 numsteps1
{
dup /radindex xdf
numsteps1 dup 0 eq {pop pop 0.5} {div} ifelse
/frac xdf
bc4 0 c2 c1 sub frac mul c1 add put
bc4 1 m2 m1 sub frac mul m1 add put
bc4 2 y2 y1 sub frac mul y1 add put
bc4 3 k2 k1 sub frac mul k1 add put
bc4 vc
1 index setflat
{
newpath mark
xt yt radius inrad sub 1 frac sub mul halfstep add inrad add 0 360
{ arc
radindex numsteps1 ne
inrad 0 gt or
{
xt yt
numsteps1 0 eq
{ inrad }
{
radindex 1 add numsteps1 div 1 exch sub
radius inrad sub mul halfstep add inrad add
}ifelse
dup xt add yt moveto
360 0 arcn
} if
fill
}stopped
{cleartomark exch 1.3 mul dup setflat exch 2 copy gt{stop}if}
{cleartomark exit}ifelse
}loop
}for
}
gsave stopped grestore
{exch pop 2 index exch 1.3 mul dup 100 gt{cleartomark setflat stop}if}
{exit}ifelse
}loop
cleartomark setflat
}bdf
/lfp4{_lfp4}ndf
/lfs4{_lfs4}ndf
/rfs6{_rfs6}ndf
/rfp6{_rfp6}ndf
/cvc [0 0 0 1] def
/vc{
AltsysDict /cvc 2 index put
aload length dup 4 eq
{pop dup -1 eq{pop setrgbcolor}{setcmykcolor}ifelse}
{6 eq {sethexcolor} {setspotcolor} ifelse }
ifelse
}bdf
0 setseparationgray
/imgr {1692.47 1570.59 1723.65 1601.77 } def
/bleed 0 def
/clpr {1692.47 1570.59 1723.65 1601.77 } def
/xs 1 def
/ys 1 def
/botx 0 def
/overlap 0 def
/wdist 18 def
0 2 mul fhsetspreadsize
0 0 ne {/df 0 def /clipflatness 0 def} if
/maxsteps 256 def
/forcemaxsteps false def
/minsteps 0 def
userdict begin /AGDOrigMtx matrix currentmatrix def end
vms
-1694 -1572 translate
/currentpacking defed{false setpacking}if
/spots[
1 0 0 0 (Process Cyan) false newcmykcustomcolor
0 1 0 0 (Process Magenta) false newcmykcustomcolor
0 0 1 0 (Process Yellow) false newcmykcustomcolor
0 0 0 1 (Process Black) false newcmykcustomcolor
]def
n
[] 0 d
3.863708 M
1 w
0 j
0 J
false setoverprint
0 i
false eomode
[0 0 0 1]vc
vms
q
[1 0 0 1 -249.981674 -586.867554] concat
vms
1946.9506 2177.5114 m
1954.4907 2185.0516 L
1956.7047 2187.2656 1960.2943 2187.2656 1962.5083 2185.0516 C
1970.0485 2177.5114 L
1972.2625 2175.2974 1972.2625 2171.7078 1970.0485 2169.4938 C
1962.5083 2161.9537 L
1960.2943 2159.7396 1956.7047 2159.7396 1954.4907 2161.9537 C
1946.9506 2169.4938 L
1944.7365 2171.7078 1944.7365 2175.2974 1946.9506 2177.5114 C
s
n
true eomode
1958.5469 2181.0039 m
1959.2148 2181.0039 1959.7012 2180.9296 1960.0059 2180.7813 C
1960.3142 2180.6326 1960.4684 2180.363 1960.4688 2179.9727 C
1960.4688 2179.7383 1960.3398 2178.8026 1960.082 2177.166 C
1959.0742 2170.4219 L
1958.9373 2170.3241 1958.7615 2170.2754 1958.5469 2170.2754 C
1958.3319 2170.2754 1958.1561 2170.3241 1958.0195 2170.4219 C
1957.0117 2177.166 L
1956.7539 2178.8026 1956.625 2179.7379 1956.625 2179.9727 C
1956.625 2180.363 1956.7792 2180.6326 1957.0879 2180.7813 C
1957.4003 2180.9296 1957.8866 2181.0035 1958.5469 2181.0039 C
h
1958.5469 2165.166 m
1958.0389 2165.166 1957.5878 2165.3499 1957.1934 2165.7168 C
1956.7986 2166.0837 1956.6016 2166.5485 1956.6016 2167.1113 C
1956.6016 2167.6698 1956.7891 2168.1404 1957.1641 2168.5234 C
1957.5427 2168.9102 1958.0038 2169.1035 1958.5469 2169.1035 C
1959.1094 2169.1035 1959.5741 2168.9043 1959.9414 2168.5059 C
1960.3083 2168.1074 1960.4918 2167.6423 1960.4922 2167.1113 C
1960.4922 2166.748 1960.4102 2166.4177 1960.2461 2166.1211 C
1960.082 2165.8241 1959.8513 2165.5916 1959.5547 2165.4238 C
1959.2577 2165.2521 1958.9219 2165.1664 1958.5469 2165.166 C
true setoverprint
f
false setoverprint
n
vmr
Q
false eomode
vmr
vmr
end
%%Trailer
\ No newline at end of file diff --git a/docs/docbook/xslt/figures/warning.pdf b/docs/docbook/xslt/figures/warning.pdf Binary files differnew file mode 100644 index 0000000000..a0afabfa23 --- /dev/null +++ b/docs/docbook/xslt/figures/warning.pdf diff --git a/docs/docbook/xslt/html-chunk.xsl b/docs/docbook/xslt/html-chunk.xsl new file mode 100644 index 0000000000..2bc8b426b5 --- /dev/null +++ b/docs/docbook/xslt/html-chunk.xsl @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- This file is generated from param.xweb; do not edit this file! --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> + +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/> +<xsl:import href="html-common.xsl"/> +<xsl:param name="chunk.first.sections" select="1"/> +<xsl:param name="chunk.quietly" select="0"/> +<xsl:param name="chunk.section.depth" select="0"/> +<xsl:param name="chunk.toc" select="''"/> +<xsl:param name="chunk.tocs.and.lots" select="0"/> + +</xsl:stylesheet>
\ No newline at end of file diff --git a/docs/docbook/xslt/html-common.xsl b/docs/docbook/xslt/html-common.xsl new file mode 100644 index 0000000000..03fa5d5ec1 --- /dev/null +++ b/docs/docbook/xslt/html-common.xsl @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- This file is generated from param.xweb; do not edit this file! --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> + +<xsl:param name="base.dir" select="'../htmldocs/'"/> +<xsl:param name="bridgehead.in.toc" select="1"/> +<xsl:param name="citerefentry.link" select="'1'"/> +<xsl:param name="css.decoration" select="1"/> +<xsl:param name="html.stylesheet" select="'samba.css'"/> +<xsl:param name="html.stylesheet.type">text/css</xsl:param> +<xsl:param name="use.extensions" select="'0'"/> +<xsl:param name="use.id.as.filename" select="'1'"/> +<xsl:param name="use.local.olink.style" select="1"/> +<xsl:param name="use.role.as.xrefstyle" select="1"/> +<xsl:param name="use.role.for.mediaobject" select="1"/> + +<xsl:template name="generate.citerefentry.link"> + <xsl:value-of select="refentrytitle"/><xsl:text>.</xsl:text><xsl:value-of select="manvolnum"/><xsl:text>.html</xsl:text> +</xsl:template> + +</xsl:stylesheet>
\ No newline at end of file diff --git a/docs/docbook/xslt/html.xsl b/docs/docbook/xslt/html.xsl new file mode 100644 index 0000000000..c5d8db89ed --- /dev/null +++ b/docs/docbook/xslt/html.xsl @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- This file is generated from param.xweb; do not edit this file! --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> + +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"/> +<xsl:import href="html-common.xsl"/> + +</xsl:stylesheet>
\ No newline at end of file diff --git a/docs/docbook/xslt/html/samba.css b/docs/docbook/xslt/html/samba.css new file mode 100644 index 0000000000..3d926e8e74 --- /dev/null +++ b/docs/docbook/xslt/html/samba.css @@ -0,0 +1,80 @@ +BODY { + font-family: helvetica, arial, lucida sans, sans-serif; + background-color: white; +} + +H1, H2, H3 { + color: blue; + font-size: 120%; + padding: 2px; + margin-top: 0px; +} + +H1 { + background-color: #EEEEFF; + color: blue; +} + +H2 { + background-color: #DDDDFF; + color: blue; +} + +H3 { + background-color: #CCCCFF; + color: blue; +} + +H4 { + color: blue; +} + +TR.qandadiv TD { + padding-top: 1em; +} + +DIV.navhead { + font-size: 80%; +} + +A:link { + color: #36F; +} + +A:visited { + color: #96C; +} + +A:active { + color: #F63; +} + +TR.question { + color: #33C; + font-weight: bold; +} + +TR.question TD { + padding-top: 1em; +} + +DIV.variablelist { + padding-left: 2em; + color: #33C; +} + +P { + color: black; +} + +DIV.note, DIV.warning, DIV.caution, DIV.tip, DIV.important { + border: dashed 1px; + background-color: #EEEEFF; + width: 40em; +} + +PRE.programlisting, PRE.screen { + border: #630 1px dashed; + color: #630; +} + diff --git a/docs/docbook/xslt/latex.xsl b/docs/docbook/xslt/latex.xsl new file mode 100644 index 0000000000..158c5879db --- /dev/null +++ b/docs/docbook/xslt/latex.xsl @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version='1.0'> +<xsl:import href="db2latex/docbook.xsl"/> +<xsl:import href="table.mod.xsl"/> +<xsl:import href="lists.mod.xsl"/> + +<xsl:output method="text" encoding="ISO-8859-1" indent="yes"/> +<xsl:variable name="latex.documentclass">xslt/latex/sambadoc</xsl:variable> +<xsl:variable name="latex.documentclass.common">english,final,titlepage</xsl:variable> +<xsl:variable name="latex.documentclass.book"></xsl:variable> +<xsl:variable name="latex.hyperref.param.pdftex">hyperfigures,hyperindex,citecolor=blue,urlcolor=blue</xsl:variable> +<xsl:variable name="latex.document.font">default</xsl:variable> +<xsl:variable name="latex.admonition.path">xslt/figures</xsl:variable> +<xsl:variable name="latex.hyphenation.tttricks">1</xsl:variable> +<xsl:variable name="latex.use.tabularx">1</xsl:variable> +<xsl:param name="latex.babel.language">english</xsl:param> +<xsl:param name="ulink.url">1</xsl:param> + +<xsl:variable name="latex.book.preamble.post">\fancyhf{} +\fancyhead[RE]{\slshape \rightmark} +\fancyhead[LO]{\slshape \leftmark} +\fancyfoot[R]{\thepage} +</xsl:variable> + +<xsl:template match="//title/filename|//title/command"> + <xsl:variable name="content"> + <xsl:apply-templates/> + </xsl:variable> + <xsl:if test="$content != ''"> + <xsl:value-of select="$content" /> + </xsl:if> +</xsl:template> + +</xsl:stylesheet> + diff --git a/docs/docbook/xslt/latex/sambadoc.cls b/docs/docbook/xslt/latex/sambadoc.cls new file mode 100644 index 0000000000..e03dcf7a24 --- /dev/null +++ b/docs/docbook/xslt/latex/sambadoc.cls @@ -0,0 +1,124 @@ +%%--------------------------------------------------- +%%-- RC Thesis +%%--------------------------------------------------- +\NeedsTeXFormat{LaTeX2e} +\ProvidesClass{xslt/latex/sambadoc} + +%%--------------------------------------------------- +%%-- Load the base class and modify current macros. +%%--------------------------------------------------- + +\newif\if@usecppsyntax \@usecppsyntaxfalse + +\DeclareOption{cpp}{\@usecppsyntaxtrue} +\DeclareOption*{\PassOptionsToClass{\CurrentOption}{scrreprt}} +\ProcessOptions +%\PassOptionsToClass{12pt}{scrreprt} + +\LoadClass{scrreprt} + +%%--Set the section number depth. +\setcounter{secnumdepth}{3} +\setcounter{tocdepth}{4} + +%\setcounter{page}{2} + +%%--Create a vertical skip for the distance between the title and +%%--the first line of text on the prolog pages. +\newskip\thesisvskip +\thesisvskip 36pt + +%%--Set the margins. %\headheight6pt \headsep12pt +\usepackage[margin=20pt,head=20pt,headsep=20pt,foot=20pt]{geometry} + +%%--Use typehtml for better specification of tables +\usepackage{typehtml} + +%%--Change the marginpar. +\reversemarginpar +\let\old@marginpar=\marginpar +\def\marginpar#1{ + \old@marginpar{\def\baselinestretch{1}\em\small #1}} + +%%--Parameters that can be set by the user. +\def\samba@listtables{y} +\def\samba@listfigures{y} + +\newcommand{\notablelist}{\gdef\samba@listtables{n}} +\newcommand{\nofigurelist}{\gdef\samba@listfigures{n}} + + +%%--Modify behavior of the figure and table environment. +\def\fps@figure{hbt} +\def\fnum@figure{{\bf \figurename~\thefigure}} +\def\fps@table{htb} +\def\fnum@table{{\bf \tablename~\thetable}} + +\def\mathfigure{\thesisfiguretrue\figure} +\def\endmathfigure{\endfigure\thesisfigurefalse} + + + +%%----------------------------------------------- +%%-- Modify the displayed math environments. +%%----------------------------------------------- + +\newif\ifthesisfigure +\thesisfigurefalse + + + +%%-------------------------------------------- +%%-- Miscellaneous commands. +%%-------------------------------------------- + +%%--Commands to simplify font changing. +\newcommand{\sfup}{\sffamily\mdseries\upshape} +\newcommand{\sfsc}{\ttfamily\mdseries\scshape} +\newcommand{\sfit}{\sffamily\mdseries\itshape} +\newcommand{\rmup}{\rmfamily\mdseries\upshape} +\newcommand{\rmbf}{\rmfamily\bfseries\upshape} +\newcommand{\rmit}{\rmfamily\mdseries\itshape} +\newcommand{\ttup}{\ttfamily\mdseries\upshape} + + +\endinput + +%%--The \tableofcontents. +\renewcommand\tableofcontents{% + \renewcommand{\contentsname}{Table of Contents} + \if@twocolumn + \@restonecoltrue\onecolumn + \else + \@restonecolfalse + \fi + \oldchapter*{\contentsname + \@mkboth{\uppercase{\contentsname}}{\uppercase{\contentsname}}}% + \@starttoc{toc}% + \if@restonecol\twocolumn\fi} + +%%--The \listoffigures command. +\renewcommand\listoffigures{% + \if@twocolumn + \@restonecoltrue\onecolumn + \else + \@restonecolfalse + \fi + \oldchapter*{\listfigurename + \@mkboth{\uppercase{\listfigurename}}{\uppercase{\listfigurename}}}% + \@starttoc{lof}% + \if@restonecol\twocolumn\fi} + +%%--The \listoftables command. +\renewcommand\listoftables{% + \if@twocolumn% + \@restonecoltrue\onecolumn% + \else% + \@restonecolfalse% + \fi% + \oldchapter*{\listtablename% + \@mkboth{\uppercase{\listtablename}}{\uppercase{\listtablename}}}% + \@starttoc{lot}% + \if@restonecol\twocolumn\fi} + +\endinput diff --git a/docs/docbook/xslt/lists.mod.xsl b/docs/docbook/xslt/lists.mod.xsl new file mode 100644 index 0000000000..5fbd02de3a --- /dev/null +++ b/docs/docbook/xslt/lists.mod.xsl @@ -0,0 +1,31 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: lists.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + <xsl:template match="simplelist"> + <xsl:if test="title"> <xsl:apply-templates select="title"/></xsl:if> + <xsl:text> \begin{itemize} </xsl:text> + <xsl:apply-templates select="member"/> + <xsl:text> \end{itemize} </xsl:text> + </xsl:template> + + + <xsl:template match="member"> + <xsl:text> %--- Item </xsl:text> + <xsl:text>\item[] </xsl:text> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/man.xsl b/docs/docbook/xslt/man.xsl new file mode 100644 index 0000000000..c1566b30c5 --- /dev/null +++ b/docs/docbook/xslt/man.xsl @@ -0,0 +1,159 @@ +<?xml version='1.0'?> +<!-- vim:set sts=2 shiftwidth=2 syntax=xml: --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version='1.0'> + +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"/> + +<xsl:param name="chunk.section.depth" select="0"/> +<xsl:param name="chunk.first.sections" select="1"/> +<xsl:param name="use.id.as.filename" select="1"/> +<xsl:param name="base.dir" select="'../manpages/'"/> + +<!-- + Our ulink stylesheet omits @url part if content was specified +--> +<xsl:template match="ulink"> + <xsl:variable name="content"> + <xsl:apply-templates/> + </xsl:variable> + <xsl:if test="$content = ''"> + <xsl:text>: </xsl:text> + </xsl:if> + <xsl:if test="$content != ''"> + <xsl:value-of select="$content" /> + </xsl:if> + <xsl:if test="$content = ''"> + <xsl:apply-templates mode="italic" select="@url" /> + </xsl:if> +</xsl:template> + +<xsl:template match="refentry"> + + <xsl:variable name="section" select="refmeta/manvolnum"/> + <xsl:variable name="name" select="refnamediv/refname[1]"/> + <xsl:variable name="base.dir" select="$base.dir"/> + <!-- standard man page width is 64 chars; 6 chars needed for the two + (x) volume numbers, and 2 spaces, leaves 56 --> + <xsl:variable name="twidth" select="(74 - string-length(refmeta/refentrytitle)) div 2"/> + + <xsl:variable name="reftitle" + select="substring(refmeta/refentrytitle, 1, $twidth)"/> + + <xsl:variable name="title"> + <xsl:choose> + <xsl:when test="refentryinfo/title"> + <xsl:value-of select="refentryinfo/title"/> + </xsl:when> + <xsl:when test="../referenceinfo/title"> + <xsl:value-of select="../referenceinfo/title"/> + </xsl:when> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="date"> + <xsl:choose> + <xsl:when test="refentryinfo/date"> + <xsl:value-of select="refentryinfo/date"/> + </xsl:when> + <xsl:when test="../referenceinfo/date"> + <xsl:value-of select="../referenceinfo/date"/> + </xsl:when> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="productname"> + <xsl:choose> + <xsl:when test="refentryinfo/productname"> + <xsl:value-of select="refentryinfo/productname"/> + </xsl:when> + <xsl:when test="../referenceinfo/productname"> + <xsl:value-of select="../referenceinfo/productname"/> + </xsl:when> + </xsl:choose> + </xsl:variable> + + <xsl:call-template name="write.text.chunk"> + <xsl:with-param name="filename" + select="concat($base.dir, normalize-space ($name), '.', $section)"/> + <xsl:with-param name="content"> + <xsl:text>.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "</xsl:text> + <xsl:value-of select="translate($reftitle,'abcdefghijklmnopqrstuvwxyz', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/> + <xsl:text>" </xsl:text> + <xsl:value-of select="refmeta/manvolnum[1]"/> + <xsl:text> "</xsl:text> + <xsl:value-of select="normalize-space($date)"/> + <xsl:text>" "</xsl:text> + <xsl:value-of select="normalize-space($productname)"/> + <xsl:text>" "</xsl:text> + <xsl:value-of select="$title"/> + <xsl:text>" +</xsl:text> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + + <!-- Author section --> + <xsl:choose> + <xsl:when test="refentryinfo//author"> + <xsl:apply-templates select="refentryinfo" mode="authorsect"/> + </xsl:when> + </xsl:choose> + </xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template match="informalexample|screen|programlisting"> + <xsl:text>.nf </xsl:text> + <xsl:apply-templates/> + <xsl:text>.fi </xsl:text> +</xsl:template> + +<xsl:template match="//emphasis"> + <xsl:text>\fB</xsl:text> + <xsl:apply-templates/> + <xsl:text>\fR</xsl:text> +</xsl:template> + +<xsl:template match="para|simpara|remark" mode="list"> + <xsl:variable name="foo"> + <xsl:apply-templates/> + </xsl:variable> + <xsl:choose match="node()"> + <!-- Don't normalize-space() for verbatim paragraphs --> + <xsl:when test="informalexample|screen|programlisting"> + <xsl:value-of select="$foo"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="normalize-space($foo)"/> + <xsl:text> </xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:text> </xsl:text> + <xsl:if test="following-sibling::para or following-sibling::simpara or + following-sibling::remark"> + <!-- Make sure multiple paragraphs within a list item don't --> + <!-- merge together. --> + <xsl:text> </xsl:text> + </xsl:if> +</xsl:template> + +</xsl:stylesheet> diff --git a/docs/docbook/xslt/table.mod.xsl b/docs/docbook/xslt/table.mod.xsl new file mode 100644 index 0000000000..336cac6dfb --- /dev/null +++ b/docs/docbook/xslt/table.mod.xsl @@ -0,0 +1,746 @@ +<?xml version='1.0'?> +<!--############################################################################# +| $Id: table.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ +|- ############################################################################# +| $Author: ab $ +| +| PURPOSE: ++ ############################################################################## --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + exclude-result-prefixes="doc" version='1.0'> + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:reference id="table" xmlns=""> + <referenceinfo> + <releaseinfo role="meta"> + $Id: table.mod.xsl,v 1.1 2003/04/30 21:39:49 ab Exp $ + </releaseinfo> + <authorgroup> + <firstname>Ramon</firstname> <surname>Casellas</surname> + <firstname>James</firstname> <surname>Devenish</surname> + </authorgroup> + <copyright> + <year>2000</year> <year>2001</year> <year>2002</year> <year>2003</year> + <holder>Ramon Casellas</holder> + </copyright> + </referenceinfo> + + <title>Tables <filename>table.mod.xsl</filename></title> + <partintro> + <section><title>Introduction</title> + <para></para> + </section> + </partintro> + </doc:reference> + + + + + <!--############################################################################# --> + <!-- DOCUMENTATION --> + <doc:template match="table|informaltable" xmlns=""> + <refpurpose>XSL template for docbook tables. </refpurpose> + <refdescription> + <para></para> + <formalpara><title>Remarks and Bugs</title> + <itemizedlist> + </itemizedlist> + </formalpara> + <formalpara><title>Default Behaviour</title> + <screen></screen> + </formalpara> + </refdescription> + </doc:template> + <!--############################################################################# --> + + <xsl:template match="table"> + <xsl:variable name="placement"> + <xsl:call-template name="generate.formal.title.placement"> + <xsl:with-param name="object" select="local-name(.)" /> + </xsl:call-template> + </xsl:variable> + <xsl:variable name="caption"> + <xsl:text>\caption{</xsl:text> + <xsl:apply-templates select="title" mode="caption.mode"/> + <xsl:text>} </xsl:text> + </xsl:variable> + <xsl:call-template name="map.begin"/> + <xsl:if test="$placement='before'"> + <xsl:text>\captionswapskip{}</xsl:text> + <xsl:value-of select="$caption" /> + <xsl:text>\captionswapskip{}</xsl:text> + </xsl:if> + <xsl:apply-templates/> + <xsl:if test="$placement!='before'"><xsl:value-of select="$caption" /></xsl:if> + <xsl:call-template name="map.end"/> + </xsl:template> + + <xsl:template match="table/title"/> + <xsl:template match="table/title" mode="caption.mode"><xsl:apply-templates /></xsl:template> + + <xsl:template match="informaltable"> + <xsl:call-template name="map.begin"/> + <xsl:apply-templates/> + <xsl:call-template name="map.end"/> + </xsl:template> + + + <xsl:template name="table.format.tabularx"> + <xsl:param name="cols" select="1"/> + <xsl:param name="i" select="1"/> + <xsl:param name="colsep" select="1"/> + <!-- sum of numeric portions in 1*-like colwidths --> + <xsl:param name="starfactor" select="0"/> + <xsl:choose> + <!-- Out of the recursive iteration --> + <xsl:when test="$i > $cols"></xsl:when> + <!-- There are still columns to count --> + <xsl:otherwise> + <xsl:variable name="width"> + <xsl:variable name="userchoice" select="colspec[@colnum=$i]/@colwidth"/> + <xsl:variable name="cells" select="thead/row/entry[$i]|tbody/row/entry[$i]"/> + <xsl:choose> + <xsl:when test="string-length($userchoice)=0 and count($cells//itemizedlist|$cells//orderedlist|$cells//variablelist)>0"> + <!-- In these specific circumstances, we MUST use a line-wrapped column + and yet the user hasn't specified one. --> + <xsl:value-of select="'1*'"/> + </xsl:when> + <xsl:otherwise> + <!-- In the general case, we just do what the user wants (may even + have no pre-specified width). --> + <xsl:value-of select="$userchoice"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <!-- Try to take heed of colspecs --> + <xsl:choose> + <xsl:when test="$width!=''"> + <xsl:text>>{</xsl:text> + <xsl:if test="contains($width,'*')"> + <!-- see tabularx documentation --> + <xsl:text>\hsize=</xsl:text> + <xsl:value-of select="substring-before($width,'*') * $starfactor" /> + <xsl:text>\hsize</xsl:text> + </xsl:if> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>\RaggedRight</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>\RaggedLeft</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>\Centering</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + </xsl:choose> + <xsl:text>}</xsl:text> + <xsl:choose> + <xsl:when test="contains($width,'*')"> + <xsl:text>X</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>p{</xsl:text><xsl:value-of select="$width" /><xsl:text>}</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:when> + <xsl:otherwise> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>r</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>c</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='justify'"><xsl:text>X</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:text>c</xsl:text><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + <xsl:otherwise><xsl:text>X</xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:otherwise> + </xsl:choose> + <!-- Recursive for next column --> + <xsl:call-template name="table.format.tabularx"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="starfactor" select="$starfactor"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <!-- FIX THIS --> + <xsl:template name="table.format.tabular"> + <xsl:param name="cols" select="1"/> + <xsl:param name="i" select="1"/> + <xsl:param name="colsep" select="1"/> + <xsl:choose> + <!-- Out of the recursive iteration --> + <xsl:when test="$i > $cols"></xsl:when> + <!-- There are still columns to count --> + <xsl:otherwise> + <!-- Try to take heed of colspecs --> + <xsl:choose> + <!-- RC 2003/03/19 : Added first 'test' : colspec[@colnum=$i] for xsltproc + Before this patch, parsing the doc with xsltproc the xsl:when clause + was evaluated to 'true' even if there was no colspec for the column + --> + <xsl:when test="colspec[@colnum=$i] and colspec[@colnum=$i]/@colwidth!='' and not(contains(colspec[@colnum=$i]/@colwidth,'*'))"> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>>{\RaggedRight}</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>>{\RaggedLeft}</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>>{\Centering}</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + </xsl:choose> + <xsl:text>p{</xsl:text><xsl:value-of select="colspec[@colnum=$i]/@colwidth" /><xsl:text>}</xsl:text> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:when> + <xsl:otherwise> + <xsl:choose> + <xsl:when test="colspec[@colnum=$i]/@align='left'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='right'"><xsl:text>r</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='center'"><xsl:text>c</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='justify'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="colspec[@colnum=$i]/@align='char'"><xsl:text>c</xsl:text><xsl:message>Table column char alignment is not supported.</xsl:message></xsl:when> + <xsl:otherwise><xsl:text>c</xsl:text></xsl:otherwise> + </xsl:choose> + <xsl:if test="$i<$cols and $colsep='1'"> + <xsl:text>|</xsl:text> + </xsl:if> + </xsl:otherwise> + </xsl:choose> + <!-- Recursive for next column --> + <xsl:call-template name="table.format.tabular"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + <!-- See tabularx documentation. --> + <!-- For example, if we have a 1* column and a 3* column, then the + the hsizes for each column are (1/(1+3)*2) and (3/(1+3)*2). + The ratio of these to the star values (star values being 1 and 3) + is 2/(1+3). + BUT it is now very complicated because it takes into account columns + where the user has not specified a width but LaTeX requires a + fixed-width column (i.e. specialcols may vary). + Relies on there being (a) colspecs for every column or (b) no + colspecs. + --> + <xsl:template name="generate.starfactor"> + <xsl:param name="i" select="1"/> + <xsl:param name="cols" select="count(colspec)"/> + <xsl:param name="sum" select="0"/> + <xsl:param name="specialcols" select="count(colspec[contains(@colwidth,'*')])"/> + <xsl:choose> + <xsl:when test="$i<=$cols and colspec[position()=$i and contains(@colwidth,'*')]"> + <!-- a * column --> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="sum" select="$sum+substring-before(colspec[$i]/@colwidth,'*')"/> + <xsl:with-param name="specialcols" select="$specialcols"/> + </xsl:call-template> + </xsl:when> + <xsl:when test="$i<=$cols"> + <!-- not a * column, but we are going to pretend that it is --> + <xsl:variable name="cells" select="thead/row/entry[$i]|tbody/row/entry[$i]"/> + <xsl:variable name="problems" select="count($cells//itemizedlist|$cells//orderedlist|$cells//variablelist)"/> + <xsl:choose> + <xsl:when test="$problems > 0"> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="sum" select="$sum+1"/> + <xsl:with-param name="specialcols" select="$specialcols+1"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="i" select="$i+1"/> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="sum" select="$sum"/> + <xsl:with-param name="specialcols" select="$specialcols"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$specialcols div $sum"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <xsl:template match="tgroup"> + <xsl:variable name="align" select="@align"/> + <xsl:variable name="frame"> + <xsl:choose> + <xsl:when test="string-length(../@frame)<1">all</xsl:when> + <xsl:otherwise> + <xsl:value-of select="../@frame"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="colspecs" select="./colspec"/> + <xsl:variable name="usex"> + <xsl:choose> + <!-- if there are lists within cells, we need tabularx --> + <xsl:when test="$latex.use.tabularx=1 and (descendant::itemizedlist|descendant::orderedlist|descendant::variablelist)"> + <xsl:text>1</xsl:text> + </xsl:when> + <!-- if there are instances of 1*-style colwidths, we need tabularx --> + <xsl:when test="$latex.use.tabularx=1 and contains(colspec/@colwidth,'*')"> + <xsl:text>1</xsl:text> + </xsl:when> + <!-- if there are colspecs with 'justify' alignment and no explicit width, we need tabularx --> + <xsl:when test="$latex.use.tabularx=1 and count(colspec[@align='justify'])>0"> + <xsl:text>1</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>1</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="useminipage"> + <!-- Hack to get around LaTeX issue with tabular (not necessary with tabularx). + This is NOT a good solution, and has problems of its own, but at least the footnotes + do not actually disappear (which is what would otherwise happen). --> + <xsl:if test="count(.//footnote)!=0">1</xsl:if> + </xsl:variable> + <xsl:choose> + <xsl:when test="$usex='1'"> + <xsl:text>\begin{tabularx}{\linewidth}{</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:if test="$useminipage='1'"><xsl:text>\begin{minipage}{\linewidth} </xsl:text></xsl:if> + <xsl:text>\begin{tabular}{</xsl:text> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="$frame='all' or $frame='sides'"> + <xsl:text>|</xsl:text> + </xsl:if> + <xsl:choose> + <xsl:when test="$usex=1"> + <xsl:call-template name="table.format.tabularx"> + <xsl:with-param name="cols" select="@cols"/> + <xsl:with-param name="starfactor"> + <xsl:call-template name="generate.starfactor"> + <xsl:with-param name="cols" select="@cols"/> + </xsl:call-template> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="table.format.tabular"> + <xsl:with-param name="cols" select="@cols"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="$frame='all' or $frame='sides'"> + <xsl:text>|</xsl:text> + </xsl:if> + <xsl:text>} </xsl:text> + <xsl:if test="$frame!='sides' and $frame!='none' and $frame!='bottom'"> + <xsl:text>\hline </xsl:text> + </xsl:if> + <!-- APPLY TEMPLATES --> + <xsl:apply-templates/> + <!-- --> + <xsl:if test="$frame!='sides' and $frame!='none' and $frame!='top'"> + <xsl:text>\hline </xsl:text> + </xsl:if> + <xsl:choose> + <xsl:when test="$usex=1"> + <xsl:text>\end{tabularx} </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>\end{tabular} </xsl:text> + <xsl:if test="$useminipage='1'"><xsl:text>\end{minipage} </xsl:text></xsl:if> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + + + <!-- + <xsl:template name="generate.col"> + <xsl:param name="countcol">1</xsl:param> + </xsl:template> + --> + + <xsl:template match="colspec"></xsl:template> + <xsl:template match="spanspec"></xsl:template> + + + + + <xsl:template match="thead|tfoot"> + <xsl:if test="@align"> + <xsl:attribute name="align"> + <xsl:value-of select="@align"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@char"> + <xsl:attribute name="char"> + <xsl:value-of select="@char"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@charoff"> + <xsl:attribute name="charoff"> + <xsl:value-of select="@charoff"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@valign"> + <xsl:attribute name="valign"> + <xsl:value-of select="@valign"/> + </xsl:attribute> + </xsl:if> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="thead/row/entry|tfoot/row/entry"> + <xsl:call-template name="latex.entry.prealign"/> + <xsl:call-template name="latex.thead.row.entry"/> + <xsl:call-template name="latex.entry.postalign"/> + <xsl:choose> + <xsl:when test="position()=last()"><xsl:text> \tabularnewline </xsl:text></xsl:when> + <xsl:otherwise><xsl:call-template name="generate.latex.cell.separator"/></xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template match="tbody"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="row"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="tbody/row|thead/row|tfoot/row"> + <xsl:apply-templates/> + <!-- The rule below the last row in the table is controlled by the + Frame attribute of the enclosing Table or InformalTable and the RowSep + of the last row is ignored. If unspecified, this attribute is + inherited from enclosing elements, rowsep=1 by default. --> + <xsl:variable name="parent_position" select="count(../preceding-sibling::node())+1"/> + <xsl:variable name="grandparent_children" select="count(../../child::node())"/> + <xsl:if test="(count(@rowsep)=0 or @rowsep='1') and (position() != last() or $parent_position < $grandparent_children)"> + <xsl:text> \hline </xsl:text> + </xsl:if> + </xsl:template> + + + <xsl:template match="tbody/row/entry"> + <xsl:call-template name="latex.entry.prealign"/> + <xsl:apply-templates/> + <xsl:call-template name="latex.entry.postalign"/> + <xsl:choose> + <xsl:when test="position()=last()"><xsl:text> \tabularnewline </xsl:text></xsl:when> + <xsl:otherwise><xsl:call-template name="generate.latex.cell.separator"/></xsl:otherwise> + </xsl:choose> + </xsl:template> + + + <xsl:template name="latex.entry.prealign"> + <xsl:variable name="span"> + <xsl:choose> + <xsl:when test="@spanname!=''"> + <xsl:call-template name="calculate.colspan"> + <xsl:with-param name="namest" select="../../../spanspec[@spanname=@spanname]/@namest"/> + <xsl:with-param name="nameend" select="../../../spanspec[@spanname=@spanname]/@nameend"/> + </xsl:call-template> + </xsl:when> + <xsl:when test="@namest!=''"> + <xsl:call-template name="calculate.colspan"/> + </xsl:when> + <xsl:otherwise>-1</xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:if test="$span > 1"> + <xsl:text>\multicolumn{</xsl:text> + <xsl:value-of select="$span"/> + <xsl:text>|}{</xsl:text><!-- TODO take heed of @colsep --> + <xsl:choose> + <xsl:when test="@align='left'"><xsl:text>l</xsl:text></xsl:when> + <xsl:when test="@align='right'"><xsl:text>r</xsl:text></xsl:when> + <xsl:when test="@align='center'"><xsl:text>c</xsl:text></xsl:when> + <xsl:when test="@align='char'">c<xsl:message>Table entry char alignment is not supported.</xsl:message></xsl:when> + <xsl:otherwise>c</xsl:otherwise> + </xsl:choose> + <!-- use this as a hook for some general warnings --> + <xsl:text>}</xsl:text> + </xsl:if> + <!-- this is used when the entry's align spec wants to override the column default --> + <xsl:if test="$span < 1"> + <xsl:choose> + <xsl:when test="@align='left'"><xsl:text>\docbooktolatexalignll </xsl:text></xsl:when> + <xsl:when test="@align='right'"><xsl:text>\docbooktolatexalignrl </xsl:text></xsl:when> + <xsl:when test="@align='center'"><xsl:text>\docbooktolatexaligncl </xsl:text></xsl:when> + <xsl:when test="@align='char'"><xsl:message>Table entry char alignment is not supported.</xsl:message></xsl:when> + </xsl:choose> + </xsl:if> + <xsl:text>{</xsl:text> + <xsl:if test="@rotate='1'"> + <xsl:text>\rotatebox{90}</xsl:text> + <xsl:if test="@align!=''"><xsl:message>entry[@rotate='1' and @align!=''] probably doesn't work.</xsl:message></xsl:if> + </xsl:if> + <xsl:text>{</xsl:text> + <!-- use this as a hook for some general warnings --> + <xsl:if test="@morerows!=''"><xsl:message>The morerows attribute is not supported.</xsl:message></xsl:if> + </xsl:template> + + <xsl:template name="latex.entry.postalign"> + <xsl:text>}}</xsl:text> + <!-- this is used when the entry's align spec wants to override the column default --> + <xsl:if test="@namest='' and @spanspec=''"><!-- TODO improve --> + <xsl:choose> + <xsl:when test="@align='left'"><xsl:text>\docbooktolatexalignlr </xsl:text></xsl:when> + <xsl:when test="@align='right'"><xsl:text>\docbooktolatexalignrr </xsl:text></xsl:when> + <xsl:when test="@align='center'"><xsl:text>\docbooktolatexaligncr </xsl:text></xsl:when> + </xsl:choose> + </xsl:if> + </xsl:template> + + + + + + + + + + + + + + <xsl:template name="process.cell"> + <xsl:param name="cellgi">td</xsl:param> + <xsl:variable name="empty.cell" select="count(node()) = 0"/> + + <xsl:element name="{$cellgi}"> + <xsl:if test="@morerows"> + <xsl:attribute name="rowspan"> + <xsl:value-of select="@morerows+1"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@namest"> + <xsl:attribute name="colspan"> + <xsl:call-template name="calculate.colspan"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@align"> + <xsl:attribute name="align"> + <xsl:value-of select="@align"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@char"> + <xsl:attribute name="char"> + <xsl:value-of select="@char"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@charoff"> + <xsl:attribute name="charoff"> + <xsl:value-of select="@charoff"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="@valign"> + <xsl:attribute name="valign"> + <xsl:value-of select="@valign"/> + </xsl:attribute> + </xsl:if> + + <xsl:choose> + <xsl:when test="$empty.cell"> + <xsl:text> </xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> + </xsl:element> + </xsl:template> + + <xsl:template name="generate.colgroup"> + <xsl:param name="cols" select="1"/> + <xsl:param name="count" select="1"/> + <xsl:choose> + <xsl:when test="$count>$cols"></xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.col"> + <xsl:with-param name="countcol" select="$count"/> + </xsl:call-template> + <xsl:call-template name="generate.colgroup"> + <xsl:with-param name="cols" select="$cols"/> + <xsl:with-param name="count" select="$count+1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="generate.col"> + <xsl:param name="countcol">1</xsl:param> + <xsl:param name="colspecs" select="./colspec"/> + <xsl:param name="count">1</xsl:param> + <xsl:param name="colnum">1</xsl:param> + + <xsl:choose> + <xsl:when test="$count>count($colspecs)"> + <col/> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="colspec" select="$colspecs[$count=position()]"/> + <xsl:variable name="colspec.colnum"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$colspec.colnum=$countcol"> + <col> + <xsl:if test="$colspec/@align"> + <xsl:attribute name="align"> + <xsl:value-of select="$colspec/@align"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="$colspec/@char"> + <xsl:attribute name="char"> + <xsl:value-of select="$colspec/@char"/> + </xsl:attribute> + </xsl:if> + <xsl:if test="$colspec/@charoff"> + <xsl:attribute name="charoff"> + <xsl:value-of select="$colspec/@charoff"/> + </xsl:attribute> + </xsl:if> + </col> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="generate.col"> + <xsl:with-param name="countcol" select="$countcol"/> + <xsl:with-param name="colspecs" select="$colspecs"/> + <xsl:with-param name="count" select="$count+1"/> + <xsl:with-param name="colnum"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum + 1"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum + 1"/> + </xsl:otherwise> + </xsl:choose> + </xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + + </xsl:template> + + <xsl:template name="colspec.colnum"> + <!-- when this macro is called, the current context must be an entry --> + <xsl:param name="colname"></xsl:param> + <!-- .. = row, ../.. = thead|tbody, ../../.. = tgroup --> + <xsl:param name="colspecs" select="../../../../tgroup/colspec"/> + <xsl:param name="count">1</xsl:param> + <xsl:param name="colnum">1</xsl:param> + <xsl:choose> + <xsl:when test="$count>count($colspecs)"></xsl:when> + <xsl:otherwise> + <xsl:variable name="colspec" select="$colspecs[$count=position()]"/> + <!-- + <xsl:value-of select="$count"/>: + <xsl:value-of select="$colspec/@colname"/>= + <xsl:value-of select="$colnum"/> + --> + <xsl:choose> + <xsl:when test="$colspec/@colname=$colname"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum"/> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="colspec.colnum"> + <xsl:with-param name="colname" select="$colname"/> + <xsl:with-param name="colspecs" select="$colspecs"/> + <xsl:with-param name="count" select="$count+1"/> + <xsl:with-param name="colnum"> + <xsl:choose> + <xsl:when test="$colspec/@colnum"> + <xsl:value-of select="$colspec/@colnum + 1"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$colnum + 1"/> + </xsl:otherwise> + </xsl:choose> + </xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="colspec.colwidth"> + <!-- when this macro is called, the current context must be an entry --> + <xsl:param name="colname"></xsl:param> + <!-- .. = row, ../.. = thead|tbody, ../../.. = tgroup --> + <xsl:param name="colspecs" select="../../../../tgroup/colspec"/> + <xsl:param name="count">1</xsl:param> + <xsl:choose> + <xsl:when test="$count>count($colspecs)"></xsl:when> + <xsl:otherwise> + <xsl:variable name="colspec" select="$colspecs[$count=position()]"/> + <xsl:choose> + <xsl:when test="$colspec/@colname=$colname"> + <xsl:value-of select="$colspec/@colwidth"/> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="colspec.colwidth"> + <xsl:with-param name="colname" select="$colname"/> + <xsl:with-param name="colspecs" select="$colspecs"/> + <xsl:with-param name="count" select="$count+1"/> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <xsl:template name="calculate.colspan"> + <xsl:param name="namest" select="@namest"/> + <xsl:param name="nameend" select="@nameend"/> + <xsl:variable name="scol"> + <xsl:call-template name="colspec.colnum"> + <xsl:with-param name="colname" select="$namest"/> + </xsl:call-template> + </xsl:variable> + <xsl:variable name="ecol"> + <xsl:call-template name="colspec.colnum"> + <xsl:with-param name="colname" select="$nameend"/> + </xsl:call-template> + </xsl:variable> + <xsl:value-of select="$ecol - $scol + 1"/> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/faq/FAQ-ClientApp.html b/docs/faq/FAQ-ClientApp.html new file mode 100644 index 0000000000..3f680b78d7 --- /dev/null +++ b/docs/faq/FAQ-ClientApp.html @@ -0,0 +1,52 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 4. Specific client application problems</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"><link rel="home" href="samba-faq.html" title="Samba FAQ"><link rel="up" href="samba-faq.html" title="Samba FAQ"><link rel="previous" href="FAQ-Config.html" title="Chapter 3. Configuration problems"><link rel="next" href="FAQ-errors.html" title="Chapter 5. Common errors"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 4. Specific client application problems</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="FAQ-Config.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="FAQ-errors.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><h2 class="title"><a name="FAQ-ClientApp"></a>Chapter 4. Specific client application problems</h2></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="FAQ-ClientApp.html#id2808466">MS Office Setup reports "Cannot change properties of '\\MSOFFICE\\SETUP.INI'"</a></dt><dt><a href="FAQ-ClientApp.html#id2808495">How to use a Samba share as an administrative share for MS Office, etc.</a></dt><dt><a href="FAQ-ClientApp.html#id2808433">Microsoft Access database opening errors</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2808466"></a>MS Office Setup reports "Cannot change properties of '\\MSOFFICE\\SETUP.INI'"</h2></div></div><p> +When installing MS Office on a Samba drive for which you have admin +user permissions, ie. admin users = username, you will find the +setup program unable to complete the installation. +</p><p> +To get around this problem, do the installation without admin user +permissions The problem is that MS Office Setup checks that a file is +rdonly by trying to open it for writing. +</p><p> +Admin users can always open a file for writing, as they run as root. +You just have to install as a non-admin user and then use "chown -R" +to fix the owner. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2808495"></a>How to use a Samba share as an administrative share for MS Office, etc.</h2></div></div><p> +Microsoft Office products can be installed as an administrative installation +from which the application can either be run off the administratively installed +product that resides on a shared resource, or from which that product can be +installed onto workstation clients. +</p><p> +The general mechanism for implementing an adminstrative installation involves +running <b>X:\setup /A</b>, where X is the drive letter of either CDROM or floppy. +</p><p> +This installation process will NOT install the product for use per se, but +rather results in unpacking of the compressed distribution files into a target +shared folder. For this process you need write privilidge to the share and it +is desirable to enable file locking and share mode operation during this +process. +</p><p> +Subsequent installation of MS Office from this share will FAIL unless certain +precautions are taken. This failure will be caused by share mode operation +which will prevent the MS Office installation process from re-opening various +dynamic link library files and will cause sporadic file not found problems. +</p><div class="itemizedlist"><ul type="disc"><li><p> +As soon as the administrative installation (unpacking) has completed +set the following parameters on the share containing it: +</p><pre class="programlisting"> +[MSOP95] + path = /where_you_put_it + comment = Your comment + volume = "The_CD_ROM_Label" + read only = yes + available = yes + share modes = no + locking = no + browseable = yes + public = yes +</pre></li><li><p>Now you are ready to run the setup program from the Microsoft Windows +workstation as follows: <b>\\"Server_Name"\MSOP95\msoffice\setup</b> +</p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2808433"></a>Microsoft Access database opening errors</h2></div></div><p> +Here are some notes on running MS-Access on a Samba drive from <a href="stefank@esi.com.au" target="_top">Stefan Kjellberg</a> +</p><table class="simplelist" border="0" summary="Simple list"><tr><td>Opening a database in 'exclusive' mode does NOT work. Samba ignores r/w/share modes on file open.</td></tr><tr><td>Make sure that you open the database as 'shared' and to 'lock modified records'</td></tr><tr><td>Of course locking must be enabled for the particular share (smb.conf)</td></tr></table><p> +</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="FAQ-Config.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="samba-faq.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="FAQ-errors.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 3. Configuration problems </td><td width="20%" align="center"><a accesskey="h" href="samba-faq.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 5. Common errors</td></tr></table></div></body></html> diff --git a/docs/faq/FAQ-Install.html b/docs/faq/FAQ-Install.html new file mode 100644 index 0000000000..411656bc76 --- /dev/null +++ b/docs/faq/FAQ-Install.html @@ -0,0 +1,194 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 2. Compiling and installing Samba on a Unix host</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"><link rel="home" href="samba-faq.html" title="Samba FAQ"><link rel="up" href="samba-faq.html" title="Samba FAQ"><link rel="previous" href="FAQ-general.html" title="Chapter 1. General Information"><link rel="next" href="FAQ-Config.html" title="Chapter 3. Configuration problems"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 2. Compiling and installing Samba on a Unix host</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="FAQ-general.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="FAQ-Config.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><h2 class="title"><a name="FAQ-Install"></a>Chapter 2. Compiling and installing Samba on a Unix host</h2></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="FAQ-Install.html#id2808542">I can't see the Samba server in any browse lists!</a></dt><dt><a href="FAQ-Install.html#id2811456">Some files that I KNOW are on the server don't show up when I view the files from my client!</a></dt><dt><a href="FAQ-Install.html#id2811470">Some files on the server show up with really wierd filenames when I view the files from my client!</a></dt><dt><a href="FAQ-Install.html#id2860743">My client reports "cannot locate specified computer" or similar</a></dt><dt><a href="FAQ-Install.html#id2860797">My client reports "cannot locate specified share name" or similar</a></dt><dt><a href="FAQ-Install.html#id2806029">Printing doesn't work</a></dt><dt><a href="FAQ-Install.html#id2807904">My client reports "This server is not configured to list shared resources"</a></dt><dt><a href="FAQ-Install.html#id2807925">Log message "you appear to have a trapdoor uid system" </a></dt><dt><a href="FAQ-Install.html#id2807990">Why are my file's timestamps off by an hour, or by a few hours?</a></dt><dt><a href="FAQ-Install.html#id2811127">How do I set the printer driver name correctly?</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2808542"></a>I can't see the Samba server in any browse lists!</h2></div></div><p> +See Browsing.html in the docs directory of the samba source +for more information on browsing. +</p><p> +If your GUI client does not permit you to select non-browsable +servers, you may need to do so on the command line. For example, under +Lan Manager you might connect to the above service as disk drive M: +thusly: +</p><pre class="programlisting"> + net use M: \\mary\fred +</pre><p> +The details of how to do this and the specific syntax varies from +client to client - check your client's documentation. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2811456"></a>Some files that I KNOW are on the server don't show up when I view the files from my client!</h2></div></div><p>See the next question.</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2811470"></a>Some files on the server show up with really wierd filenames when I view the files from my client!</h2></div></div><p> +If you check what files are not showing up, you will note that they +are files which contain upper case letters or which are otherwise not +DOS-compatible (ie, they are not legal DOS filenames for some reason). +</p><p> +The Samba server can be configured either to ignore such files +completely, or to present them to the client in "mangled" form. If you +are not seeing the files at all, the Samba server has most likely been +configured to ignore them. Consult the man page smb.conf(5) for +details of how to change this - the parameter you need to set is +"mangled names = yes". +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2860743"></a>My client reports "cannot locate specified computer" or similar</h2></div></div><p> +This indicates one of three things: You supplied an incorrect server +name, the underlying TCP/IP layer is not working correctly, or the +name you specified cannot be resolved. +</p><p> +After carefully checking that the name you typed is the name you +should have typed, try doing things like pinging a host or telnetting +to somewhere on your network to see if TCP/IP is functioning OK. If it +is, the problem is most likely name resolution. +</p><p> +If your client has a facility to do so, hardcode a mapping between the +hosts IP and the name you want to use. For example, with Lan Manager +or Windows for Workgroups you would put a suitable entry in the file +LMHOSTS. If this works, the problem is in the communication between +your client and the netbios name server. If it does not work, then +there is something fundamental wrong with your naming and the solution +is beyond the scope of this document. +</p><p> +If you do not have any server on your subnet supplying netbios name +resolution, hardcoded mappings are your only option. If you DO have a +netbios name server running (such as the Samba suite's nmbd program), +the problem probably lies in the way it is set up. Refer to Section +Two of this FAQ for more ideas. +</p><p> +By the way, remember to REMOVE the hardcoded mapping before further +tests :-) +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2860797"></a>My client reports "cannot locate specified share name" or similar</h2></div></div><p> +This message indicates that your client CAN locate the specified +server, which is a good start, but that it cannot find a service of +the name you gave. +</p><p> +The first step is to check the exact name of the service you are +trying to connect to (consult your system administrator). Assuming it +exists and you specified it correctly (read your client's docs on how +to specify a service name correctly), read on: +</p><table class="simplelist" border="0" summary="Simple list"><tr><td>Many clients cannot accept or use service names longer than eight characters.</td></tr><tr><td>Many clients cannot accept or use service names containing spaces.</td></tr><tr><td>Some servers (not Samba though) are case sensitive with service names.</td></tr><tr><td>Some clients force service names into upper case.</td></tr></table></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2806029"></a>Printing doesn't work</h2></div></div><p> +Make sure that the specified print command for the service you are +connecting to is correct and that it has a fully-qualified path (eg., +use "/usr/bin/lpr" rather than just "lpr"). +</p><p> +Make sure that the spool directory specified for the service is +writable by the user connected to the service. In particular the user +"nobody" often has problems with printing, even if it worked with an +earlier version of Samba. Try creating another guest user other than +"nobody". +</p><p> +Make sure that the user specified in the service is permitted to use +the printer. +</p><p> +Check the debug log produced by smbd. Search for the printer name and +see if the log turns up any clues. Note that error messages to do with +a service ipc$ are meaningless - they relate to the way the client +attempts to retrieve status information when using the LANMAN1 +protocol. +</p><p> +If using WfWg then you need to set the default protocol to TCP/IP, not +Netbeui. This is a WfWg bug. +</p><p> +If using the Lanman1 protocol (the default) then try switching to +coreplus. Also not that print status error messages don't mean +printing won't work. The print status is received by a different +mechanism. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2807904"></a>My client reports "This server is not configured to list shared resources"</h2></div></div><p> +Your guest account is probably invalid for some reason. Samba uses the +guest account for browsing in smbd. Check that your guest account is +valid. +</p><p>See also 'guest account' in smb.conf man page.</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2807925"></a>Log message "you appear to have a trapdoor uid system" </h2></div></div><p> +This can have several causes. It might be because you are using a uid +or gid of 65535 or -1. This is a VERY bad idea, and is a big security +hole. Check carefully in your /etc/passwd file and make sure that no +user has uid 65535 or -1. Especially check the "nobody" user, as many +broken systems are shipped with nobody setup with a uid of 65535. +</p><p>It might also mean that your OS has a trapdoor uid/gid system :-)</p><p> +This means that once a process changes effective uid from root to +another user it can't go back to root. Unfortunately Samba relies on +being able to change effective uid from root to non-root and back +again to implement its security policy. If your OS has a trapdoor uid +system this won't work, and several things in Samba may break. Less +things will break if you use user or server level security instead of +the default share level security, but you may still strike +problems. +</p><p> +The problems don't give rise to any security holes, so don't panic, +but it does mean some of Samba's capabilities will be unavailable. +In particular you will not be able to connect to the Samba server as +two different uids at once. This may happen if you try to print as a +"guest" while accessing a share as a normal user. It may also affect +your ability to list the available shares as this is normally done as +the guest user. +</p><p> +Complain to your OS vendor and ask them to fix their system. +</p><p> +Note: the reason why 65535 is a VERY bad choice of uid and gid is that +it casts to -1 as a uid, and the setreuid() system call ignores (with +no error) uid changes to -1. This means any daemon attempting to run +as uid 65535 will actually run as root. This is not good! +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2807990"></a>Why are my file's timestamps off by an hour, or by a few hours?</h2></div></div><p> +This is from Paul Eggert eggert@twinsun.com. +</p><p> +Most likely it's a problem with your time zone settings. +</p><p> +Internally, Samba maintains time in traditional Unix format, +namely, the number of seconds since 1970-01-01 00:00:00 Universal Time +(or ``GMT''), not counting leap seconds. +</p><p> +On the server side, Samba uses the Unix TZ variable to convert +internal timestamps to and from local time. So on the server side, there are +two things to get right. +</p><table class="simplelist" border="0" summary="Simple list"><tr><td>The Unix system clock must have the correct Universal time. Use the shell command "sh -c 'TZ=UTC0 date'" to check this.</td></tr><tr><td>The TZ environment variable must be set on the server before Samba is invoked. The details of this depend on the server OS, but typically you must edit a file whose name is /etc/TIMEZONE or /etc/default/init, or run the command `zic -l'.</td></tr></table><p> +</p><p>TZ must have the correct value.</p><p> +If possible, use geographical time zone settings +(e.g. TZ='America/Los_Angeles' or perhaps + TZ=':US/Pacific'). These are supported by most +popular Unix OSes, are easier to get right, and are +more accurate for historical timestamps. If your +operating system has out-of-date tables, you should be +able to update them from the public domain time zone +tables at <a href="ftp://elsie.nci.nih.gov/pub/" target="_top">ftp://elsie.nci.nih.gov/pub/</a>. +</p><p>If your system does not support geographical timezone +settings, you must use a Posix-style TZ strings, e.g. +TZ='PST8PDT,M4.1.0/2,M10.5.0/2' for US Pacific time. +Posix TZ strings can take the following form (with optional + items in brackets): +</p><pre class="programlisting"> + StdOffset[Dst[Offset],Date/Time,Date/Time] +</pre><p> + where: +</p><table class="simplelist" border="0" summary="Simple list"><tr><td>`Std' is the standard time designation (e.g. `PST').</td></tr><tr><td>`Offset' is the number of hours behind UTC (e.g. `8'). +Prepend a `-' if you are ahead of UTC, and +append `:30' if you are at a half-hour offset. +Omit all the remaining items if you do not use +daylight-saving time.</td></tr><tr><td>`Dst' is the daylight-saving time designation +(e.g. `PDT').</td></tr><tr><td>The optional second `Offset' is the number of +hours that daylight-saving time is behind UTC. +The default is 1 hour ahead of standard time. +</td></tr><tr><td>`Date/Time,Date/Time' specify when daylight-saving +time starts and ends. The format for a date is +`Mm.n.d', which specifies the dth day (0 is Sunday) +of the nth week of the mth month, where week 5 means +the last such day in the month. The format for a +time is [h]h[:mm[:ss]], using a 24-hour clock. +</td></tr></table><p> +</p><p> +Other Posix string formats are allowed but you don't want +to know about them.</p><p> +On the client side, you must make sure that your client's clock and +time zone is also set appropriately. [[I don't know how to do this.]] +Samba traditionally has had many problems dealing with time zones, due +to the bizarre ways that Microsoft network protocols handle time +zones. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2811127"></a>How do I set the printer driver name correctly?</h2></div></div><p>Question: +“ On NT, I opened "Printer Manager" and "Connect to Printer". + Enter ["\\ptdi270\ps1"] in the box of printer. I got the + following error message + ”</p><p> + </p><pre class="programlisting"> + You do not have sufficient access to your machine + to connect to the selected printer, since a driver + needs to be installed locally. + </pre><p> + </p><p>Answer:</p><p>In the more recent versions of Samba you can now set the "printer +driver" in smb.conf. This tells the client what driver to use. For +example:</p><pre class="programlisting"> + printer driver = HP LaserJet 4L +</pre><p>With this, NT knows to use the right driver. You have to get this string +exactly right.</p><p>To find the exact string to use, you need to get to the dialog box in +your client where you select which printer driver to install. The +correct strings for all the different printers are shown in a listbox +in that dialog box.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="FAQ-general.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="samba-faq.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="FAQ-Config.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 1. General Information </td><td width="20%" align="center"><a accesskey="h" href="samba-faq.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 3. Configuration problems</td></tr></table></div></body></html> diff --git a/docs/faq/FAQ-errors.html b/docs/faq/FAQ-errors.html new file mode 100644 index 0000000000..c2ec7e719b --- /dev/null +++ b/docs/faq/FAQ-errors.html @@ -0,0 +1,99 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 5. Common errors</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"><link rel="home" href="samba-faq.html" title="Samba FAQ"><link rel="up" href="samba-faq.html" title="Samba FAQ"><link rel="previous" href="FAQ-ClientApp.html" title="Chapter 4. Specific client application problems"><link rel="next" href="FAQ-features.html" title="Chapter 6. Features"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 5. Common errors</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="FAQ-ClientApp.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="FAQ-features.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><h2 class="title"><a name="FAQ-errors"></a>Chapter 5. Common errors</h2></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="FAQ-errors.html#id2811288">Not listening for calling name</a></dt><dt><a href="FAQ-errors.html#id2811329">System Error 1240</a></dt><dt><a href="FAQ-errors.html#id2811215">smbclient ignores -N !</a></dt><dt><a href="FAQ-errors.html#id2811270">The data on the CD-Drive I've shared seems to be corrupted!</a></dt><dt><a href="FAQ-errors.html#id2874350">Why can users access home directories of other users?</a></dt><dt><a href="FAQ-errors.html#id2874436">Until a few minutes after samba has started, clients get the error "Domain Controller Unavailable"</a></dt><dt><a href="FAQ-errors.html#id2874451">I'm getting "open_oplock_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested" in the logs</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2811288"></a>Not listening for calling name</h2></div></div><p> +</p><pre class="programlisting"> +Session request failed (131,129) with myname=HOBBES destname=CALVIN +Not listening for calling name +</pre><p> +</p><p> +If you get this when talking to a Samba box then it means that your +global "hosts allow" or "hosts deny" settings are causing the Samba +server to refuse the connection. +</p><p> +Look carefully at your "hosts allow" and "hosts deny" lines in the +global section of smb.conf. +</p><p> +It can also be a problem with reverse DNS lookups not functioning +correctly, leading to the remote host identity not being able to +be confirmed, but that is less likely. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2811329"></a>System Error 1240</h2></div></div><p> +System error 1240 means that the client is refusing to talk +to a non-encrypting server. Microsoft changed WinNT in service +pack 3 to refuse to connect to servers that do not support +SMB password encryption. +</p><p>There are two main solutions: +</p><table class="simplelist" border="0" summary="Simple list"><tr><td>enable SMB password encryption in Samba. See the encryption part of +the samba HOWTO Collection</td></tr><tr><td>disable this new behaviour in NT. See the section about +Windows NT in the chapter "Portability" of the samba HOWTO collection +</td></tr></table><p> +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2811215"></a>smbclient ignores -N !</h2></div></div><p> +“When getting the list of shares available on a host using the command +<b>smbclient -N -L</b> +the program always prompts for the password if the server is a Samba server. +It also ignores the "-N" argument when querying some (but not all) of our +NT servers. +” +</p><p> +No, it does not ignore -N, it is just that your server rejected the +null password in the connection, so smbclient prompts for a password +to try again. +</p><p> +To get the behaviour that you probably want use <b>smbclient -L host -U%</b> +</p><p> +This will set both the username and password to null, which is +an anonymous login for SMB. Using -N would only set the password +to null, and this is not accepted as an anonymous login for most +SMB servers. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2811270"></a>The data on the CD-Drive I've shared seems to be corrupted!</h2></div></div><p> +Some OSes (notably Linux) default to auto detection of file type on +cdroms and do cr/lf translation. This is a very bad idea when use with +Samba. It causes all sorts of stuff ups. +</p><p> +To overcome this problem use conv=binary when mounting the cdrom +before exporting it with Samba. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2874350"></a>Why can users access home directories of other users?</h2></div></div><p> +“ +We are unable to keep individual users from mapping to any other user's +home directory once they have supplied a valid password! They only need +to enter their own password. I have not found *any* method that I can +use to configure samba to enforce that only a user may map their own +home directory. +” +</p><p>“ +User xyzzy can map his home directory. Once mapped user xyzzy can also map +*anyone* elses home directory! +”</p><p> +This is not a security flaw, it is by design. Samba allows +users to have *exactly* the same access to the UNIX filesystem +as they would if they were logged onto the UNIX box, except +that it only allows such views onto the file system as are +allowed by the defined shares. +</p><p> +This means that if your UNIX home directories are set up +such that one user can happily cd into another users +directory and do an ls, the UNIX security solution is to +change the UNIX file permissions on the users home directories +such that the cd and ls would be denied. +</p><p> +Samba tries very hard not to second guess the UNIX administrators +security policies, and trusts the UNIX admin to set +the policies and permissions he or she desires. +</p><p> +Samba does allow the setup you require when you have set the +"only user = yes" option on the share, is that you have not set the +valid users list for the share. +</p><p> +Note that only user works in conjunction with the users= list, +so to get the behavior you require, add the line : +</p><pre class="programlisting"> +users = %S +</pre><p> +this is equivalent to: +</p><pre class="programlisting"> +valid users = %S +</pre><p> +to the definition of the [homes] share, as recommended in +the smb.conf man page. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2874436"></a>Until a few minutes after samba has started, clients get the error "Domain Controller Unavailable"</h2></div></div><p> +A domain controller has to announce on the network who it is. This usually takes a while. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2874451"></a>I'm getting "open_oplock_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested" in the logs</h2></div></div><p>Your loopback device isn't working correctly. Make sure it's running. +</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="FAQ-ClientApp.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="samba-faq.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="FAQ-features.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 4. Specific client application problems </td><td width="20%" align="center"><a accesskey="h" href="samba-faq.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 6. Features</td></tr></table></div></body></html> diff --git a/docs/faq/FAQ-features.html b/docs/faq/FAQ-features.html new file mode 100644 index 0000000000..9bcd8437b8 --- /dev/null +++ b/docs/faq/FAQ-features.html @@ -0,0 +1,214 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 6. Features</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"><link rel="home" href="samba-faq.html" title="Samba FAQ"><link rel="up" href="samba-faq.html" title="Samba FAQ"><link rel="previous" href="FAQ-errors.html" title="Chapter 5. Common errors"><link rel="next" href="FAQ-Printing.html" title="Chapter 7. Printing problems"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 6. Features</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="FAQ-errors.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="FAQ-Printing.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><h2 class="title"><a name="FAQ-features"></a>Chapter 6. Features</h2></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="FAQ-features.html#id2874269">How can I prevent my samba server from being used to distribute the Nimda worm?</a></dt><dt><a href="FAQ-features.html#id2874209">How can I use samba as a fax server?</a></dt><dd><dl><dt><a href="FAQ-features.html#id2874628">Tools for printing faxes</a></dt><dt><a href="FAQ-features.html#id2874681">Making the fax-server</a></dt><dt><a href="FAQ-features.html#id2874774">Installing the client drivers</a></dt><dt><a href="FAQ-features.html#id2874858">Example smb.conf</a></dt></dl></dd><dt><a href="FAQ-features.html#id2874883">Samba doesn't work well together with DHCP!</a></dt><dt><a href="FAQ-features.html#id2874531">How can I assign NetBIOS names to clients with DHCP?</a></dt><dt><a href="FAQ-features.html#id2874581">How do I convert between unix and dos text formats?</a></dt><dt><a href="FAQ-features.html#id2874612">Does samba have wins replication support?</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2874269"></a>How can I prevent my samba server from being used to distribute the Nimda worm?</h2></div></div><p>Author: HASEGAWA Yosuke (translated by <a href="monyo@samba.gr.jp" target="_top">TAKAHASHI Motonobu</a>)</p><p> +Nimba Worm is infected through shared disks on a network, as well as through +Microsoft IIS, Internet Explorer and mailer of Outlook series. +</p><p> +At this time, the worm copies itself by the name *.nws and *.eml on +the shared disk, moreover, by the name of Riched20.dll in the folder +where *.doc file is included. +</p><p> +To prevent infection through the shared disk offered by Samba, set +up as follows: +</p><p> +</p><pre class="programlisting"> +[global] + ... + # This can break Administration installations of Office2k. + # in that case, don't veto the riched20.dll + veto files = /*.eml/*.nws/riched20.dll/ +</pre><p> +</p><p> +By setting the "veto files" parameter, matched files on the Samba +server are completely hidden from the clients and making it impossible +to access them at all. +</p><p> +In addition to it, the following setting is also pointed out by the +samba-jp:09448 thread: when the +"readme.txt.{3050F4D8-98B5-11CF-BB82-00AA00BDCE0B}" file exists on +a Samba server, it is visible only as "readme.txt" and dangerous +code may be executed if this file is double-clicked. +</p><p> +Setting the following, +</p><pre class="programlisting"> + veto files = /*.{*}/ +</pre><p> +any files having CLSID in its file extension will be inaccessible from any +clients. +</p><p> +This technical article is created based on the discussion of +samba-jp:09448 and samba-jp:10900 threads. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2874209"></a>How can I use samba as a fax server?</h2></div></div><p>Contributor: <a href="mailto:zuber@berlin.snafu.de" target="_top">Gerhard Zuber</a></p><p>Requirements: +</p><table class="simplelist" border="0" summary="Simple list"><tr><td>UNIX box (Linux preferred) with SAMBA and a faxmodem</td></tr><tr><td>ghostscript package</td></tr><tr><td>mgetty+sendfax package</td></tr><tr><td>pbm package (portable bitmap tools)</td></tr></table><p> +</p><p>First, install and configure the required packages. Be sure to read the mgetty+sendfax +manual carefully.</p><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2874628"></a>Tools for printing faxes</h3></div></div><p>Your incomed faxes are in: +<tt>/var/spool/fax/incoming</tt>. Print it with:</p><pre class="programlisting"> +for i in * +do +g3cat $i | g3tolj | lpr -P hp +done +</pre><p> +</p><p> +g3cat is in the tools-section, g3tolj is in the contrib-section +for printing to HP lasers. +</p><p> +If you want to produce files for displaying and printing with Windows, use +some tools from the pbm-package like the following command: <b>g3cat $i | g3topbm - | ppmtopcx - >$i.pcx</b> +and view it with your favourite Windows tool (maybe paintbrush) +</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2874681"></a>Making the fax-server</h3></div></div><p>fetch the file <tt>mgetty+sendfax/frontends/winword/faxfilter</tt> and place it in <tt>/usr/local/etc/mgetty+sendfax/</tt>(replace /usr/local/ with whatever place you installed mgetty+sendfax)</p><p>prepare your faxspool file as mentioned in this file +edit fax/faxspool.in and reinstall or change the final +/usr/local/bin/faxspool too. +</p><pre class="programlisting"> +if [ "$user" = "root" -o "$user" = "fax" -o \ + "$user" = "lp" -o "$user" = "daemon" -o "$user" = "bin" ] +</pre><p>find the first line and change it to the second.</p><p> +make sure you have pbmtext (from the pbm-package). This is +needed for creating the small header line on each page. +</p><p>Prepare your faxheader <tt>/usr/local/etc/mgetty+sendfax/faxheader</tt></p><p> +Edit your /etc/printcap file: +</p><pre class="programlisting"> +# FAX +lp3|fax:\ + :lp=/dev/null:\ + :sd=/usr/spool/lp3:\ + :if=/usr/local/etc/mgetty+sendfax/faxfilter:sh:sf:mx#0:\ + :lf=/usr/spool/lp3/fax-log: +</pre><p>Now, edit your <tt>smb.conf</tt> so you have a smb based printer named "fax"</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2874774"></a>Installing the client drivers</h3></div></div><p> +Now you have a printer called "fax" which can be used via +TCP/IP-printing (lpd-system) or via SAMBA (windows printing). +</p><p> +On every system you are able to produce postscript-files you +are ready to fax. +</p><p> +On Windows 3.1 95 and NT: +</p><p> +Install a printer wich produces postscript output, + e.g. apple laserwriter +</p><p>Connect the "fax" to your printer.</p><p> +Now write your first fax. Use your favourite wordprocessor, +write, winword, notepad or whatever you want, and start +with the headerpage. +</p><p> +Usually each fax has a header page. It carries your name, +your address, your phone/fax-number. +</p><p> +It carries also the recipient, his address and his *** fax +number ***. Now here is the trick: +</p><p> +Use the text: +</p><pre class="programlisting"> +Fax-Nr: 123456789 +</pre><p> +as the recipients fax-number. Make sure this text does not +occur in regular text ! Make sure this text is not broken +by formatting information, e.g. format it as a single entity. +(Windows Write and Win95 Wordpad are functional, maybe newer + versions of Winword are breaking formatting information). +</p><p> +The trick is that postscript output is human readable and +the faxfilter program scans the text for this pattern and +uses the found number as the fax-destination-number. +</p><p> +Now print your fax through the fax-printer and it will be +queued for later transmission. Use faxrunq for sending the +queue out. +</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2874858"></a>Example smb.conf</h3></div></div><pre class="programlisting"> +[global] + printcap name = /etc/printcap + print command = /usr/bin/lpr -r -P %p %s + lpq command = /usr/bin/lpq -P %p + lprm command = /usr/bin/lprm -P %p %j + +[fax] + comment = FAX (mgetty+sendfax) + path = /tmp + printable = yes + public = yes + writable = no + create mode = 0700 + browseable = yes + guest ok = no +</pre></div></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2874883"></a>Samba doesn't work well together with DHCP!</h2></div></div><p> +We wish to help those folks who wish to use the ISC DHCP Server and provide +sample configuration settings. Most operating systems today come ship with +the ISC DHCP Server. ISC DHCP is available from: +<a href="ftp://ftp.isc.org/isc/dhcp" target="_top">ftp://ftp.isc.org/isc/dhcp</a> +</p><p> +Incorrect configuration of MS Windows clients (Windows9X, Windows ME, Windows +NT/2000) will lead to problems with browsing and with general network +operation. Windows 9X/ME users often report problems where the TCP/IP and related +network settings will inadvertantly become reset at machine start-up resulting +in loss of configuration settings. This results in increased maintenance +overheads as well as serious user frustration. +</p><p> +In recent times users on one mailing list incorrectly attributed the cause of +network operating problems to incorrect configuration of Samba. +</p><p> +One user insisted that the only way to provent Windows95 from periodically +performing a full system reset and hardware detection process on start-up was +to install the NetBEUI protocol in addition to TCP/IP. This assertion is not +correct. +</p><p> +In the first place, there is NO need for NetBEUI. All Microsoft Windows clients +natively run NetBIOS over TCP/IP, and that is the only protocol that is +recognised by Samba. Installation of NetBEUI and/or NetBIOS over IPX will +cause problems with browse list operation on most networks. Even Windows NT +networks experience these problems when incorrectly configured Windows95 +systems share the same name space. It is important that only those protocols +that are strictly needed for site specific reasons should EVER be installed. +</p><p> +Secondly, and totally against common opinion, DHCP is NOT an evil design but is +an extension of the BOOTP protocol that has been in use in Unix environments +for many years without any of the melt-down problems that some sensationalists +would have us believe can be experienced with DHCP. In fact, DHCP in covered by +rfc1541 and is a very safe method of keeping an MS Windows desktop environment +under control and for ensuring stable network operation. +</p><p> +Please note that MS Windows systems as of MS Windows NT 3.1 and MS Windows 95 +store all network configuration settings a registry. There are a few reports +from MS Windows network administrators that warrant mention here. It would appear +that when one sets certain MS TCP/IP protocol settings (either directly or via +DHCP) that these do get written to the registry. Even though a subsequent +change of setting may occur the old value may persist in the registry. This +has been known to create serious networking problems. +</p><p> +An example of this occurs when a manual TCP/IP environment is configured to +include a NetBIOS Scope. In this event, when the administrator then changes the +configuration of the MS TCP/IP protocol stack, without first deleting the +current settings, by simply checking the box to configure the MS TCP/IP stack +via DHCP then the NetBIOS Scope that is still persistent in the registry WILL be +applied to the resulting DHCP offered settings UNLESS the DHCP server also sets +a NetBIOS Scope. It may therefore be prudent to forcibly apply a NULL NetBIOS +Scope from your DHCP server. The can be done in the dhcpd.conf file with the +parameter: +<b>option netbios-scope "";</b> +</p><p> +While it is true that the Microsoft DHCP server that comes with Windows NT +Server provides only a sub-set of rfc1533 functionality this is hardly an issue +in those sites that already have a large investment and commitment to Unix +systems and technologies. The current state of the art of the DHCP Server +specification in covered in rfc2132. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2874531"></a>How can I assign NetBIOS names to clients with DHCP?</h2></div></div><p> +SMB network clients need to be configured so that all standard TCP/IP name to +address resolution works correctly. Once this has been achieved the SMB +environment provides additional tools and services that act as helper agents in +the translation of SMB (NetBIOS) names to their appropriate IP Addresses. One +such helper agent is the NetBIOS Name Server (NBNS) or as Microsoft called it +in their Windows NT Server implementation WINS (Windows Internet Name Server). +</p><p> +A client needs to be configured so that it has a unique Machine (Computer) +Name. +</p><p> +This can be done, but needs a few NT registry hacks and you need to be able to +speak UNICODE, which is of course no problem for a True Wizzard(tm) :) +Instructions on how to do this (including a small util for less capable +Wizzards) can be found at +</p><p><a href="http://www.unixtools.org/~nneul/sw/nt/dhcp-netbios-hostname.html" target="_top">http://www.unixtools.org/~nneul/sw/nt/dhcp-netbios-hostname.html</a></p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2874581"></a>How do I convert between unix and dos text formats?</h2></div></div><p> +Jim barry has written an <a href="ftp://samba.org/pub/samba/contributed/fixcrlf.zip" target="_top"> +excellent drag-and-drop cr/lf converter for +windows</a>. Just drag your file onto the icon and it converts the file. +</p><p> +The utilities unix2dos and dos2unix(in the mtools package) should do +the job under unix. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2874612"></a>Does samba have wins replication support?</h2></div></div><p> +At the time of writing there is currently being worked on a wins replication implementation(wrepld). +</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="FAQ-errors.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="samba-faq.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="FAQ-Printing.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 5. Common errors </td><td width="20%" align="center"><a accesskey="h" href="samba-faq.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 7. Printing problems</td></tr></table></div></body></html> diff --git a/docs/faq/FAQ-general.html b/docs/faq/FAQ-general.html new file mode 100644 index 0000000000..0e6cae78d8 --- /dev/null +++ b/docs/faq/FAQ-general.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 1. General Information</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"><link rel="home" href="samba-faq.html" title="Samba FAQ"><link rel="up" href="samba-faq.html" title="Samba FAQ"><link rel="previous" href="samba-faq.html" title="Samba FAQ"><link rel="next" href="FAQ-Install.html" title="Chapter 2. Compiling and installing Samba on a Unix host"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 1. General Information</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="samba-faq.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="FAQ-Install.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><h2 class="title"><a name="FAQ-general"></a>Chapter 1. General Information</h2></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="FAQ-general.html#id2808041">Where can I get it?</a></dt><dt><a href="FAQ-general.html#id2808063">What do the version numbers mean?</a></dt><dt><a href="FAQ-general.html#id2808152">What platforms are supported?</a></dt><dt><a href="FAQ-general.html#id2808341">How do I subscribe to the Samba Mailing Lists?</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2808041"></a>Where can I get it?</h2></div></div><p> +The Samba suite is available at the <a href="http://samba.org/" target="_top">samba website</a>. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2808063"></a>What do the version numbers mean?</h2></div></div><p> +It is not recommended that you run a version of Samba with the word +"alpha" in its name unless you know what you are doing and are willing +to do some debugging. Many, many people just get the latest +recommended stable release version and are happy. If you are brave, by +all means take the plunge and help with the testing and development - +but don't install it on your departmental server. Samba is typically +very stable and safe, and this is mostly due to the policy of many +public releases. +</p><p> +How the scheme works: +</p><table class="simplelist" border="0" summary="Simple list"><tr><td>When major changes are made the version number is increased. For +example, the transition from 1.9.15 to 1.9.16. However, this version +number will not appear immediately and people should continue to use +1.9.15 for production systems (see next point.)</td></tr><tr><td>Just after major changes are made the software is considered +unstable, and a series of alpha releases are distributed, for example +1.9.16alpha1. These are for testing by those who know what they are +doing. The "alpha" in the filename will hopefully scare off those who +are just looking for the latest version to install.</td></tr><tr><td>When the release manager, currently Jerry, thinks that the alphas have stabilised to the point +where he would recommend new users install it, he renames it to the +same version number without the alpha, for example 1.9.16.</td></tr><tr><td>Inevitably bugs are found in the "stable" releases and minor patch +levels are released which give us the pXX series, for example 1.9.16p2.</td></tr></table><p> +</p><p> +So the progression goes: + +</p><pre class="programlisting"> +1.9.15p7 (production) +1.9.15p8 (production) +1.9.16alpha1 (test sites only) +: +1.9.16alpha20 (test sites only) +1.9.16 (production) +1.9.16p1 (production) +</pre><p> +</p><p> +The above system means that whenever someone looks at the samba ftp +site they will be able to grab the highest numbered release without an +alpha in the name and be sure of getting the current recommended +version. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2808152"></a>What platforms are supported?</h2></div></div><p> +Many different platforms have run Samba successfully. The platforms +most widely used and thus best tested are Linux and SunOS.</p><p> +At time of writing, there is support (or has been support for in earlier +versions): +</p><table class="simplelist" border="0" summary="Simple list"><tr><td>A/UX 3.0</td></tr><tr><td>AIX</td></tr><tr><td>Altos Series 386/1000</td></tr><tr><td>Amiga</td></tr><tr><td>Apollo Domain/OS sr10.3</td></tr><tr><td>BSDI </td></tr><tr><td>B.O.S. (Bull Operating System)</td></tr><tr><td>Cray, Unicos 8.0</td></tr><tr><td>Convex</td></tr><tr><td>DGUX. </td></tr><tr><td>DNIX.</td></tr><tr><td>FreeBSD</td></tr><tr><td>HP-UX</td></tr><tr><td>Intergraph. </td></tr><tr><td>Linux with/without shadow passwords and quota</td></tr><tr><td>LYNX 2.3.0</td></tr><tr><td>MachTen (a unix like system for Macintoshes)</td></tr><tr><td>Motorola 88xxx/9xx range of machines</td></tr><tr><td>NetBSD</td></tr><tr><td>NEXTSTEP Release 2.X, 3.0 and greater (including OPENSTEP for Mach).</td></tr><tr><td>OS/2 using EMX 0.9b</td></tr><tr><td>OSF1</td></tr><tr><td>QNX 4.22</td></tr><tr><td>RiscIX. </td></tr><tr><td>RISCOs 5.0B</td></tr><tr><td>SEQUENT. </td></tr><tr><td>SCO (including: 3.2v2, European dist., OpenServer 5)</td></tr><tr><td>SGI.</td></tr><tr><td>SMP_DC.OSx v1.1-94c079 on Pyramid S series</td></tr><tr><td>SONY NEWS, NEWS-OS (4.2.x and 6.1.x)</td></tr><tr><td>SUNOS 4</td></tr><tr><td>SUNOS 5.2, 5.3, and 5.4 (Solaris 2.2, 2.3, and '2.4 and later')</td></tr><tr><td>Sunsoft ISC SVR3V4</td></tr><tr><td>SVR4</td></tr><tr><td>System V with some berkely extensions (Motorola 88k R32V3.2).</td></tr><tr><td>ULTRIX.</td></tr><tr><td>UNIXWARE</td></tr><tr><td>UXP/DS</td></tr></table></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2808341"></a>How do I subscribe to the Samba Mailing Lists?</h2></div></div><p> +Look at <a href="http://samba.org/samba/archives.html" target="_top">the samba mailing list page</a> +</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="samba-faq.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="samba-faq.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="FAQ-Install.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Samba FAQ </td><td width="20%" align="center"><a accesskey="h" href="samba-faq.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 2. Compiling and installing Samba on a Unix host</td></tr></table></div></body></html> diff --git a/docs/htmldocs/compiling.html b/docs/htmldocs/compiling.html new file mode 100644 index 0000000000..c62fcf13f2 --- /dev/null +++ b/docs/htmldocs/compiling.html @@ -0,0 +1,186 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 30. How to compile SAMBA</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"><link rel="home" href="index.html" title="SAMBA Project Documentation"><link rel="up" href="Appendixes.html" title="Part V. Appendixes"><link rel="previous" href="Appendixes.html" title="Part V. Appendixes"><link rel="next" href="NT4Migration.html" title="Chapter 31. Migration from NT4 PDC to Samba-3 PDC"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 30. How to compile SAMBA</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="Appendixes.html">Prev</a> </td><th width="60%" align="center">Part V. Appendixes</th><td width="20%" align="right"> <a accesskey="n" href="NT4Migration.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><h2 class="title"><a name="compiling"></a>Chapter 30. How to compile SAMBA</h2></div><div><div class="author"><h3 class="author"></h3><div class="affiliation"><span class="orgname">Samba Team<br></span></div></div></div><div><div class="author"><h3 class="author">Jelmer R. Vernooij</h3><div class="affiliation"><span class="orgname">The Samba Team<br></span><div class="address"><p><tt><<a href="mailto:jelmer@samba.org">jelmer@samba.org</a>></tt></p></div></div></div></div><div><p class="pubdate"> (22 May 2001) </p></div><div><p class="pubdate"> 18 March 2003 </p></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="compiling.html#id2904479">Access Samba source code via CVS</a></dt><dd><dl><dt><a href="compiling.html#id2904486">Introduction</a></dt><dt><a href="compiling.html#id2904519">CVS Access to samba.org</a></dt></dl></dd><dt><a href="compiling.html#id2905273">Accessing the samba sources via rsync and ftp</a></dt><dt><a href="compiling.html#id2905314">Verifying Samba's PGP signature</a></dt><dt><a href="compiling.html#id2905397">Building the Binaries</a></dt><dd><dl><dt><a href="compiling.html#id2905534">Compiling samba with Active Directory support</a></dt></dl></dd><dt><a href="compiling.html#id2905682">Starting the smbd and nmbd</a></dt><dd><dl><dt><a href="compiling.html#id2905749">Starting from inetd.conf</a></dt><dt><a href="compiling.html#id2905941">Alternative: starting it as a daemon</a></dt></dl></dd></dl></div><p> +You can obtain the samba source from the <a href="http://samba.org/" target="_top">samba website</a>. To obtain a development version, +you can download samba from CVS or using rsync. +</p><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2904479"></a>Access Samba source code via CVS</h2></div></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2904486"></a>Introduction</h3></div></div><p> +Samba is developed in an open environment. Developers use CVS +(Concurrent Versioning System) to "checkin" (also known as +"commit") new source code. Samba's various CVS branches can +be accessed via anonymous CVS using the instructions +detailed in this chapter. +</p><p> +This chapter is a modified version of the instructions found at +<a href="http://samba.org/samba/cvs.html" target="_top">http://samba.org/samba/cvs.html</a> +</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2904519"></a>CVS Access to samba.org</h3></div></div><p> +The machine samba.org runs a publicly accessible CVS +repository for access to the source code of several packages, +including samba, rsync and jitterbug. There are two main ways of +accessing the CVS server on this host. +</p><div class="sect3" lang="en"><div class="titlepage"><div><h4 class="title"><a name="id2904535"></a>Access via CVSweb</h4></div></div><p> +You can access the source code via your +favourite WWW browser. This allows you to access the contents of +individual files in the repository and also to look at the revision +history and commit logs of individual files. You can also ask for a diff +listing between any two versions on the repository. +</p><p> +Use the URL : <a href="http://samba.org/cgi-bin/cvsweb" target="_top">http://samba.org/cgi-bin/cvsweb</a> +</p></div><div class="sect3" lang="en"><div class="titlepage"><div><h4 class="title"><a name="id2905096"></a>Access via cvs</h4></div></div><p> +You can also access the source code via a +normal cvs client. This gives you much more control over what you can +do with the repository and allows you to checkout whole source trees +and keep them up to date via normal cvs commands. This is the +preferred method of access if you are a developer and not +just a casual browser. +</p><p> +To download the latest cvs source code, point your +browser at the URL : <a href="http://www.cyclic.com/" target="_top">http://www.cyclic.com/</a>. +and click on the 'How to get cvs' link. CVS is free software under +the GNU GPL (as is Samba). Note that there are several graphical CVS clients +which provide a graphical interface to the sometimes mundane CVS commands. +Links to theses clients are also available from http://www.cyclic.com. +</p><p> +To gain access via anonymous cvs use the following steps. +For this example it is assumed that you want a copy of the +samba source code. For the other source code repositories +on this system just substitute the correct package name +</p><div class="orderedlist"><ol type="1"><li><p> + Install a recent copy of cvs. All you really need is a + copy of the cvs client binary. + </p></li><li><p> + Run the command + </p><p> + <b><tt>cvs -d :pserver:cvs@samba.org:/cvsroot login</tt></b> + </p><p> + When it asks you for a password type <b><tt>cvs</tt></b>. + </p></li><li><p> + Run the command + </p><p> + <b><tt>cvs -d :pserver:cvs@samba.org:/cvsroot co samba</tt></b> + </p><p> + This will create a directory called samba containing the + latest samba source code (i.e. the HEAD tagged cvs branch). This + currently corresponds to the 3.0 development tree. + </p><p> + CVS branches other then HEAD can be obtained by using the <i><tt>-r</tt></i> + and defining a tag name. A list of branch tag names can be found on the + "Development" page of the samba web site. A common request is to obtain the + latest 2.2 release code. This could be done by using the following userinput. + </p><p> + <b><tt>cvs -d :pserver:cvs@samba.org:/cvsroot co -r SAMBA_2_2 samba</tt></b> + </p></li><li><p> + Whenever you want to merge in the latest code changes use + the following command from within the samba directory: + </p><p> + <b><tt>cvs update -d -P</tt></b> + </p></li></ol></div></div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2905273"></a>Accessing the samba sources via rsync and ftp</h2></div></div><p> + pserver.samba.org also exports unpacked copies of most parts of the CVS tree at <a href="ftp://pserver.samba.org/pub/unpacked" target="_top">ftp://pserver.samba.org/pub/unpacked</a> and also via anonymous rsync at rsync://pserver.samba.org/ftp/unpacked/. I recommend using rsync rather than ftp. + See <a href="http://rsync.samba.org/" target="_top">the rsync homepage</a> for more info on rsync. + </p><p> + The disadvantage of the unpacked trees + is that they do not support automatic + merging of local changes like CVS does. + rsync access is most convenient for an + initial install. + </p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2905314"></a>Verifying Samba's PGP signature</h2></div></div><p> +In these days of insecurity, it's strongly recommended that you verify the PGP signature for any +source file before installing it. According to Jerry Carter of the Samba Team, only about 22% of +all Samba downloads have had a corresponding PGP signature download (a very low percentage, which +should be considered a bad thing). Even if you're not downloading from a mirror site, verifying PGP +signatures should be a standard reflex. +</p><p> +With that said, go ahead and download the following files: +</p><pre class="programlisting"> + $ wget http://us1.samba.org/samba/ftp/samba-2.2.8a.tar.asc + $ wget http://us1.samba.org/samba/ftp/samba-pubkey.asc +</pre><p> +The first file is the PGP signature for the Samba source file; the other is the Samba public +PGP key itself. Import the public PGP key with: +</p><pre class="programlisting"> + $ gpg --import samba-pubkey.asc +</pre><p> +And verify the Samba source code integrity with: +</p><pre class="programlisting"> + $ gzip -d samba-2.2.8a.tar.gz + $ gpg --verify samba-2.2.8a.tar.asc +</pre><p> +If you receive a message like, "Good signature from Samba Distribution Verification Key..." +then all is well. The warnings about trust relationships can be ignored. An example of what +you would not want to see would be: +</p><pre class="programlisting"> + gpg: BAD signature from "Samba Distribution Verification Key" +</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2905397"></a>Building the Binaries</h2></div></div><p>To do this, first run the program <b><tt>./configure + </tt></b> in the source directory. This should automatically + configure Samba for your operating system. If you have unusual + needs then you may wish to run</p><p><tt>root# </tt><b><tt>./configure --help + </tt></b></p><p>first to see what special options you can enable. + Then executing</p><p><tt>root# </tt><b><tt>make</tt></b></p><p>will create the binaries. Once it's successfully + compiled you can use </p><p><tt>root# </tt><b><tt>make install</tt></b></p><p>to install the binaries and manual pages. You can + separately install the binaries and/or man pages using</p><p><tt>root# </tt><b><tt>make installbin + </tt></b></p><p>and</p><p><tt>root# </tt><b><tt>make installman + </tt></b></p><p>Note that if you are upgrading for a previous version + of Samba you might like to know that the old versions of + the binaries will be renamed with a ".old" extension. You + can go back to the previous version with</p><p><tt>root# </tt><b><tt>make revert + </tt></b></p><p>if you find this version a disaster!</p><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2905534"></a>Compiling samba with Active Directory support</h3></div></div><p>In order to compile samba with ADS support, you need to have installed + on your system:</p><div class="itemizedlist"><ul type="disc"><li><p>the MIT kerberos development libraries + (either install from the sources or use a package). The + heimdal libraries will not work.</p></li><li><p>the OpenLDAP development libraries.</p></li></ul></div><p>If your kerberos libraries are in a non-standard location then + remember to add the configure option --with-krb5=DIR.</p><p>After you run configure make sure that <tt>include/config.h</tt> it generates contains lines like this:</p><pre class="programlisting"> +#define HAVE_KRB5 1 +#define HAVE_LDAP 1 +</pre><p>If it doesn't then configure did not find your krb5 libraries or + your ldap libraries. Look in config.log to figure out why and fix + it.</p><div class="sect3" lang="en"><div class="titlepage"><div><h4 class="title"><a name="id2905601"></a>Installing the required packages for Debian</h4></div></div><p>On Debian you need to install the following packages:</p><p> + </p><div class="itemizedlist"><ul type="disc"><li>libkrb5-dev</li><li>krb5-user</li></ul></div><p> + </p></div><div class="sect3" lang="en"><div class="titlepage"><div><h4 class="title"><a name="id2905632"></a>Installing the required packages for RedHat</h4></div></div><p>On RedHat this means you should have at least: </p><p> + </p><div class="itemizedlist"><ul type="disc"><li>krb5-workstation (for kinit)</li><li>krb5-libs (for linking with)</li><li>krb5-devel (because you are compiling from source)</li></ul></div><p> + </p><p>in addition to the standard development environment.</p><p>Note that these are not standard on a RedHat install, and you may need + to get them off CD2.</p></div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2905682"></a>Starting the smbd and nmbd</h2></div></div><p>You must choose to start smbd and nmbd either + as daemons or from inetdDon't try + to do both! Either you can put them in <tt> + inetd.conf</tt> and have them started on demand + by inetd, or you can start them as + daemons either from the command line or in <tt> + /etc/rc.local</tt>. See the man pages for details + on the command line options. Take particular care to read + the bit about what user you need to be in order to start + Samba. In many cases you must be root.</p><p>The main advantage of starting smbd + and nmbd using the recommended daemon method + is that they will respond slightly more quickly to an initial connection + request.</p><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2905749"></a>Starting from inetd.conf</h3></div></div><p>NOTE; The following will be different if + you use NIS, NIS+ or LDAP to distribute services maps.</p><p>Look at your <tt>/etc/services</tt>. + What is defined at port 139/tcp. If nothing is defined + then add a line like this:</p><p><b><tt>netbios-ssn 139/tcp</tt></b></p><p>similarly for 137/udp you should have an entry like:</p><p><b><tt>netbios-ns 137/udp</tt></b></p><p>Next edit your <tt>/etc/inetd.conf</tt> + and add two lines something like this:</p><pre class="programlisting"> + netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd smbd + netbios-ns dgram udp wait root /usr/local/samba/bin/nmbd nmbd + </pre><p>The exact syntax of <tt>/etc/inetd.conf</tt> + varies between unixes. Look at the other entries in inetd.conf + for a guide.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Some unixes already have entries like netbios_ns + (note the underscore) in <tt>/etc/services</tt>. + You must either edit <tt>/etc/services</tt> or + <tt>/etc/inetd.conf</tt> to make them consistent.</p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>On many systems you may need to use the + <b>interfaces</b> option in <tt>smb.conf</tt> to specify the IP address + and netmask of your interfaces. Run ifconfig + as root if you don't know what the broadcast is for your + net. nmbd tries to determine it at run + time, but fails on some unixes. + </p></div><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Many unixes only accept around 5 + parameters on the command line in <tt>inetd.conf</tt>. + This means you shouldn't use spaces between the options and + arguments, or you should use a script, and start the script + from <b>inetd</b>.</p></div><p>Restart <b>inetd</b>, perhaps just send + it a HUP. If you have installed an earlier version of + nmbd then you may need to kill nmbd as well.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2905941"></a>Alternative: starting it as a daemon</h3></div></div><p>To start the server as a daemon you should create + a script something like this one, perhaps calling + it <tt>startsmb</tt>.</p><pre class="programlisting"> + #!/bin/sh + /usr/local/samba/bin/smbd -D + /usr/local/samba/bin/nmbd -D + </pre><p>then make it executable with <b>chmod + +x startsmb</b></p><p>You can then run <b>startsmb</b> by + hand or execute it from <tt>/etc/rc.local</tt> + </p><p>To kill it send a kill signal to the processes + <b>nmbd</b> and <b>smbd</b>.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>If you use the SVR4 style init system then + you may like to look at the <tt>examples/svr4-startup</tt> + script to make Samba fit into that system.</p></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="Appendixes.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="Appendixes.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="NT4Migration.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Part V. Appendixes </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 31. Migration from NT4 PDC to Samba-3 PDC</td></tr></table></div></body></html> diff --git a/docs/htmldocs/domain-member.html b/docs/htmldocs/domain-member.html new file mode 100644 index 0000000000..5be675a541 --- /dev/null +++ b/docs/htmldocs/domain-member.html @@ -0,0 +1,79 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 8. Samba as a NT4 or Win2k domain member</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"><link rel="home" href="index.html" title="SAMBA Project Documentation"><link rel="up" href="type.html" title="Part II. Server Configuration Basics"><link rel="previous" href="ADS.html" title="Chapter 7. Samba as a ADS domain member"><link rel="next" href="optional.html" title="Part III. Advanced Configuration"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 8. Samba as a NT4 or Win2k domain member</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ADS.html">Prev</a> </td><th width="60%" align="center">Part II. Server Configuration Basics</th><td width="20%" align="right"> <a accesskey="n" href="optional.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><h2 class="title"><a name="domain-member"></a>Chapter 8. Samba as a NT4 or Win2k domain member</h2></div><div><div class="author"><h3 class="author">Jeremy Allison</h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt><<a href="mailto:jra@samba.org">jra@samba.org</a>></tt></p></div></div></div></div><div><div class="author"><h3 class="author">Gerald (Jerry) Carter</h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt><<a href="mailto:jerry@samba.org">jerry@samba.org</a>></tt></p></div></div></div></div><div><p class="pubdate">16 Apr 2001</p></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="domain-member.html#id2879309">Joining an NT Domain with Samba 3.0</a></dt><dt><a href="domain-member.html#id2880214">Why is this better than security = server?</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2879309"></a>Joining an NT Domain with Samba 3.0</h2></div></div><p><span class="emphasis"><em>Assumptions:</em></span> + </p><pre class="programlisting"> + NetBIOS name: SERV1 + Win2K/NT domain name: DOM + Domain's PDC NetBIOS name: DOMPDC + Domain's BDC NetBIOS names: DOMBDC1 and DOMBDC2 + </pre><p> + </p><p>First, you must edit your <tt>smb.conf</tt> file to tell Samba it should + now use domain security.</p><p>Change (or add) your <a href="smb.conf.5.html#SECURITY" target="_top"> + <i><tt>security =</tt></i></a> line in the [global] section + of your <tt>smb.conf</tt> to read:</p><p><b>security = domain</b></p><p>Next change the <a href="smb.conf.5.html#WORKGROUP" target="_top"><i><tt> + workgroup =</tt></i></a> line in the [global] section to read: </p><p><b>workgroup = DOM</b></p><p>as this is the name of the domain we are joining. </p><p>You must also have the parameter <a href="smb.conf.5.html#ENCRYPTPASSWORDS" target="_top"> + <i><tt>encrypt passwords</tt></i></a> set to <tt>yes + </tt> in order for your users to authenticate to the NT PDC.</p><p>Finally, add (or modify) a <a href="smb.conf.5.html#PASSWORDSERVER" target="_top"> + <i><tt>password server =</tt></i></a> line in the [global] + section to read: </p><p><b>password server = DOMPDC DOMBDC1 DOMBDC2</b></p><p>These are the primary and backup domain controllers Samba + will attempt to contact in order to authenticate users. Samba will + try to contact each of these servers in order, so you may want to + rearrange this list in order to spread out the authentication load + among domain controllers.</p><p>Alternatively, if you want smbd to automatically determine + the list of Domain controllers to use for authentication, you may + set this line to be :</p><p><b>password server = *</b></p><p>This method, allows Samba to use exactly the same + mechanism that NT does. This + method either broadcasts or uses a WINS database in order to + find domain controllers to authenticate against.</p><p>In order to actually join the domain, you must run this + command:</p><p><tt>root# </tt><b><tt>net join -S DOMPDC + -U<i><tt>Administrator%password</tt></i></tt></b></p><p> + If the <b><tt>-S DOMPDC</tt></b> argument is not given then + the domain name will be obtained from smb.conf. + </p><p>as we are joining the domain DOM and the PDC for that domain + (the only machine that has write access to the domain SAM database) + is DOMPDC. The <i><tt>Administrator%password</tt></i> is + the login name and password for an account which has the necessary + privilege to add machines to the domain. If this is successful + you will see the message:</p><p><tt>Joined domain DOM.</tt> + or <tt>Joined 'SERV1' to realm 'MYREALM'</tt> + </p><p>in your terminal window. See the <a href="net.8.html" target="_top"> + net(8)</a> man page for more details.</p><p>This process joins the server to the domain + without having to create the machine trust account on the PDC + beforehand.</p><p>This command goes through the machine account password + change protocol, then writes the new (random) machine account + password for this Samba server into a file in the same directory + in which an smbpasswd file would be stored - normally :</p><p><tt>/usr/local/samba/private/secrets.tdb</tt></p><p>This file is created and owned by root and is not + readable by any other user. It is the key to the domain-level + security for your system, and should be treated as carefully + as a shadow password file.</p><p>Finally, restart your Samba daemons and get ready for + clients to begin using domain security!</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2880214"></a>Why is this better than security = server?</h2></div></div><p>Currently, domain security in Samba doesn't free you from + having to create local Unix users to represent the users attaching + to your server. This means that if domain user <tt>DOM\fred + </tt> attaches to your domain security Samba server, there needs + to be a local Unix user fred to represent that user in the Unix + filesystem. This is very similar to the older Samba security mode + <a href="smb.conf.5.html#SECURITYEQUALSSERVER" target="_top">security = server</a>, + where Samba would pass through the authentication request to a Windows + NT server in the same way as a Windows 95 or Windows 98 server would. + </p><p>Please refer to the <a href="winbind.html" target="_top">Winbind + paper</a> for information on a system to automatically + assign UNIX uids and gids to Windows NT Domain users and groups. + </p><p>The advantage to domain-level security is that the + authentication in domain-level security is passed down the authenticated + RPC channel in exactly the same way that an NT server would do it. This + means Samba servers now participate in domain trust relationships in + exactly the same way NT servers do (i.e., you can add Samba servers into + a resource domain and have the authentication passed on from a resource + domain PDC to an account domain PDC).</p><p>In addition, with <b>security = server</b> every Samba + daemon on a server has to keep a connection open to the + authenticating server for as long as that daemon lasts. This can drain + the connection resources on a Microsoft NT server and cause it to run + out of available connections. With <b>security = domain</b>, + however, the Samba daemons connect to the PDC/BDC only for as long + as is necessary to authenticate the user, and then drop the connection, + thus conserving PDC connection resources.</p><p>And finally, acting in the same manner as an NT server + authenticating to a PDC means that as part of the authentication + reply, the Samba server gets the user identification information such + as the user SID, the list of NT groups the user belongs to, etc. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> Much of the text of this document + was first published in the Web magazine <a href="http://www.linuxworld.com" target="_top"> + LinuxWorld</a> as the article <a href="http://www.linuxworld.com/linuxworld/lw-1998-10/lw-10-samba.html" target="_top">Doing + the NIS/NT Samba</a>.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ADS.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="type.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="optional.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 7. Samba as a ADS domain member </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Part III. Advanced Configuration</td></tr></table></div></body></html> diff --git a/docs/htmldocs/editreg.1.html b/docs/htmldocs/editreg.1.html new file mode 100644 index 0000000000..c5a86ee960 --- /dev/null +++ b/docs/htmldocs/editreg.1.html @@ -0,0 +1,12 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>editreg</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="editreg.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>editreg — A utility to report and change SIDs in registry files + </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>editreg</tt> [-v] [-c file] {file}</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html">Samba(7)</a> suite.</p><p><b>editreg</b> is a utility that + can visualize windows registry files (currently only NT4) and apply + so-called commandfiles to them. + </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">registry_file</span></dt><dd><p>Registry file to view or edit. </p></dd><dt><span class="term">-v,--verbose</span></dt><dd><p>Increases verbosity of messages. + </p></dd><dt><span class="term">-c commandfile</span></dt><dd><p>Read commands to execute on <tt>registry_file</tt> from <tt>commandfile</tt>. Currently not yet supported! + </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba + suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The editreg man page was written by Jelmer Vernooij. </p></div></div></body></html> diff --git a/docs/htmldocs/ntlm_auth.1.html b/docs/htmldocs/ntlm_auth.1.html new file mode 100644 index 0000000000..956f30641d --- /dev/null +++ b/docs/htmldocs/ntlm_auth.1.html @@ -0,0 +1,45 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ntlm_auth</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ntlm-auth.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ntlm_auth — tool to allow external access to Winbind's NTLM authentication function</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>ntlm_auth</tt> [-d debuglevel] [-l logfile] [-s <smb config file>]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html">Samba(7)</a> suite.</p><p><b>ntlm_auth</b> is a helper utility that authenticates + users using NT/LM authentication. It returns 0 if the users is authenticated + successfully and 1 if access was denied. ntlm_auth uses winbind to access + the user and authentication data for a domain. This utility + is only to be used by other programs (currently squid). + </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">--helper-protocol=PROTO</span></dt><dd><p> + Operate as a stdio-based helper + </p></dd><dt><span class="term">--username=USERNAME</span></dt><dd><p> + Specify username of user to authenticate + </p></dd><dt><span class="term">--domain=DOMAIN</span></dt><dd><p> + Specify domain of user to authenticate + </p></dd><dt><span class="term">--workstation=WORKSTATION</span></dt><dd><p> + Specify the workstation the user authenticated from + </p></dd><dt><span class="term">--challenge=STRING</span></dt><dd><p>challenge (HEX encoded)</p></dd><dt><span class="term">--lm-response=RESPONSE</span></dt><dd><p>LM Response to the challenge (HEX encoded)</p></dd><dt><span class="term">--nt-response=RESPONSE</span></dt><dd><p>NT or NTLMv2 Response to the challenge (HEX encoded)</p></dd><dt><span class="term">--password=PASSWORD</span></dt><dd><p>User's plaintext password</p></dd><dt><span class="term">--request-lm-key</span></dt><dd><p>Retreive LM session key</p></dd><dt><span class="term">--request-nt-key</span></dt><dd><p>Request NT key</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for +<b>smbd</b>.</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <a href="smb.conf.5.html" target="_top"><tt> +smb.conf(5)</tt></a> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i><tt>debuglevel</tt></i> is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a href="smb.conf.5.html#loglevel" target="_top">log +level</a> parameter in the <a href="smb.conf.5.html" target="_top"> +<tt>smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension +<tt>".client"</tt> will be appended. The log file is +never removed by the client. +</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba + suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The ntlm_auth manpage was written by Jelmer Vernooij.</p></div></div></body></html> diff --git a/docs/htmldocs/passdb.html b/docs/htmldocs/passdb.html new file mode 100644 index 0000000000..9f313ee123 --- /dev/null +++ b/docs/htmldocs/passdb.html @@ -0,0 +1,518 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 10. User information database</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"><link rel="home" href="index.html" title="SAMBA Project Documentation"><link rel="up" href="optional.html" title="Part III. Advanced Configuration"><link rel="previous" href="NetworkBrowsing.html" title="Chapter 9. Samba / MS Windows Network Browsing Guide"><link rel="next" href="unix-permissions.html" title="Chapter 11. UNIX Permission Bits and Windows NT Access Control Lists"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 10. User information database</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="NetworkBrowsing.html">Prev</a> </td><th width="60%" align="center">Part III. Advanced Configuration</th><td width="20%" align="right"> <a accesskey="n" href="unix-permissions.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><h2 class="title"><a name="passdb"></a>Chapter 10. User information database</h2></div><div><div class="author"><h3 class="author">Jelmer R. Vernooij</h3><div class="affiliation"><span class="orgname">The Samba Team<br></span><div class="address"><p><tt><<a href="mailto:jelmer@samba.org">jelmer@samba.org</a>></tt></p></div></div></div></div><div><div class="author"><h3 class="author">Gerald (Jerry) Carter</h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt><<a href="mailto:jerry@samba.org">jerry@samba.org</a>></tt></p></div></div></div></div><div><div class="author"><h3 class="author">Jeremy Allison</h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt><<a href="mailto:jra@samba.org">jra@samba.org</a>></tt></p></div></div></div></div><div><div class="author"><h3 class="author">John H. Terpstra</h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt><<a href="mailto:jht@samba.org">jht@samba.org</a>></tt></p></div></div></div></div><div><div class="author"><h3 class="author">Olivier (lem) Lemaire</h3><div class="affiliation"><span class="orgname">IDEALX<br></span><div class="address"><p><tt><<a href="mailto:olem@IDEALX.org">olem@IDEALX.org</a>></tt></p></div></div></div></div><div><p class="pubdate">February 2003</p></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="passdb.html#id2882995">Introduction</a></dt><dt><a href="passdb.html#id2883048">Important Notes About Security</a></dt><dd><dl><dt><a href="passdb.html#id2883210">Advantages of SMB Encryption</a></dt><dt><a href="passdb.html#id2883249">Advantages of non-encrypted passwords</a></dt></dl></dd><dt><a href="passdb.html#id2883283">The smbpasswd Command</a></dt><dt><a href="passdb.html#id2883464">Plain text</a></dt><dt><a href="passdb.html#id2883493">TDB</a></dt><dt><a href="passdb.html#id2883509">LDAP</a></dt><dd><dl><dt><a href="passdb.html#id2883516">Introduction</a></dt><dt><a href="passdb.html#id2883617">Encrypted Password Database</a></dt><dt><a href="passdb.html#id2883756">Supported LDAP Servers</a></dt><dt><a href="passdb.html#id2883794">Schema and Relationship to the RFC 2307 posixAccount</a></dt><dt><a href="passdb.html#id2883904">Configuring Samba with LDAP</a></dt><dt><a href="passdb.html#id2884200">Accounts and Groups management</a></dt><dt><a href="passdb.html#id2884237">Security and sambaAccount</a></dt><dt><a href="passdb.html#id2884352">LDAP specials attributes for sambaAccounts</a></dt><dt><a href="passdb.html#id2884633">Example LDIF Entries for a sambaAccount</a></dt></dl></dd><dt><a href="passdb.html#id2884689">MySQL</a></dt><dd><dl><dt><a href="passdb.html#id2884696">Creating the database</a></dt><dt><a href="passdb.html#id2884750">Configuring</a></dt><dt><a href="passdb.html#id2884895">Using plaintext passwords or encrypted password</a></dt><dt><a href="passdb.html#id2884925">Getting non-column data from the table</a></dt></dl></dd><dt><a href="passdb.html#id2884968">XML</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2882995"></a>Introduction</h2></div></div><p>Old windows clients send plain text passwords over the wire. + Samba can check these passwords by crypting them and comparing them + to the hash stored in the unix user database. + </p><p> + Newer windows clients send encrypted passwords (so-called + Lanman and NT hashes) over + the wire, instead of plain text passwords. The newest clients + will only send encrypted passwords and refuse to send plain text + passwords, unless their registry is tweaked. + </p><p>These passwords can't be converted to unix style encrypted + passwords. Because of that you can't use the standard unix + user database, and you have to store the Lanman and NT hashes + somewhere else. </p><p>Next to a differently encrypted passwords, + windows also stores certain data for each user + that is not stored in a unix user database, e.g. + workstations the user may logon from, the location where his/her + profile is stored, etc. + Samba retrieves and stores this information using a "passdb backend". + Commonly + available backends are LDAP, plain text file, MySQL and nisplus. + For more information, see the documentation about the + <b>passdb backend = </b> parameter. + </p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2883048"></a>Important Notes About Security</h2></div></div><p>The unix and SMB password encryption techniques seem similar + on the surface. This similarity is, however, only skin deep. The unix + scheme typically sends clear text passwords over the network when + logging in. This is bad. The SMB encryption scheme never sends the + cleartext password over the network but it does store the 16 byte + hashed values on disk. This is also bad. Why? Because the 16 byte hashed + values are a "password equivalent". You cannot derive the user's + password from them, but they could potentially be used in a modified + client to gain access to a server. This would require considerable + technical knowledge on behalf of the attacker but is perfectly possible. + You should thus treat the data stored in whatever + passdb backend you use (smbpasswd file, ldap, mysql) as though it contained the + cleartext passwords of all your users. Its contents must be kept + secret, and the file should be protected accordingly.</p><p>Ideally we would like a password scheme which neither requires + plain text passwords on the net or on disk. Unfortunately this + is not available as Samba is stuck with being compatible with + other SMB systems (WinNT, WfWg, Win95 etc). </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Note that Windows NT 4.0 Service pack 3 changed the + default for permissible authentication so that plaintext + passwords are <span class="emphasis"><em>never</em></span> sent over the wire. + The solution to this is either to switch to encrypted passwords + with Samba or edit the Windows NT registry to re-enable plaintext + passwords. See the document WinNT.txt for details on how to do + this.</p><p>Other Microsoft operating systems which also exhibit + this behavior includes</p><p> These versions of MS Windows do not support full domain + security protocols, although they may log onto a domain environment. + Of these Only MS Windows XP Home does NOT support domain logons.</p><table class="simplelist" border="0" summary="Simple list"><tr><td>MS DOS Network client 3.0 with + the basic network redirector installed</td></tr><tr><td>Windows 95 with the network redirector + update installed</td></tr><tr><td>Windows 98 [se]</td></tr><tr><td>Windows Me</td></tr><tr><td>Windows XP Home</td></tr></table><p> The following versions of MS Windows fully support domain + security protocols.</p><table class="simplelist" border="0" summary="Simple list"><tr><td>Windows NT 3.5x</td></tr><tr><td>Windows NT 4.0</td></tr><tr><td>Windows 2000 Professional</td></tr><tr><td>Windows 200x Server/Advanced Server</td></tr><tr><td>Windows XP Professional</td></tr></table></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>All current release of + Microsoft SMB/CIFS clients support authentication via the + SMB Challenge/Response mechanism described here. Enabling + clear text authentication does not disable the ability + of the client to participate in encrypted authentication.</p></div><p>MS Windows clients will cache the encrypted password alone. + Even when plain text passwords are re-enabled, through the appropriate + registry change, the plain text password is NEVER cached. This means that + in the event that a network connections should become disconnected (broken) + only the cached (encrypted) password will be sent to the resource server + to affect a auto-reconnect. If the resource server does not support encrypted + passwords the auto-reconnect will fail. <span class="emphasis"><em>USE OF ENCRYPTED PASSWORDS + IS STRONGLY ADVISED.</em></span></p><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2883210"></a>Advantages of SMB Encryption</h3></div></div><table class="simplelist" border="0" summary="Simple list"><tr><td>Plain text passwords are not passed across + the network. Someone using a network sniffer cannot just + record passwords going to the SMB server.</td></tr><tr><td>WinNT doesn't like talking to a server + that does not support encrypted passwords. It will refuse + to browse the server if the server is also in user level + security mode. It will insist on prompting the user for the + password on each connection, which is very annoying. The + only things you can do to stop this is to use SMB encryption. + </td></tr><tr><td>Encrypted password support allows automatic share + (resource) reconnects.</td></tr></table></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2883249"></a>Advantages of non-encrypted passwords</h3></div></div><table class="simplelist" border="0" summary="Simple list"><tr><td>Plain text passwords are not kept + on disk, and are NOT cached in memory. </td></tr><tr><td>Uses same password file as other unix + services such as login and ftp</td></tr><tr><td>Use of other services (such as telnet and ftp) which + send plain text passwords over the net, so sending them for SMB + isn't such a big deal.</td></tr></table></div></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2883283"></a>The smbpasswd Command</h2></div></div><p>The smbpasswd utility is a utility similar to the + <b>passwd</b> or <b>yppasswd</b> programs. + It maintains the two 32 byte password fields in the passdb backend. </p><p><b>smbpasswd</b> works in a client-server mode + where it contacts the local smbd to change the user's password on its + behalf. This has enormous benefits - as follows.</p><p><b>smbpasswd</b> has the capability + to change passwords on Windows NT servers (this only works when + the request is sent to the NT Primary Domain Controller if you + are changing an NT Domain user's password).</p><p>To run smbpasswd as a normal user just type :</p><p><tt>$ </tt><b><tt>smbpasswd</tt></b></p><p><tt>Old SMB password: </tt><b><tt><type old value here - + or hit return if there was no old password></tt></b></p><p><tt>New SMB Password: </tt><b><tt><type new value> + </tt></b></p><p><tt>Repeat New SMB Password: </tt><b><tt><re-type new value + </tt></b></p><p>If the old value does not match the current value stored for + that user, or the two new values do not match each other, then the + password will not be changed.</p><p>If invoked by an ordinary user it will only allow the user + to change his or her own Samba password.</p><p>If run by the root user smbpasswd may take an optional + argument, specifying the user name whose SMB password you wish to + change. Note that when run as root smbpasswd does not prompt for + or check the old password value, thus allowing root to set passwords + for users who have forgotten their passwords.</p><p><b>smbpasswd</b> is designed to work in the same way + and be familiar to UNIX users who use the <b>passwd</b> or + <b>yppasswd</b> commands.</p><p>For more details on using <b>smbpasswd</b> refer + to the man page which will always be the definitive reference.</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2883464"></a>Plain text</h2></div></div><p> +Older versions of samba retrieved user information from the unix user database +and eventually some other fields from the file <tt>/etc/samba/smbpasswd</tt> +or <tt>/etc/smbpasswd</tt>. When password encryption is disabled, no +data is stored at all. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2883493"></a>TDB</h2></div></div><p>Samba can also store the user data in a "TDB" (Trivial Database). Using this backend +doesn't require any additional configuration. This backend is recommended for new installations that +don not require LDAP. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2883509"></a>LDAP</h2></div></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2883516"></a>Introduction</h3></div></div><p> +This document describes how to use an LDAP directory for storing Samba user +account information traditionally stored in the smbpasswd(5) file. It is +assumed that the reader already has a basic understanding of LDAP concepts +and has a working directory server already installed. For more information +on LDAP architectures and Directories, please refer to the following sites. +</p><div class="itemizedlist"><ul type="disc"><li><p>OpenLDAP - <a href="http://www.openldap.org/" target="_top">http://www.openldap.org/</a></p></li><li><p>iPlanet Directory Server - <a href="http://iplanet.netscape.com/directory" target="_top">http://iplanet.netscape.com/directory</a></p></li></ul></div><p> +Note that <a href="http://www.ora.com/" target="_top">O'Reilly Publishing</a> is working on +a guide to LDAP for System Administrators which has a planned release date of +early summer, 2002. +</p><p> +Two additional Samba resources which may prove to be helpful are +</p><div class="itemizedlist"><ul type="disc"><li><p>The <a href="http://www.unav.es/cti/ldap-smb/ldap-smb-3-howto.html" target="_top">Samba-PDC-LDAP-HOWTO</a> + maintained by Ignacio Coupeau.</p></li><li><p>The NT migration scripts from <a href="http://samba.idealx.org/" target="_top">IDEALX</a> that are + geared to manage users and group in such a Samba-LDAP Domain Controller configuration. + </p></li></ul></div></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2883617"></a>Encrypted Password Database</h3></div></div><p> +Traditionally, when configuring <a href="smb.conf.5.html#ENCRYPTPASSWORDS" target="_top">"encrypt +passwords = yes"</a> in Samba's <tt>smb.conf</tt> file, user account +information such as username, LM/NT password hashes, password change times, and account +flags have been stored in the <tt>smbpasswd(5)</tt> file. There are several +disadvantages to this approach for sites with very large numbers of users (counted +in the thousands). +</p><div class="itemizedlist"><ul type="disc"><li><p> +The first is that all lookups must be performed sequentially. Given that +there are approximately two lookups per domain logon (one for a normal +session connection such as when mapping a network drive or printer), this +is a performance bottleneck for large sites. What is needed is an indexed approach +such as is used in databases. +</p></li><li><p> +The second problem is that administrators who desired to replicate a +smbpasswd file to more than one Samba server were left to use external +tools such as <b>rsync(1)</b> and <b>ssh(1)</b> +and wrote custom, in-house scripts. +</p></li><li><p> +And finally, the amount of information which is stored in an +smbpasswd entry leaves no room for additional attributes such as +a home directory, password expiration time, or even a Relative +Identified (RID). +</p></li></ul></div><p> +As a result of these defeciencies, a more robust means of storing user attributes +used by smbd was developed. The API which defines access to user accounts +is commonly referred to as the samdb interface (previously this was called the passdb +API, and is still so named in the CVS trees). +</p><p> +There are a few points to stress about that the ldapsam +does not provide. The LDAP support referred to in the this documentation does not +include: +</p><div class="itemizedlist"><ul type="disc"><li><p>A means of retrieving user account information from + an Windows 2000 Active Directory server.</p></li><li><p>A means of replacing /etc/passwd.</p></li></ul></div><p> +The second item can be accomplished by using LDAP NSS and PAM modules. LGPL +versions of these libraries can be obtained from PADL Software +(<a href="http://www.padl.com/" target="_top">http://www.padl.com/</a>). More +information about the configuration of these packages may be found at "LDAP, +System Administration; Gerald Carter, O'Reilly; Chapter 6: Replacing NIS". +</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2883756"></a>Supported LDAP Servers</h3></div></div><p> +The LDAP samdb code in 2.2.3 (and later) has been developed and tested +using the OpenLDAP 2.0 server and client libraries. +The same code should be able to work with Netscape's Directory Server +and client SDK. However, due to lack of testing so far, there are bound +to be compile errors and bugs. These should not be hard to fix. +If you are so inclined, please be sure to forward all patches to +<a href="mailto:samba-patches@samba.org" target="_top">samba-patches@samba.org</a> and +<a href="mailto:jerry@samba.org" target="_top">jerry@samba.org</a>. +</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2883794"></a>Schema and Relationship to the RFC 2307 posixAccount</h3></div></div><p> +Samba 3.0 includes the necessary schema file for OpenLDAP 2.0 in +<tt>examples/LDAP/samba.schema</tt>. The sambaAccount objectclass is given here: +</p><pre class="programlisting"> +objectclass ( 1.3.1.5.1.4.1.7165.2.2.2 NAME 'sambaAccount' SUP top AUXILIARY + DESC 'Samba Account' + MUST ( uid $ rid ) + MAY ( cn $ lmPassword $ ntPassword $ pwdLastSet $ logonTime $ + logoffTime $ kickoffTime $ pwdCanChange $ pwdMustChange $ acctFlags $ + displayName $ smbHome $ homeDrive $ scriptPath $ profilePath $ + description $ userWorkstations $ primaryGroupID $ domain )) +</pre><p> +The samba.schema file has been formatted for OpenLDAP 2.0. The OID's are +owned by the Samba Team and as such is legal to be openly published. +If you translate the schema to be used with Netscape DS, please +submit the modified schema file as a patch to <a href="mailto:jerry@samba.org" target="_top">jerry@samba.org</a> +</p><p> +Just as the smbpasswd file is meant to store information which supplements a +user's <tt>/etc/passwd</tt> entry, so is the sambaAccount object +meant to supplement the UNIX user account information. A sambaAccount is a +<tt>STRUCTURAL</tt> objectclass so it can be stored individually +in the directory. However, there are several fields (e.g. uid) which overlap +with the posixAccount objectclass outlined in RFC2307. This is by design. +</p><p> +In order to store all user account information (UNIX and Samba) in the directory, +it is necessary to use the sambaAccount and posixAccount objectclasses in +combination. However, smbd will still obtain the user's UNIX account +information via the standard C library calls (e.g. getpwnam(), et. al.). +This means that the Samba server must also have the LDAP NSS library installed +and functioning correctly. This division of information makes it possible to +store all Samba account information in LDAP, but still maintain UNIX account +information in NIS while the network is transitioning to a full LDAP infrastructure. +</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2883904"></a>Configuring Samba with LDAP</h3></div></div><div class="sect3" lang="en"><div class="titlepage"><div><h4 class="title"><a name="id2883912"></a>OpenLDAP configuration</h4></div></div><p> +To include support for the sambaAccount object in an OpenLDAP directory +server, first copy the samba.schema file to slapd's configuration directory. +</p><p> +<tt>root# </tt><b><tt>cp samba.schema /etc/openldap/schema/</tt></b> +</p><p> +Next, include the <tt>samba.schema</tt> file in <tt>slapd.conf</tt>. +The sambaAccount object contains two attributes which depend upon other schema +files. The 'uid' attribute is defined in <tt>cosine.schema</tt> and +the 'displayName' attribute is defined in the <tt>inetorgperson.schema</tt> +file. Both of these must be included before the <tt>samba.schema</tt> file. +</p><pre class="programlisting"> +## /etc/openldap/slapd.conf + +## schema files (core.schema is required by default) +include /etc/openldap/schema/core.schema + +## needed for sambaAccount +include /etc/openldap/schema/cosine.schema +include /etc/openldap/schema/inetorgperson.schema +include /etc/openldap/schema/samba.schema +include /etc/openldap/schema/nis.schema + +.... +</pre><p> +It is recommended that you maintain some indices on some of the most usefull attributes, +like in the following example, to speed up searches made on sambaAccount objectclasses +(and possibly posixAccount and posixGroup as well). +</p><pre class="programlisting"> +# Indices to maintain +## required by OpenLDAP 2.0 +index objectclass eq + +## support pb_getsampwnam() +index uid pres,eq +## support pdb_getsambapwrid() +index rid eq + +## uncomment these if you are storing posixAccount and +## posixGroup entries in the directory as well +##index uidNumber eq +##index gidNumber eq +##index cn eq +##index memberUid eq + +# (both fetched via ldapsearch): +index primaryGroupID eq +index displayName pres,eq + +</pre></div><div class="sect3" lang="en"><div class="titlepage"><div><h4 class="title"><a name="id2884030"></a>Configuring Samba</h4></div></div><p> +The following parameters are available in smb.conf only with <i><tt>--with-ldapsam</tt></i> +was included when compiling Samba. +</p><div class="itemizedlist"><ul type="disc"><li><p><a href="smb.conf.5.html#PASSDBBACKEND" target="_top">passdb backend [ldapsam|ldapsam_nua]:url</a></p></li><li><p><a href="smb.conf.5.html#LDAPSSL" target="_top">ldap ssl</a></p></li><li><p><a href="smb.conf.5.html#LDAPADMINDN" target="_top">ldap admin dn</a></p></li><li><p><a href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a></p></li><li><p><a href="smb.conf.5.html#LDAPFILTER" target="_top">ldap filter</a></p></li><li><p><a href="smb.conf.5.html#LDAPPORT" target="_top">ldap port</a></p></li><li><p><a href="smb.conf.5.html#LDAPMACHINSUFFIX" target="_top">ldap machine suffix</a></p></li><li><p><a href="smb.conf.5.html#LDAPUSERSUFFIX" target="_top">ldap user suffix</a></p></li><li><p><a href="smb.conf.5.html#LDAPDELETEDN" target="_top">ldap delete dn</a></p></li></ul></div><p> +These are described in the <a href="smb.conf.5.html" target="_top">smb.conf(5)</a> man +page and so will not be repeated here. However, a sample smb.conf file for +use with an LDAP directory could appear as +</p><pre class="programlisting"> +## /usr/local/samba/lib/smb.conf +[global] + security = user + encrypt passwords = yes + + netbios name = TASHTEGO + workgroup = NARNIA + + # ldap related parameters + + # define the DN to use when binding to the directory servers + # The password for this DN is not stored in smb.conf. Rather it + # must be set by using 'smbpasswd -w <i><tt>secretpw</tt></i>' to store the + # passphrase in the secrets.tdb file. If the "ldap admin dn" values + # change, this password will need to be reset. + ldap admin dn = "cn=Samba Manager,ou=people,dc=samba,dc=org" + + # Define the SSL option when connecting to the directory + # ('off', 'start tls', or 'on' (default)) + ldap ssl = start tls + + passdb backend ldapsam:ldap://ahab.samba.org + + # smbpasswd -x delete the entire dn-entry + ldap delete dn = no + + # the machine and user suffix added to the base suffix + # wrote WITHOUT quotes. NULL siffixes by default + ldap user suffix = ou=People + ldap machine suffix = ou=Systems + + # define the port to use in the LDAP session (defaults to 636 when + # "ldap ssl = on") + ldap port = 389 + + # specify the base DN to use when searching the directory + ldap suffix = "ou=people,dc=samba,dc=org" + + # generally the default ldap search filter is ok + # ldap filter = "(&(uid=%u)(objectclass=sambaAccount))" +</pre></div></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2884200"></a>Accounts and Groups management</h3></div></div><p> +As users accounts are managed thru the sambaAccount objectclass, you should +modify your existing administration tools to deal with sambaAccount attributes. +</p><p> +Machines accounts are managed with the sambaAccount objectclass, just +like users accounts. However, it's up to you to store thoses accounts +in a different tree of you LDAP namespace: you should use +"ou=Groups,dc=plainjoe,dc=org" to store groups and +"ou=People,dc=plainjoe,dc=org" to store users. Just configure your +NSS and PAM accordingly (usually, in the /etc/ldap.conf configuration +file). +</p><p> +In Samba release 3.0, the group management system is based on posix +groups. This means that Samba makes usage of the posixGroup objectclass. +For now, there is no NT-like group system management (global and local +groups). +</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2884237"></a>Security and sambaAccount</h3></div></div><p> +There are two important points to remember when discussing the security +of sambaAccount entries in the directory. +</p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>Never</em></span> retrieve the lmPassword or + ntPassword attribute values over an unencrypted LDAP session.</p></li><li><p><span class="emphasis"><em>Never</em></span> allow non-admin users to + view the lmPassword or ntPassword attribute values.</p></li></ul></div><p> +These password hashes are clear text equivalents and can be used to impersonate +the user without deriving the original clear text strings. For more information +on the details of LM/NT password hashes, refer to the <a href="passdb.html" title="Chapter 10. User information database">User Database</a> of the Samba-HOWTO-Collection. +</p><p> +To remedy the first security issue, the "ldap ssl" smb.conf parameter defaults +to require an encrypted session (<b>ldap ssl = on</b>) using +the default port of 636 +when contacting the directory server. When using an OpenLDAP 2.0 server, it +is possible to use the use the StartTLS LDAP extended operation in the place of +LDAPS. In either case, you are strongly discouraged to disable this security +(<b>ldap ssl = off</b>). +</p><p> +Note that the LDAPS protocol is deprecated in favor of the LDAPv3 StartTLS +extended operation. However, the OpenLDAP library still provides support for +the older method of securing communication between clients and servers. +</p><p> +The second security precaution is to prevent non-administrative users from +harvesting password hashes from the directory. This can be done using the +following ACL in <tt>slapd.conf</tt>: +</p><pre class="programlisting"> +## allow the "ldap admin dn" access, but deny everyone else +access to attrs=lmPassword,ntPassword + by dn="cn=Samba Admin,ou=people,dc=plainjoe,dc=org" write + by * none +</pre></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2884352"></a>LDAP specials attributes for sambaAccounts</h3></div></div><p> +The sambaAccount objectclass is composed of the following attributes: +</p><div class="itemizedlist"><ul type="disc"><li><p><tt>lmPassword</tt>: the LANMAN password 16-byte hash stored as a character + representation of a hexidecimal string.</p></li><li><p><tt>ntPassword</tt>: the NT password hash 16-byte stored as a character + representation of a hexidecimal string.</p></li><li><p><tt>pwdLastSet</tt>: The integer time in seconds since 1970 when the + <tt>lmPassword</tt> and <tt>ntPassword</tt> attributes were last set. + </p></li><li><p><tt>acctFlags</tt>: string of 11 characters surrounded by square brackets [] + representing account flags such as U (user), W(workstation), X(no password expiration), and + D(disabled).</p></li><li><p><tt>logonTime</tt>: Integer value currently unused</p></li><li><p><tt>logoffTime</tt>: Integer value currently unused</p></li><li><p><tt>kickoffTime</tt>: Integer value currently unused</p></li><li><p><tt>pwdCanChange</tt>: Integer value currently unused</p></li><li><p><tt>pwdMustChange</tt>: Integer value currently unused</p></li><li><p><tt>homeDrive</tt>: specifies the drive letter to which to map the + UNC path specified by homeDirectory. The drive letter must be specified in the form "X:" + where X is the letter of the drive to map. Refer to the "logon drive" parameter in the + smb.conf(5) man page for more information.</p></li><li><p><tt>scriptPath</tt>: The scriptPath property specifies the path of + the user's logon script, .CMD, .EXE, or .BAT file. The string can be null. The path + is relative to the netlogon share. Refer to the "logon script" parameter in the + smb.conf(5) man page for more information.</p></li><li><p><tt>profilePath</tt>: specifies a path to the user's profile. + This value can be a null string, a local absolute path, or a UNC path. Refer to the + "logon path" parameter in the smb.conf(5) man page for more information.</p></li><li><p><tt>smbHome</tt>: The homeDirectory property specifies the path of + the home directory for the user. The string can be null. If homeDrive is set and specifies + a drive letter, homeDirectory should be a UNC path. The path must be a network + UNC path of the form \\server\share\directory. This value can be a null string. + Refer to the "logon home" parameter in the smb.conf(5) man page for more information. + </p></li><li><p><tt>userWorkstation</tt>: character string value currently unused. + </p></li><li><p><tt>rid</tt>: the integer representation of the user's relative identifier + (RID).</p></li><li><p><tt>primaryGroupID</tt>: the relative identifier (RID) of the primary group + of the user.</p></li></ul></div><p> +The majority of these parameters are only used when Samba is acting as a PDC of +a domain (refer to the <a href="Samba-PDC-HOWTO.html" target="_top">Samba-PDC-HOWTO</a> for details on +how to configure Samba as a Primary Domain Controller). The following four attributes +are only stored with the sambaAccount entry if the values are non-default values: +</p><div class="itemizedlist"><ul type="disc"><li><p>smbHome</p></li><li><p>scriptPath</p></li><li><p>logonPath</p></li><li><p>homeDrive</p></li></ul></div><p> +These attributes are only stored with the sambaAccount entry if +the values are non-default values. For example, assume TASHTEGO has now been +configured as a PDC and that <b>logon home = \\%L\%u</b> was defined in +its <tt>smb.conf</tt> file. When a user named "becky" logons to the domain, +the <i><tt>logon home</tt></i> string is expanded to \\TASHTEGO\becky. +If the smbHome attribute exists in the entry "uid=becky,ou=people,dc=samba,dc=org", +this value is used. However, if this attribute does not exist, then the value +of the <i><tt>logon home</tt></i> parameter is used in its place. Samba +will only write the attribute value to the directory entry if the value is +something other than the default (e.g. \\MOBY\becky). +</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2884633"></a>Example LDIF Entries for a sambaAccount</h3></div></div><p> +The following is a working LDIF with the inclusion of the posixAccount objectclass: +</p><pre class="programlisting"> +dn: uid=guest2, ou=people,dc=plainjoe,dc=org +ntPassword: 878D8014606CDA29677A44EFA1353FC7 +pwdMustChange: 2147483647 +primaryGroupID: 1201 +lmPassword: 552902031BEDE9EFAAD3B435B51404EE +pwdLastSet: 1010179124 +logonTime: 0 +objectClass: sambaAccount +uid: guest2 +kickoffTime: 2147483647 +acctFlags: [UX ] +logoffTime: 2147483647 +rid: 19006 +pwdCanChange: 0 +</pre><p> +The following is an LDIF entry for using both the sambaAccount and +posixAccount objectclasses: +</p><pre class="programlisting"> +dn: uid=gcarter, ou=people,dc=plainjoe,dc=org +logonTime: 0 +displayName: Gerald Carter +lmPassword: 552902031BEDE9EFAAD3B435B51404EE +primaryGroupID: 1201 +objectClass: posixAccount +objectClass: sambaAccount +acctFlags: [UX ] +userPassword: {crypt}BpM2ej8Rkzogo +uid: gcarter +uidNumber: 9000 +cn: Gerald Carter +loginShell: /bin/bash +logoffTime: 2147483647 +gidNumber: 100 +kickoffTime: 2147483647 +pwdLastSet: 1010179230 +rid: 19000 +homeDirectory: /home/tashtego/gcarter +pwdCanChange: 0 +pwdMustChange: 2147483647 +ntPassword: 878D8014606CDA29677A44EFA1353FC7 +</pre></div></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2884689"></a>MySQL</h2></div></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2884696"></a>Creating the database</h3></div></div><p> +You either can set up your own table and specify the field names to pdb_mysql (see below +for the column names) or use the default table. The file <tt>examples/pdb/mysql/mysql.dump</tt> +contains the correct queries to create the required tables. Use the command : + +<b>mysql -u<i><tt>username</tt></i> -h<i><tt>hostname</tt></i> -p<i><tt>password</tt></i> <i><tt>databasename</tt></i> > <tt>/path/to/samba/examples/pdb/mysql/mysql.dump</tt></b> + +</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2884750"></a>Configuring</h3></div></div><p>This plugin lacks some good documentation, but here is some short info:</p><p>Add a the following to the <b>passdb backend</b> variable in your <tt>smb.conf</tt>: +</p><pre class="programlisting"> +passdb backend = [other-plugins] mysql:identifier [other-plugins] +</pre><p> +</p><p>The identifier can be any string you like, as long as it doesn't collide with +the identifiers of other plugins or other instances of pdb_mysql. If you +specify multiple pdb_mysql.so entries in 'passdb backend', you also need to +use different identifiers! +</p><p> +Additional options can be given thru the smb.conf file in the [global] section. +</p><pre class="programlisting"> +identifier:mysql host - host name, defaults to 'localhost' +identifier:mysql password +identifier:mysql user - defaults to 'samba' +identifier:mysql database - defaults to 'samba' +identifier:mysql port - defaults to 3306 +identifier:table - Name of the table containing users +</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p> +Since the password for the mysql user is stored in the +smb.conf file, you should make the the smb.conf file +readable only to the user that runs samba. This is considered a security +bug and will be fixed soon. +</p></div><p>Names of the columns in this table(I've added column types those columns should have first):</p><pre class="programlisting"> +identifier:logon time column - int(9) +identifier:logoff time column - int(9) +identifier:kickoff time column - int(9) +identifier:pass last set time column - int(9) +identifier:pass can change time column - int(9) +identifier:pass must change time column - int(9) +identifier:username column - varchar(255) - unix username +identifier:domain column - varchar(255) - NT domain user is part of +identifier:nt username column - varchar(255) - NT username +identifier:fullname column - varchar(255) - Full name of user +identifier:home dir column - varchar(255) - Unix homedir path +identifier:dir drive column - varchar(2) - Directory drive path (eg: 'H:') +identifier:logon script column - varchar(255) + - Batch file to run on client side when logging on +identifier:profile path column - varchar(255) - Path of profile +identifier:acct desc column - varchar(255) - Some ASCII NT user data +identifier:workstations column - varchar(255) + - Workstations user can logon to (or NULL for all) +identifier:unknown string column - varchar(255) - unknown string +identifier:munged dial column - varchar(255) - ? +identifier:user sid column - varchar(255) - NT user SID +identifier:group sid column - varchar(255) - NT group ID +identifier:lanman pass column - varchar(255) - encrypted lanman password +identifier:nt pass column - varchar(255) - encrypted nt passwd +identifier:plain pass column - varchar(255) - plaintext password +identifier:acct control column - int(9) - nt user data +identifier:unknown 3 column - int(9) - unknown +identifier:logon divs column - int(9) - ? +identifier:hours len column - int(9) - ? +identifier:unknown 5 column - int(9) - unknown +identifier:unknown 6 column - int(9) - unknown +</pre><p> +Eventually, you can put a colon (:) after the name of each column, which +should specify the column to update when updating the table. You can also +specify nothing behind the colon - then the data from the field will not be +updated. +</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2884895"></a>Using plaintext passwords or encrypted password</h3></div></div><p> +I strongly discourage the use of plaintext passwords, however, you can use them: +</p><p> +If you would like to use plaintext passwords, set +'identifier:lanman pass column' and 'identifier:nt pass column' to +'NULL' (without the quotes) and 'identifier:plain pass column' to the +name of the column containing the plaintext passwords. +</p><p> +If you use encrypted passwords, set the 'identifier:plain pass +column' to 'NULL' (without the quotes). This is the default. +</p></div><div class="sect2" lang="en"><div class="titlepage"><div><h3 class="title"><a name="id2884925"></a>Getting non-column data from the table</h3></div></div><p> +It is possible to have not all data in the database and making some 'constant'. +</p><p> +For example, you can set 'identifier:fullname column' to : +<b>CONCAT(First_name,' ',Sur_name)</b> +</p><p> +Or, set 'identifier:workstations column' to : +<b>NULL</b></p><p>See the MySQL documentation for more language constructs.</p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2884968"></a>XML</h2></div></div><p>This module requires libxml2 to be installed.</p><p>The usage of pdb_xml is pretty straightforward. To export data, use: +</p><p> + <b><tt>pdbedit -e xml:filename</tt></b> +</p><p> +(where filename is the name of the file to put the data in) +</p><p> +To import data, use: +<b><tt>pdbedit -i xml:filename -e current-pdb</tt></b> +</p><p> +Where filename is the name to read the data from and current-pdb to put it in. +</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="NetworkBrowsing.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="optional.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="unix-permissions.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 9. Samba / MS Windows Network Browsing Guide </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 11. UNIX Permission Bits and Windows NT Access Control Lists</td></tr></table></div></body></html> diff --git a/docs/htmldocs/problems.html b/docs/htmldocs/problems.html new file mode 100644 index 0000000000..f2bc0008eb --- /dev/null +++ b/docs/htmldocs/problems.html @@ -0,0 +1,134 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 28. Analysing and solving samba problems</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"><link rel="home" href="index.html" title="SAMBA Project Documentation"><link rel="up" href="troubleshooting.html" title="Part IV. Troubleshooting"><link rel="previous" href="diagnosis.html" title="Chapter 27. The samba checklist"><link rel="next" href="bugreport.html" title="Chapter 29. Reporting Bugs"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 28. Analysing and solving samba problems</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="diagnosis.html">Prev</a> </td><th width="60%" align="center">Part IV. Troubleshooting</th><td width="20%" align="right"> <a accesskey="n" href="bugreport.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><h2 class="title"><a name="problems"></a>Chapter 28. Analysing and solving samba problems</h2></div><div><div class="author"><h3 class="author">Gerald (Jerry) Carter</h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt><<a href="mailto:jerry@samba.org">jerry@samba.org</a>></tt></p></div></div></div></div><div><div class="author"><h3 class="author">Jelmer R. Vernooij</h3><div class="affiliation"><span class="orgname">The Samba Team<br></span><div class="address"><p><tt><<a href="mailto:jelmer@samba.org">jelmer@samba.org</a>></tt></p></div></div></div></div><div><div class="author"><h3 class="author">David Bannon</h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt><<a href="mailto:dbannon@samba.org">dbannon@samba.org</a>></tt></p></div></div></div></div><div><p class="pubdate">8 Apr 2003</p></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="problems.html#id2902374">Diagnostics tools</a></dt><dt><a href="problems.html#id2903991">Installing 'Network Monitor' on an NT Workstation or a Windows 9x box</a></dt><dt><a href="problems.html#id2904132">Useful URL's</a></dt><dt><a href="problems.html#id2904239">Getting help from the mailing lists</a></dt><dt><a href="problems.html#id2904392">How to get off the mailinglists</a></dt></dl></div><p> +There are many sources of information available in the form +of mailing lists, RFC's and documentation. The docs that come +with the samba distribution contain very good explanations of +general SMB topics such as browsing.</p><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2902374"></a>Diagnostics tools</h2></div></div><p> +One of the best diagnostic tools for debugging problems is Samba itself. +You can use the -d option for both smbd and nmbd to specify what +'debug level' at which to run. See the man pages on smbd, nmbd and +smb.conf for more information on debugging options. The debug +level can range from 1 (the default) to 10 (100 for debugging passwords). +</p><p> +Another helpful method of debugging is to compile samba using the +<b>gcc -g </b> flag. This will include debug +information in the binaries and allow you to attach gdb to the +running smbd / nmbd process. In order to attach gdb to an smbd +process for an NT workstation, first get the workstation to make the +connection. Pressing ctrl-alt-delete and going down to the domain box +is sufficient (at least, on the first time you join the domain) to +generate a 'LsaEnumTrustedDomains'. Thereafter, the workstation +maintains an open connection, and therefore there will be an smbd +process running (assuming that you haven't set a really short smbd +idle timeout) So, in between pressing ctrl alt delete, and actually +typing in your password, you can attach gdb and continue. +</p><p> +Some useful samba commands worth investigating: +</p><div class="itemizedlist"><ul type="disc"><li><p>testparam | more</p></li><li><p>smbclient -L //{netbios name of server}</p></li></ul></div><p> +An SMB enabled version of tcpdump is available from +<a href="http://www.tcpdump.org/" target="_top">http://www.tcpdup.org/</a>. +Ethereal, another good packet sniffer for Unix and Win32 +hosts, can be downloaded from <a href="http://www.ethereal.com/" target="_top">http://www.ethereal.com</a>. +</p><p> +For tracing things on the Microsoft Windows NT, Network Monitor +(aka. netmon) is available on the Microsoft Developer Network CD's, +the Windows NT Server install CD and the SMS CD's. The version of +netmon that ships with SMS allows for dumping packets between any two +computers (i.e. placing the network interface in promiscuous mode). +The version on the NT Server install CD will only allow monitoring +of network traffic directed to the local NT box and broadcasts on the +local subnet. Be aware that Ethereal can read and write netmon +formatted files. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2903991"></a>Installing 'Network Monitor' on an NT Workstation or a Windows 9x box</h2></div></div><p> +Installing netmon on an NT workstation requires a couple +of steps. The following are for installing Netmon V4.00.349, which comes +with Microsoft Windows NT Server 4.0, on Microsoft Windows NT +Workstation 4.0. The process should be similar for other versions of +Windows NT / Netmon. You will need both the Microsoft Windows +NT Server 4.0 Install CD and the Workstation 4.0 Install CD. +</p><p> +Initially you will need to install 'Network Monitor Tools and Agent' +on the NT Server. To do this +</p><div class="itemizedlist"><ul type="disc"><li><p>Goto Start - Settings - Control Panel - + Network - Services - Add </p></li><li><p>Select the 'Network Monitor Tools and Agent' and + click on 'OK'.</p></li><li><p>Click 'OK' on the Network Control Panel. + </p></li><li><p>Insert the Windows NT Server 4.0 install CD + when prompted.</p></li></ul></div><p> +At this point the Netmon files should exist in +<tt>%SYSTEMROOT%\System32\netmon\*.*</tt>. +Two subdirectories exist as well, <tt>parsers\</tt> +which contains the necessary DLL's for parsing the netmon packet +dump, and <tt>captures\</tt>. +</p><p> +In order to install the Netmon tools on an NT Workstation, you will +first need to install the 'Network Monitor Agent' from the Workstation +install CD. +</p><div class="itemizedlist"><ul type="disc"><li><p>Goto Start - Settings - Control Panel - + Network - Services - Add</p></li><li><p>Select the 'Network Monitor Agent' and click + on 'OK'.</p></li><li><p>Click 'OK' on the Network Control Panel. + </p></li><li><p>Insert the Windows NT Workstation 4.0 install + CD when prompted.</p></li></ul></div><p> +Now copy the files from the NT Server in %SYSTEMROOT%\System32\netmon\*.* +to %SYSTEMROOT%\System32\netmon\*.* on the Workstation and set +permissions as you deem appropriate for your site. You will need +administrative rights on the NT box to run netmon. +</p><p> +To install Netmon on a Windows 9x box install the network monitor agent +from the Windows 9x CD (\admin\nettools\netmon). There is a readme +file located with the netmon driver files on the CD if you need +information on how to do this. Copy the files from a working +Netmon installation. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2904132"></a>Useful URL's</h2></div></div><div class="itemizedlist"><ul type="disc"><li><p>Home of Samba site <a href="http://samba.org" target="_top"> + http://samba.org</a>. We have a mirror near you !</p></li><li><p> The <span class="emphasis"><em>Development</em></span> document +on the Samba mirrors might mention your problem. If so, +it might mean that the developers are working on it.</p></li><li><p>See how Scott Merrill simulates a BDC behavior at + <a href="http://www.skippy.net/linux/smb-howto.html" target="_top"> + http://www.skippy.net/linux/smb-howto.html</a>. </p></li><li><p>Although 2.0.7 has almost had its day as a PDC, David Bannon will + keep the 2.0.7 PDC pages at <a href="http://bioserve.latrobe.edu.au/samba" target="_top"> + http://bioserve.latrobe.edu.au/samba</a> going for a while yet.</p></li><li><p>Misc links to CIFS information + <a href="http://samba.org/cifs/" target="_top">http://samba.org/cifs/</a></p></li><li><p>NT Domains for Unix <a href="http://mailhost.cb1.com/~lkcl/ntdom/" target="_top"> + http://mailhost.cb1.com/~lkcl/ntdom/</a></p></li><li><p>FTP site for older SMB specs: + <a href="ftp://ftp.microsoft.com/developr/drg/CIFS/" target="_top"> + ftp://ftp.microsoft.com/developr/drg/CIFS/</a></p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2904239"></a>Getting help from the mailing lists</h2></div></div><p> +There are a number of Samba related mailing lists. Go to <a href="http://samba.org" target="_top">http://samba.org</a>, click on your nearest mirror +and then click on <b>Support</b> and then click on <b> +Samba related mailing lists</b>. +</p><p> +For questions relating to Samba TNG go to +<a href="http://www.samba-tng.org/" target="_top">http://www.samba-tng.org/</a> +It has been requested that you don't post questions about Samba-TNG to the +main stream Samba lists.</p><p> +If you post a message to one of the lists please observe the following guide lines : +</p><div class="itemizedlist"><ul type="disc"><li><p> Always remember that the developers are volunteers, they are +not paid and they never guarantee to produce a particular feature at +a particular time. Any time lines are 'best guess' and nothing more. +</p></li><li><p> Always mention what version of samba you are using and what +operating system its running under. You should probably list the +relevant sections of your <tt>smb.conf</tt> file, at least the options +in [global] that affect PDC support.</p></li><li><p>In addition to the version, if you obtained Samba via +CVS mention the date when you last checked it out.</p></li><li><p> Try and make your question clear and brief, lots of long, +convoluted questions get deleted before they are completely read ! +Don't post html encoded messages (if you can select colour or font +size its html).</p></li><li><p> If you run one of those nifty 'I'm on holidays' things when +you are away, make sure its configured to not answer mailing lists. +</p></li><li><p> Don't cross post. Work out which is the best list to post to +and see what happens, i.e. don't post to both samba-ntdom and samba-technical. +Many people active on the lists subscribe to more +than one list and get annoyed to see the same message two or more times. +Often someone will see a message and thinking it would be better dealt +with on another, will forward it on for you.</p></li><li><p>You might include <span class="emphasis"><em>partial</em></span> +log files written at a debug level set to as much as 20. +Please don't send the entire log but enough to give the context of the +error messages.</p></li><li><p>(Possibly) If you have a complete netmon trace ( from the opening of +the pipe to the error ) you can send the *.CAP file as well.</p></li><li><p>Please think carefully before attaching a document to an email. +Consider pasting the relevant parts into the body of the message. The samba +mailing lists go to a huge number of people, do they all need a copy of your +smb.conf in their attach directory?</p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2904392"></a>How to get off the mailinglists</h2></div></div><p>To have your name removed from a samba mailing list, go to the +same place you went to to get on it. Go to <a href="http://lists.samba.org/" target="_top">http://lists.samba.org</a>, +click on your nearest mirror and then click on <b>Support</b> and +then click on <b> Samba related mailing lists</b>. Or perhaps see +<a href="http://lists.samba.org/mailman/roster/samba-ntdom" target="_top">here</a> +</p><p> +Please don't post messages to the list asking to be removed, you will just +be referred to the above address (unless that process failed in some way...) +</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="diagnosis.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="troubleshooting.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="bugreport.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 27. The samba checklist </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 29. Reporting Bugs</td></tr></table></div></body></html> diff --git a/docs/htmldocs/profiles.1.html b/docs/htmldocs/profiles.1.html new file mode 100644 index 0000000000..ea9f779b57 --- /dev/null +++ b/docs/htmldocs/profiles.1.html @@ -0,0 +1,12 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>profiles</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="profiles.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>profiles — A utility to report and change SIDs in registry files + </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>profiles</tt> [-v] [-c SID] [-n SID] {file}</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html">Samba(7)</a> suite.</p><p><b>profiles</b> is a utility that + reports and changes SIDs in windows registry files. It currently only + supports NT. + </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">file</span></dt><dd><p>Registry file to view or edit. </p></dd><dt><span class="term">-v,--verbose</span></dt><dd><p>Increases verbosity of messages. + </p></dd><dt><span class="term">-c SID1 -n SID2</span></dt><dd><p>Change all occurences of SID1 in <tt>file</tt> by SID2. + </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba + suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The profiles man page was written by Jelmer Vernooij. </p></div></div></body></html> diff --git a/docs/htmldocs/securing-samba.html b/docs/htmldocs/securing-samba.html new file mode 100644 index 0000000000..ae6408ea7b --- /dev/null +++ b/docs/htmldocs/securing-samba.html @@ -0,0 +1,116 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 24. Securing Samba</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"><link rel="home" href="index.html" title="SAMBA Project Documentation"><link rel="up" href="optional.html" title="Part III. Advanced Configuration"><link rel="previous" href="integrate-ms-networks.html" title="Chapter 23. Integrating MS Windows networks with Samba"><link rel="next" href="unicode.html" title="Chapter 25. Unicode/Charsets"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 24. Securing Samba</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="integrate-ms-networks.html">Prev</a> </td><th width="60%" align="center">Part III. Advanced Configuration</th><td width="20%" align="right"> <a accesskey="n" href="unicode.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><h2 class="title"><a name="securing-samba"></a>Chapter 24. Securing Samba</h2></div><div><div class="author"><h3 class="author">Andrew Tridgell</h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt><<a href="mailto:tridge@samba.org">tridge@samba.org</a>></tt></p></div></div></div></div><div><div class="author"><h3 class="author">John H. Terpstra</h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt><<a href="mailto:jht@samba.org">jht@samba.org</a>></tt></p></div></div></div></div><div><p class="pubdate">17 March 2003</p></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="securing-samba.html#id2900501">Introduction</a></dt><dt><a href="securing-samba.html#id2900517">Using host based protection</a></dt><dt><a href="securing-samba.html#id2900967">Using interface protection</a></dt><dt><a href="securing-samba.html#id2901018">Using a firewall</a></dt><dt><a href="securing-samba.html#id2901061">Using a IPC$ share deny</a></dt><dt><a href="securing-samba.html#id2900617">NTLMv2 Security</a></dt><dt><a href="securing-samba.html#id2900653">Upgrading Samba</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2900501"></a>Introduction</h2></div></div><p> +This note was attached to the Samba 2.2.8 release notes as it contained an +important security fix. The information contained here applies to Samba +installations in general. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2900517"></a>Using host based protection</h2></div></div><p> +In many installations of Samba the greatest threat comes for outside +your immediate network. By default Samba will accept connections from +any host, which means that if you run an insecure version of Samba on +a host that is directly connected to the Internet you can be +especially vulnerable. +</p><p> +One of the simplest fixes in this case is to use the <b>hosts allow</b> and +<b>hosts deny</b> options in the Samba <tt>smb.conf</tt> configuration file to only +allow access to your server from a specific range of hosts. An example +might be: +</p><pre class="programlisting"> + hosts allow = 127.0.0.1 192.168.2.0/24 192.168.3.0/24 + hosts deny = 0.0.0.0/0 +</pre><p> +The above will only allow SMB connections from 'localhost' (your own +computer) and from the two private networks 192.168.2 and +192.168.3. All other connections will be refused as soon +as the client sends its first packet. The refusal will be marked as a +'not listening on called name' error. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2900967"></a>Using interface protection</h2></div></div><p> +By default Samba will accept connections on any network interface that +it finds on your system. That means if you have a ISDN line or a PPP +connection to the Internet then Samba will accept connections on those +links. This may not be what you want. +</p><p> +You can change this behaviour using options like the following: +</p><pre class="programlisting"> + interfaces = eth* lo + bind interfaces only = yes +</pre><p> +This tells Samba to only listen for connections on interfaces with a +name starting with 'eth' such as eth0, eth1, plus on the loopback +interface called 'lo'. The name you will need to use depends on what +OS you are using, in the above I used the common name for Ethernet +adapters on Linux. +</p><p> +If you use the above and someone tries to make a SMB connection to +your host over a PPP interface called 'ppp0' then they will get a TCP +connection refused reply. In that case no Samba code is run at all as +the operating system has been told not to pass connections from that +interface to any samba process. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2901018"></a>Using a firewall</h2></div></div><p> +Many people use a firewall to deny access to services that they don't +want exposed outside their network. This can be a very good idea, +although I would recommend using it in conjunction with the above +methods so that you are protected even if your firewall is not active +for some reason. +</p><p> +If you are setting up a firewall then you need to know what TCP and +UDP ports to allow and block. Samba uses the following: +</p><pre class="programlisting"> + UDP/137 - used by nmbd + UDP/138 - used by nmbd + TCP/139 - used by smbd + TCP/445 - used by smbd +</pre><p> +The last one is important as many older firewall setups may not be +aware of it, given that this port was only added to the protocol in +recent years. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2901061"></a>Using a IPC$ share deny</h2></div></div><p> +If the above methods are not suitable, then you could also place a +more specific deny on the IPC$ share that is used in the recently +discovered security hole. This allows you to offer access to other +shares while denying access to IPC$ from potentially untrustworthy +hosts. +</p><p> +To do that you could use: +</p><pre class="programlisting"> + [ipc$] + hosts allow = 192.168.115.0/24 127.0.0.1 + hosts deny = 0.0.0.0/0 +</pre><p> +this would tell Samba that IPC$ connections are not allowed from +anywhere but the two listed places (localhost and a local +subnet). Connections to other shares would still be allowed. As the +IPC$ share is the only share that is always accessible anonymously +this provides some level of protection against attackers that do not +know a username/password for your host. +</p><p> +If you use this method then clients will be given a 'access denied' +reply when they try to access the IPC$ share. That means that those +clients will not be able to browse shares, and may also be unable to +access some other resources. +</p><p> +This is not recommended unless you cannot use one of the other +methods listed above for some reason. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2900617"></a>NTLMv2 Security</h2></div></div><p> +To configure NTLMv2 authentication the following registry keys are worth knowing about: +</p><p> +</p><pre class="programlisting"> + [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa] + "lmcompatibilitylevel"=dword:00000003 + + 0x3 - Send NTLMv2 response only. Clients will use NTLMv2 authentication, + use NTLMv2 session security if the server supports it. Domain + controllers accept LM, NTLM and NTLMv2 authentication. + + [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\MSV1_0] + "NtlmMinClientSec"=dword:00080000 + + 0x80000 - NTLMv2 session security. If either NtlmMinClientSec or + NtlmMinServerSec is set to 0x80000, the connection will fail if NTLMv2 + session security is not negotiated. +</pre><p> +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2900653"></a>Upgrading Samba</h2></div></div><p> +Please check regularly on <a href="http://www.samba.org/" target="_top">http://www.samba.org/</a> for updates and +important announcements. Occasionally security releases are made and +it is highly recommended to upgrade Samba when a security vulnerability +is discovered. +</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="integrate-ms-networks.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="optional.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="unicode.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 23. Integrating MS Windows networks with Samba </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 25. Unicode/Charsets</td></tr></table></div></body></html> diff --git a/docs/htmldocs/smbcquotas.1.html b/docs/htmldocs/smbcquotas.1.html new file mode 100644 index 0000000000..478c03cdaa --- /dev/null +++ b/docs/htmldocs/smbcquotas.1.html @@ -0,0 +1,88 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbcquotas</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbcquotas.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbcquotas — Set or get QUOTAs of NTFS 5 shares</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>smbcquotas</tt> {//server/share} [-u user] [-L] [-F] [-S QUOTA_SET_COMMAND] [-n] [-t] [-v] [-d debuglevel] [-s configfile] [-l logfilebase] [-V] [-U username] [-N] [-k] [-A]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html">Samba(7)</a> suite.</p><p>The <b>smbcquotas</b> program manipulates NT Quotas on SMB file shares. </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><p>The following options are available to the <b>smbcquotas</b> program. </p><div class="variablelist"><dl><dt><span class="term">-u user</span></dt><dd><p> Specifies the user of whom the quotas are get or set. + By default the current user's username will be used.</p></dd><dt><span class="term">-L</span></dt><dd><p>Lists all quota records of the share.</p></dd><dt><span class="term">-F</span></dt><dd><p>Show the share quota status and default limits.</p></dd><dt><span class="term">-S QUOTA_SET_COMMAND</span></dt><dd><p>This command set/modify quotas for a user or on the share, + depending on the QUOTA_SET_COMMAND parameter witch is described later</p></dd><dt><span class="term">-n</span></dt><dd><p>This option displays all QUOTA information in numeric + format. The default is to convert SIDs to names and QUOTA limits + to a readable string format. </p></dd><dt><span class="term">-t</span></dt><dd><p> + Don't actually do anything, only validate the correctness of + the arguments. + </p></dd><dt><span class="term">-v</span></dt><dd><p> + Be verbose. + </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for +<b>smbd</b>.</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <a href="smb.conf.5.html" target="_top"><tt> +smb.conf(5)</tt></a> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i><tt>debuglevel</tt></i> is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a href="smb.conf.5.html#loglevel" target="_top">log +level</a> parameter in the <a href="smb.conf.5.html" target="_top"> +<tt>smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension +<tt>".client"</tt> will be appended. The log file is +never removed by the client. +</p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.</p></dd><dt><span class="term">-k</span></dt><dd><p> +Try to authenticate with kerberos. Only useful in +an Active Directory environment. +</p></dd><dt><span class="term">-A|--authfile=filename</span></dt><dd><p>This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +</p><pre class="programlisting"> +username = <value> +password = <value> +domain = <value> +</pre><p>Make certain that the permissions on the file restrict +access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The +client will first check the <tt>USER</tt> environment variable, then the +<tt>LOGNAME</tt> variable and if either exists, the +string is uppercased. If these environmental variables are not +found, the username <tt>GUEST</tt> is used. </p><p>A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the +<i><tt>-A</tt></i> for more details. </p><p>Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the <b>ps</b> command. To be safe always allow +<b>rpcclient</b> to prompt for a password and type +it in directly. </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>QUOTA_SET_COMAND</h2><p>The format of an ACL is one or more ACL entries separated by + either commas or newlines. An ACL entry is one of the following: </p><p> + for user setting quotas for the specified by -u or the current username: + </p><p><b><tt> + UQLIM:<username><softlimit><hardlimit> + </tt></b></p><p> + for setting the share quota defaults limits: + </p><p><b><tt> + FSQLIM:<softlimit><hardlimit> + </tt></b></p><p> + for changing the share quota settings: + </p><p><b><tt> + FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT + </tt></b></p></div><div class="refsect1" lang="en"><h2>EXIT STATUS</h2><p>The <b>smbcquotas</b> program sets the exit status + depending on the success or otherwise of the operations performed. + The exit status may be one of the following values. </p><p>If the operation succeeded, smbcquotas returns an exit + status of 0. If <b>smbcquotas</b> couldn't connect to the specified server, + or when there was an error getting or setting the quota(s), an exit status + of 1 is returned. If there was an error parsing any command line + arguments, an exit status of 2 is returned. </p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p><b>smbcacls</b> was written by Stefan Metzmacher.</p></div></div></body></html> diff --git a/docs/htmldocs/smbtree.1.html b/docs/htmldocs/smbtree.1.html new file mode 100644 index 0000000000..0d9a845d70 --- /dev/null +++ b/docs/htmldocs/smbtree.1.html @@ -0,0 +1,74 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbtree</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbtree.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbtree — A text based smb network browser + </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>smbtree</tt> [-b] [-D] [-S]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html">Samba(7)</a> suite.</p><p><b>smbtree</b> is a smb browser program + in text mode. It is similar to the "Network Neighborhood" found + on Windows computers. It prints a tree with all + the known domains, the servers in those domains and + the shares on the servers. + </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-b</span></dt><dd><p>Query network nodes by sending requests + as broadcasts instead of querying the (domain) master browser. + </p></dd><dt><span class="term">-D</span></dt><dd><p>Only print a list of all + the domains known on broadcast or by the + master browser</p></dd><dt><span class="term">-S</span></dt><dd><p>Only print a list of + all the domains and servers responding on broadcast or + known by the master browser. + </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for +<b>smbd</b>.</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See <a href="smb.conf.5.html" target="_top"><tt> +smb.conf(5)</tt></a> for more information. +The default configuration file name is determined at +compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i><tt>debuglevel</tt></i> is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.</p><p>The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.</p><p>Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will +override the <a href="smb.conf.5.html#loglevel" target="_top">log +level</a> parameter in the <a href="smb.conf.5.html" target="_top"> +<tt>smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension +<tt>".client"</tt> will be appended. The log file is +never removed by the client. +</p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.</p></dd><dt><span class="term">-k</span></dt><dd><p> +Try to authenticate with kerberos. Only useful in +an Active Directory environment. +</p></dd><dt><span class="term">-A|--authfile=filename</span></dt><dd><p>This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +</p><pre class="programlisting"> +username = <value> +password = <value> +domain = <value> +</pre><p>Make certain that the permissions on the file restrict +access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The +client will first check the <tt>USER</tt> environment variable, then the +<tt>LOGNAME</tt> variable and if either exists, the +string is uppercased. If these environmental variables are not +found, the username <tt>GUEST</tt> is used. </p><p>A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the +<i><tt>-A</tt></i> for more details. </p><p>Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the <b>ps</b> command. To be safe always allow +<b>rpcclient</b> to prompt for a password and type +it in directly. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. +</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba + suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</p><p>The smbtree man page was written by Jelmer Vernooij. </p></div></div></body></html> diff --git a/docs/htmldocs/unicode.html b/docs/htmldocs/unicode.html new file mode 100644 index 0000000000..0c5bb01d13 --- /dev/null +++ b/docs/htmldocs/unicode.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 25. Unicode/Charsets</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"><link rel="home" href="index.html" title="SAMBA Project Documentation"><link rel="up" href="optional.html" title="Part III. Advanced Configuration"><link rel="previous" href="securing-samba.html" title="Chapter 24. Securing Samba"><link rel="next" href="locking.html" title="Chapter 26. File and Record Locking"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 25. Unicode/Charsets</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="securing-samba.html">Prev</a> </td><th width="60%" align="center">Part III. Advanced Configuration</th><td width="20%" align="right"> <a accesskey="n" href="locking.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><h2 class="title"><a name="unicode"></a>Chapter 25. Unicode/Charsets</h2></div><div><div class="author"><h3 class="author">Jelmer R. Vernooij</h3><div class="affiliation"><span class="orgname">The Samba Team<br></span><div class="address"><p><tt><<a href="mailto:jelmer@samba.org">jelmer@samba.org</a>></tt></p></div></div></div></div><div><div class="author"><h3 class="author">TAKAHASHI Motonobu</h3><div class="affiliation"><div class="address"><p><tt><<a href="mailto:monyo@home.monyo.com">monyo@home.monyo.com</a>></tt></p></div></div></div></div><div><p class="pubdate">25 March 2003</p></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="unicode.html#id2901255">What are charsets and unicode?</a></dt><dt><a href="unicode.html#id2901324">Samba and charsets</a></dt><dt><a href="unicode.html#id2901414">Conversion from old names</a></dt><dt><a href="unicode.html#id2901459">Japanese charsets</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2901255"></a>What are charsets and unicode?</h2></div></div><p> +Computers communicate in numbers. In texts, each number will be +translated to a corresponding letter. The meaning that will be assigned +to a certain number depends on the <span class="emphasis"><em>character set(charset) +</em></span> that is used. +A charset can be seen as a table that is used to translate numbers to +letters. Not all computers use the same charset (there are charsets +with German umlauts, Japanese characters, etc). Usually a charset contains +256 characters, which means that storing a character with it takes +exactly one byte. </p><p> +There are also charsets that support even more characters, +but those need twice(or even more) as much storage space. These +charsets can contain <b>256 * 256 = 65536</b> characters, which +is more then all possible characters one could think of. They are called +multibyte charsets (because they use more then one byte to +store one character). +</p><p> +A standardised multibyte charset is unicode, info is available at +<a href="http://www.unicode.org/" target="_top">www.unicode.org</a>. +A big advantage of using a multibyte charset is that you only need one; no +need to make sure two computers use the same charset when they are +communicating. +</p><p>Old windows clients used to use single-byte charsets, named +'codepages' by microsoft. However, there is no support for +negotiating the charset to be used in the smb protocol. Thus, you +have to make sure you are using the same charset when talking to an old client. +Newer clients (Windows NT, 2K, XP) talk unicode over the wire. +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2901324"></a>Samba and charsets</h2></div></div><p> +As of samba 3.0, samba can (and will) talk unicode over the wire. Internally, +samba knows of three kinds of character sets: +</p><div class="variablelist"><dl><dt><span class="term">unix charset</span></dt><dd><p> + This is the charset used internally by your operating system. + The default is <tt>ASCII</tt>, which is fine for most + systems. + </p></dd><dt><span class="term">display charset</span></dt><dd><p>This is the charset samba will use to print messages + on your screen. It should generally be the same as the <b>unix charset</b>. + </p></dd><dt><span class="term">dos charset</span></dt><dd><p>This is the charset samba uses when communicating with + DOS and Windows 9x clients. It will talk unicode to all newer clients. + The default depends on the charsets you have installed on your system. + Run <b>testparm -v | grep "dos charset"</b> to see + what the default is on your system. + </p></dd></dl></div></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2901414"></a>Conversion from old names</h2></div></div><p>Because previous samba versions did not do any charset conversion, +characters in filenames are usually not correct in the unix charset but only +for the local charset used by the DOS/Windows clients.</p><p>The following script from Steve Langasek converts all +filenames from CP850 to the iso8859-15 charset.</p><p> +<tt>#</tt><b><tt>find <i><tt>/path/to/share</tt></i> -type f -exec bash -c 'CP="{}"; ISO=`echo -n "$CP" | iconv -f cp850 \ + -t iso8859-15`; if [ "$CP" != "$ISO" ]; then mv "$CP" "$ISO"; fi' \; +</tt></b> +</p></div><div class="sect1" lang="en"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="id2901459"></a>Japanese charsets</h2></div></div><p>Samba doesn't work correctly with Japanese charsets yet. Here are +points of attention when setting it up:</p><div class="itemizedlist"><ul type="disc"><li><p>You should set <b>mangling method = +hash</b></p></li><li><p>There are various iconv() implementations around and not +all of them work equally well. glibc2's iconv() has a critical problem +in CP932. libiconv-1.8 works with CP932 but still has some problems and +does not work with EUC-JP.</p></li><li><p>You should set <b>dos charset = CP932</b>, not +Shift_JIS, SJIS...</p></li><li><p>Currently only <b>unix charset = CP932</b> +will work (but still has some problems...) because of iconv() issues. +<b>unix charset = EUC-JP</b> doesn't work well because of +iconv() issues.</p></li><li><p>Currently Samba 3.0 does not support <b>unix charset += UTF8-MAC/CAP/HEX/JIS*</b></p></li></ul></div><p>More information (in Japanese) is available at: <a href="http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html" target="_top">http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html</a>.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="securing-samba.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="optional.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="locking.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 24. Securing Samba </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 26. File and Record Locking</td></tr></table></div></body></html> diff --git a/docs/manpages/editreg.1 b/docs/manpages/editreg.1 new file mode 100644 index 0000000000..6f418a28dc --- /dev/null +++ b/docs/manpages/editreg.1 @@ -0,0 +1,71 @@ +.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "EDITREG" 1 "" "" "" +.SH NAME +editreg \- A utility to report and change SIDs in registry files +.SH "SYNOPSIS" + +.nf +\fBeditreg\fR [-v] [-c file] {file} +.fi + +.SH "DESCRIPTION" + +.PP +This tool is part of the \fBSamba\fR(7) suite\&. + +.PP +\fBeditreg\fR is a utility that can visualize windows registry files (currently only NT4) and apply so-called commandfiles to them\&. + +.SH "OPTIONS" + +.TP +registry_file +Registry file to view or edit\&. + + +.TP +-v,--verbose +Increases verbosity of messages\&. + + +.TP +-c commandfile +Read commands to execute on \fIregistry_file\fR from \fIcommandfile\fR\&. Currently not yet supported! + + +.TP +-h|--help +Print a summary of command line options\&. + + +.SH "VERSION" + +.PP +This man page is correct for version 3\&.0 of the Samba suite\&. + +.SH "AUTHOR" + +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. + +.PP +The editreg man page was written by Jelmer Vernooij\&. + diff --git a/docs/manpages/ntlm_auth.1 b/docs/manpages/ntlm_auth.1 new file mode 100644 index 0000000000..082d9422c8 --- /dev/null +++ b/docs/manpages/ntlm_auth.1 @@ -0,0 +1,135 @@ +.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "NTLM_AUTH" 1 "" "" "" +.SH NAME +ntlm_auth \- tool to allow external access to Winbind's NTLM authentication function +.SH "SYNOPSIS" + +.nf +\fBntlm_auth\fR [-d debuglevel] [-l logfile] [-s <smb config file>] +.fi + +.SH "DESCRIPTION" + +.PP +This tool is part of the \fBSamba\fR(7) suite\&. + +.PP +\fBntlm_auth\fR is a helper utility that authenticates users using NT/LM authentication\&. It returns 0 if the users is authenticated successfully and 1 if access was denied\&. ntlm_auth uses winbind to access the user and authentication data for a domain\&. This utility is only to be used by other programs (currently squid)\&. + +.SH "OPTIONS" + +.TP +--helper-protocol=PROTO +Operate as a stdio-based helper + + +.TP +--username=USERNAME +Specify username of user to authenticate + + +.TP +--domain=DOMAIN +Specify domain of user to authenticate + + +.TP +--workstation=WORKSTATION +Specify the workstation the user authenticated from + + +.TP +--challenge=STRING +challenge (HEX encoded) + + +.TP +--lm-response=RESPONSE +LM Response to the challenge (HEX encoded) + + +.TP +--nt-response=RESPONSE +NT or NTLMv2 Response to the challenge (HEX encoded) + + +.TP +--password=PASSWORD +User's plaintext password + + +.TP +--request-lm-key +Retreive LM session key + + +.TP +--request-nt-key +Request NT key + + +.TP +-V +Prints the version number for \fBsmbd\fR\&. + + +.TP +-s <configuration file> +The file specified contains the configuration details required by the server\&. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&. + + +.TP +-d|--debug=debuglevel +\fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&. + + +The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day to day running - it generates a small amount of information about operations carried out\&. + + +Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&. + + +Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&. + + +.TP +-l|--logfile=logbasename +File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&. + + +.TP +-h|--help +Print a summary of command line options\&. + + +.SH "VERSION" + +.PP +This man page is correct for version 3\&.0 of the Samba suite\&. + +.SH "AUTHOR" + +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. + +.PP +The ntlm_auth manpage was written by Jelmer Vernooij\&. + diff --git a/docs/manpages/profiles.1 b/docs/manpages/profiles.1 new file mode 100644 index 0000000000..1c53c74a03 --- /dev/null +++ b/docs/manpages/profiles.1 @@ -0,0 +1,71 @@ +.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "PROFILES" 1 "" "" "" +.SH NAME +profiles \- A utility to report and change SIDs in registry files +.SH "SYNOPSIS" + +.nf +\fBprofiles\fR [-v] [-c SID] [-n SID] {file} +.fi + +.SH "DESCRIPTION" + +.PP +This tool is part of the \fBSamba\fR(7) suite\&. + +.PP +\fBprofiles\fR is a utility that reports and changes SIDs in windows registry files\&. It currently only supports NT\&. + +.SH "OPTIONS" + +.TP +file +Registry file to view or edit\&. + + +.TP +-v,--verbose +Increases verbosity of messages\&. + + +.TP +-c SID1 -n SID2 +Change all occurences of SID1 in \fIfile\fR by SID2\&. + + +.TP +-h|--help +Print a summary of command line options\&. + + +.SH "VERSION" + +.PP +This man page is correct for version 3\&.0 of the Samba suite\&. + +.SH "AUTHOR" + +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. + +.PP +The profiles man page was written by Jelmer Vernooij\&. + diff --git a/docs/manpages/smbcquotas.1 b/docs/manpages/smbcquotas.1 new file mode 100644 index 0000000000..e8288977f8 --- /dev/null +++ b/docs/manpages/smbcquotas.1 @@ -0,0 +1,199 @@ +.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "SMBCQUOTAS" 1 "" "" "" +.SH NAME +smbcquotas \- Set or get QUOTAs of NTFS 5 shares +.SH "SYNOPSIS" + +.nf +\fBsmbcquotas\fR {//server/share} [-u user] [-L] [-F] [-S QUOTA_SET_COMMAND] [-n] [-t] + [-v] [-d debuglevel] [-s configfile] [-l logfilebase] [-V] [-U username] + [-N] [-k] [-A] +.fi + +.SH "DESCRIPTION" + +.PP +This tool is part of the \fBSamba\fR(7) suite\&. + +.PP +The \fBsmbcquotas\fR program manipulates NT Quotas on SMB file shares\&. + +.SH "OPTIONS" + +.PP +The following options are available to the \fBsmbcquotas\fR program\&. + +.TP +-u user +Specifies the user of whom the quotas are get or set\&. By default the current user's username will be used\&. + + +.TP +-L +Lists all quota records of the share\&. + + +.TP +-F +Show the share quota status and default limits\&. + + +.TP +-S QUOTA_SET_COMMAND +This command set/modify quotas for a user or on the share, depending on the QUOTA_SET_COMMAND parameter witch is described later + + +.TP +-n +This option displays all QUOTA information in numeric format\&. The default is to convert SIDs to names and QUOTA limits to a readable string format\&. + + +.TP +-t +Don't actually do anything, only validate the correctness of the arguments\&. + + +.TP +-v +Be verbose\&. + + +.TP +-h|--help +Print a summary of command line options\&. + + +.TP +-V +Prints the version number for \fBsmbd\fR\&. + + +.TP +-s <configuration file> +The file specified contains the configuration details required by the server\&. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&. + + +.TP +-d|--debug=debuglevel +\fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&. + + +The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day to day running - it generates a small amount of information about operations carried out\&. + + +Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&. + + +Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&. + + +.TP +-l|--logfile=logbasename +File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&. + + +.TP +-N +If specified, this parameter suppresses the normal password prompt from the client to the user\&. This is useful when accessing a service that does not require a password\&. + + +Unless a password is specified on the command line or this parameter is specified, the client will request a password\&. + + +.TP +-k +Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&. + + +.TP +-A|--authfile=filename +This option allows you to specify a file from which to read the username and password used in the connection\&. The format of the file is + + +.nf + +username = <value> +password = <value> +domain = <value> +.fi + + +Make certain that the permissions on the file restrict access from unwanted users\&. + + +.TP +-U|--user=username[%password] +Sets the SMB username or username and password\&. + + +If %password is not specified, the user will be prompted\&. The client will first check the \fBUSER\fR environment variable, then the \fBLOGNAME\fR variable and if either exists, the string is uppercased\&. If these environmental variables are not found, the username \fBGUEST\fR is used\&. + + +A third option is to use a credentials file which contains the plaintext of the username and password\&. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables\&. If this method is used, make certain that the permissions on the file restrict access from unwanted users\&. See the \fI-A\fR for more details\&. + + +Be cautious about including passwords in scripts\&. Also, on many systems the command line of a running process may be seen via the \fBps\fR command\&. To be safe always allow \fBrpcclient\fR to prompt for a password and type it in directly\&. + + +.SH "QUOTA_SET_COMAND" + +.PP +The format of an ACL is one or more ACL entries separated by either commas or newlines\&. An ACL entry is one of the following: + +.PP +for user setting quotas for the specified by -u or the current username: + +.PP +\fB UQLIM:<username><softlimit><hardlimit> \fR + +.PP +for setting the share quota defaults limits: + +.PP +\fB FSQLIM:<softlimit><hardlimit> \fR + +.PP +for changing the share quota settings: + +.PP +\fB FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT \fR + +.SH "EXIT STATUS" + +.PP +The \fBsmbcquotas\fR program sets the exit status depending on the success or otherwise of the operations performed\&. The exit status may be one of the following values\&. + +.PP +If the operation succeeded, smbcquotas returns an exit status of 0\&. If \fBsmbcquotas\fR couldn't connect to the specified server, or when there was an error getting or setting the quota(s), an exit status of 1 is returned\&. If there was an error parsing any command line arguments, an exit status of 2 is returned\&. + +.SH "VERSION" + +.PP +This man page is correct for version 3\&.0 of the Samba suite\&. + +.SH "AUTHOR" + +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. + +.PP +\fBsmbcacls\fR was written by Stefan Metzmacher\&. + diff --git a/docs/manpages/smbtree.1 b/docs/manpages/smbtree.1 new file mode 100644 index 0000000000..0cc984c24a --- /dev/null +++ b/docs/manpages/smbtree.1 @@ -0,0 +1,143 @@ +.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "SMBTREE" 1 "" "" "" +.SH NAME +smbtree \- A text based smb network browser +.SH "SYNOPSIS" + +.nf +\fBsmbtree\fR [-b] [-D] [-S] +.fi + +.SH "DESCRIPTION" + +.PP +This tool is part of the \fBSamba\fR(7) suite\&. + +.PP +\fBsmbtree\fR is a smb browser program in text mode\&. It is similar to the "Network Neighborhood" found on Windows computers\&. It prints a tree with all the known domains, the servers in those domains and the shares on the servers\&. + +.SH "OPTIONS" + +.TP +-b +Query network nodes by sending requests as broadcasts instead of querying the (domain) master browser\&. + + +.TP +-D +Only print a list of all the domains known on broadcast or by the master browser + + +.TP +-S +Only print a list of all the domains and servers responding on broadcast or known by the master browser\&. + + +.TP +-V +Prints the version number for \fBsmbd\fR\&. + + +.TP +-s <configuration file> +The file specified contains the configuration details required by the server\&. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&. + + +.TP +-d|--debug=debuglevel +\fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&. + + +The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day to day running - it generates a small amount of information about operations carried out\&. + + +Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&. + + +Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&. + + +.TP +-l|--logfile=logbasename +File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&. + + +.TP +-N +If specified, this parameter suppresses the normal password prompt from the client to the user\&. This is useful when accessing a service that does not require a password\&. + + +Unless a password is specified on the command line or this parameter is specified, the client will request a password\&. + + +.TP +-k +Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&. + + +.TP +-A|--authfile=filename +This option allows you to specify a file from which to read the username and password used in the connection\&. The format of the file is + + +.nf + +username = <value> +password = <value> +domain = <value> +.fi + + +Make certain that the permissions on the file restrict access from unwanted users\&. + + +.TP +-U|--user=username[%password] +Sets the SMB username or username and password\&. + + +If %password is not specified, the user will be prompted\&. The client will first check the \fBUSER\fR environment variable, then the \fBLOGNAME\fR variable and if either exists, the string is uppercased\&. If these environmental variables are not found, the username \fBGUEST\fR is used\&. + + +A third option is to use a credentials file which contains the plaintext of the username and password\&. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables\&. If this method is used, make certain that the permissions on the file restrict access from unwanted users\&. See the \fI-A\fR for more details\&. + + +Be cautious about including passwords in scripts\&. Also, on many systems the command line of a running process may be seen via the \fBps\fR command\&. To be safe always allow \fBrpcclient\fR to prompt for a password and type it in directly\&. + + +.TP +-h|--help +Print a summary of command line options\&. + + +.SH "VERSION" + +.PP +This man page is correct for version 3\&.0 of the Samba suite\&. + +.SH "AUTHOR" + +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. + +.PP +The smbtree man page was written by Jelmer Vernooij\&. + diff --git a/source3/sam/idmap.c b/source3/sam/idmap.c new file mode 100644 index 0000000000..9695e7b764 --- /dev/null +++ b/source3/sam/idmap.c @@ -0,0 +1,212 @@ +/* + Unix SMB/CIFS implementation. + ID Mapping + Copyright (C) Tim Potter 2000 + Copyright (C) Anthony Liguori <aliguor@us.ibm.com> 2003 + Copyright (C) Simo Sorce 2003 + + 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.*/ + +#include "includes.h" + +#undef DBGC_CLASS +#define DBGC_CLASS DBGC_IDMAP + +static struct { + + const char *name; + /* Function to create a member of the idmap_methods list */ + NTSTATUS (*reg_meth)(struct idmap_methods **methods); + struct idmap_methods *methods; + +} remote_idmap_functions[] = { + { NULL, NULL, NULL } +}; + +static struct idmap_methods *local_map; +static struct idmap_methods *remote_map; + +static void lazy_initialize_idmap(void) +{ + static BOOL initialized = False; + if (initialized) return; + idmap_init(); + initialized = True; +} + + + +static struct idmap_methods *get_methods(const char *name) +{ + int i = 0; + struct idmap_methods *ret = NULL; + + while (remote_idmap_functions[i].name && strcmp(remote_idmap_functions[i].name, name)) { + i++; + } + + if (remote_idmap_functions[i].name) { + + if (!remote_idmap_functions[i].methods) { + remote_idmap_functions[i].reg_meth(&remote_idmap_functions[i].methods); + } + + ret = remote_idmap_functions[i].methods; + } + + return ret; +} + +/* Initialize backend */ +BOOL idmap_init(void) +{ + const char *remote_backend = lp_idmap_backend(); + + if (!local_map) { + idmap_reg_tdb(&local_map); + if (NT_STATUS_IS_ERR(local_map->init())) { + DEBUG(0, ("idmap_init: could not load or create local backend!\n")); + return False; + } + } + + if (!remote_map && remote_backend && *remote_backend != 0) { + DEBUG(3, ("idmap_init: using '%s' as remote backend\n", remote_backend)); + + remote_map = get_methods(remote_backend); + if (!remote_map) { + DEBUG(0, ("idmap_init: could not load remote backend '%s'\n", remote_backend)); + return False; + } + remote_map->init(); + } + + return True; +} + +NTSTATUS idmap_set_mapping(const DOM_SID *sid, unid_t id, int id_type) +{ + NTSTATUS ret; + + lazy_initialize_idmap(); + + ret = local_map->set_mapping(sid, id, id_type); + if (NT_STATUS_IS_ERR(ret)) { + DEBUG (0, ("idmap_set_mapping: Error, unable to modify local cache!\n")); + DEBUGADD(0, ("Error: %s", nt_errstr(ret))); + return ret; + } + + /* Being able to update the remote cache is seldomly right. + Generally this is a forbidden operation. */ + if (!(id_type & ID_CACHE) && (remote_map != NULL)) { + remote_map->set_mapping(sid, id, id_type); + if (NT_STATUS_IS_ERR(ret)) { + DEBUG (0, ("idmap_set_mapping: Error, unable to modify remote cache!\n")); + DEBUGADD(0, ("Error: %s", nt_errstr(ret))); + } + } + + return ret; +} + +/* Get ID from SID */ +NTSTATUS idmap_get_id_from_sid(unid_t *id, int *id_type, const DOM_SID *sid) +{ + NTSTATUS ret; + int loc_type; + + lazy_initialize_idmap(); + + loc_type = *id_type; + if (remote_map) { /* We have a central remote idmap */ + loc_type |= ID_NOMAP; + } + ret = local_map->get_id_from_sid(id, &loc_type, sid); + if (NT_STATUS_IS_ERR(ret)) { + if (remote_map) { + ret = remote_map->get_id_from_sid(id, id_type, sid); + if (NT_STATUS_IS_ERR(ret)) { + DEBUG(3, ("idmap_get_id_from_sid: error fetching id!\n")); + return ret; + } else { + loc_type |= ID_CACHE; + idmap_set_mapping(sid, *id, loc_type); + } + } + } else { + *id_type = loc_type & ID_TYPEMASK; + } + + return ret; +} + +/* Get SID from ID */ +NTSTATUS idmap_get_sid_from_id(DOM_SID *sid, unid_t id, int id_type) +{ + NTSTATUS ret; + int loc_type; + + lazy_initialize_idmap(); + + loc_type = id_type; + if (remote_map) { + loc_type = id_type | ID_NOMAP; + } + ret = local_map->get_sid_from_id(sid, id, loc_type); + if (NT_STATUS_IS_ERR(ret)) { + if (remote_map) { + ret = remote_map->get_sid_from_id(sid, id, id_type); + if (NT_STATUS_IS_ERR(ret)) { + DEBUG(3, ("idmap_get_sid_from_id: unable to fetch sid!\n")); + return ret; + } else { + loc_type |= ID_CACHE; + idmap_set_mapping(sid, id, loc_type); + } + } + } + + return ret; +} + +/* Close backend */ +NTSTATUS idmap_close(void) +{ + NTSTATUS ret; + + ret = local_map->close(); + if (NT_STATUS_IS_ERR(ret)) { + DEBUG(3, ("idmap_close: failed to close local cache!\n")); + } + + if (remote_map) { + ret = remote_map->close(); + if (NT_STATUS_IS_ERR(ret)) { + DEBUG(3, ("idmap_close: failed to close remote idmap repository!\n")); + } + } + + return ret; +} + +/* Dump backend status */ +void idmap_status(void) +{ + lazy_initialize_idmap(); + + local_map->status(); + if (remote_map) remote_map->status(); +} diff --git a/source3/sam/idmap_tdb.c b/source3/sam/idmap_tdb.c new file mode 100644 index 0000000000..ab86eaf4eb --- /dev/null +++ b/source3/sam/idmap_tdb.c @@ -0,0 +1,443 @@ +/* + Unix SMB/CIFS implementation. + + idmap TDB backend + + Copyright (C) Tim Potter 2000 + Copyright (C) Anthony Liguori 2003 + Copyright (C) Simo Sorce 2003 + + 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. +*/ + +#include "includes.h" + +#undef DBGC_CLASS +#define DBGC_CLASS DBGC_IDMAP + +/* High water mark keys */ +#define HWM_GROUP "GROUP HWM" +#define HWM_USER "USER HWM" + +/* idmap version determines auto-conversion */ +#define IDMAP_VERSION 2 + +/* Globals */ +static TDB_CONTEXT *idmap_tdb; + +static struct idmap_state { + + /* User and group id pool */ + + uid_t uid_low, uid_high; /* Range of uids to allocate */ + gid_t gid_low, gid_high; /* Range of gids to allocate */ +} idmap_state; + +/* Allocate either a user or group id from the pool */ +static NTSTATUS db_allocate_id(unid_t *id, int id_type) +{ + int hwm; + + if (!id) return NT_STATUS_INVALID_PARAMETER; + + /* Get current high water mark */ + switch (id_type & ID_TYPEMASK) { + case ID_USERID: + if ((hwm = tdb_fetch_int32(idmap_tdb, HWM_USER)) == -1) { + return NT_STATUS_INTERNAL_DB_ERROR; + } + + if (hwm > idmap_state.uid_high) { + DEBUG(0, ("idmap Fatal Error: UID range full!! (max: %u)\n", idmap_state.uid_high)); + return NT_STATUS_UNSUCCESSFUL; + } + + (*id).uid = hwm++; + + /* Store new high water mark */ + tdb_store_int32(idmap_tdb, HWM_USER, hwm); + break; + case ID_GROUPID: + if ((hwm = tdb_fetch_int32(idmap_tdb, HWM_GROUP)) == -1) { + return NT_STATUS_INTERNAL_DB_ERROR; + } + + if (hwm > idmap_state.gid_high) { + DEBUG(0, ("idmap Fatal Error: GID range full!! (max: %u)\n", idmap_state.gid_high)); + return NT_STATUS_UNSUCCESSFUL; + } + + (*id).gid = hwm++; + + /* Store new high water mark */ + tdb_store_int32(idmap_tdb, HWM_GROUP, hwm); + break; + default: + return NT_STATUS_INVALID_PARAMETER; + } + + return NT_STATUS_OK; +} + +/* Get a sid from an id */ +static NTSTATUS db_get_sid_from_id(DOM_SID *sid, unid_t id, int id_type) +{ + TDB_DATA key, data; + fstring keystr; + NTSTATUS ret = NT_STATUS_UNSUCCESSFUL; + + if (!sid) return NT_STATUS_INVALID_PARAMETER; + + switch (id_type & ID_TYPEMASK) { + case ID_USERID: + slprintf(keystr, sizeof(keystr), "UID %d", id.uid); + break; + case ID_GROUPID: + slprintf(keystr, sizeof(keystr), "GID %d", id.gid); + break; + default: + return NT_STATUS_UNSUCCESSFUL; + } + + key.dptr = keystr; + key.dsize = strlen(keystr) + 1; + + data = tdb_fetch(idmap_tdb, key); + + if (data.dptr) { + if (string_to_sid(sid, data.dptr)) { + ret = NT_STATUS_OK; + } + SAFE_FREE(data.dptr); + } + + return ret; +} + +/* Get an id from a sid */ +static NTSTATUS db_get_id_from_sid(unid_t *id, int *id_type, const DOM_SID *sid) +{ + TDB_DATA data, key; + fstring keystr; + NTSTATUS ret = NT_STATUS_UNSUCCESSFUL; + + if (!sid || !id || !id_type) return NT_STATUS_INVALID_PARAMETER; + + /* Check if sid is present in database */ + sid_to_string(keystr, sid); + + key.dptr = keystr; + key.dsize = strlen(keystr) + 1; + + data = tdb_fetch(idmap_tdb, key); + + if (data.dptr) { + int type = *id_type & ID_TYPEMASK; + fstring scanstr; + + if (type == ID_EMPTY || type == ID_USERID) { + /* Parse and return existing uid */ + fstrcpy(scanstr, "UID %d"); + + if (sscanf(data.dptr, scanstr, &((*id).uid)) == 1) { + /* uid ok? */ + if (type == ID_EMPTY) { + *id_type = ID_USERID; + } + ret = NT_STATUS_OK; + goto idok; + } + } + + if (type == ID_EMPTY || type == ID_GROUPID) { + /* Parse and return existing gid */ + fstrcpy(scanstr, "GID %d"); + + if (sscanf(data.dptr, scanstr, &((*id).gid)) == 1) { + /* gid ok? */ + if (type == ID_EMPTY) { + *id_type = ID_GROUPID; + } + ret = NT_STATUS_OK; + } + } +idok: + SAFE_FREE(data.dptr); + + } else if (!(*id_type & ID_NOMAP) && + (((*id_type & ID_TYPEMASK) == ID_USERID) + || (*id_type & ID_TYPEMASK) == ID_GROUPID)) { + + /* Allocate a new id for this sid */ + ret = db_allocate_id(id, *id_type); + if (NT_STATUS_IS_OK(ret)) { + fstring keystr2; + + /* Store new id */ + if (*id_type & ID_USERID) { + slprintf(keystr2, sizeof(keystr2), "UID %d", (*id).uid); + } else { + slprintf(keystr2, sizeof(keystr2), "GID %d", (*id).gid); + } + + data.dptr = keystr2; + data.dsize = strlen(keystr2) + 1; + + if (tdb_store(idmap_tdb, key, data, TDB_REPLACE) == -1) { + /* TODO: print tdb error !! */ + return NT_STATUS_UNSUCCESSFUL; + } + if (tdb_store(idmap_tdb, data, key, TDB_REPLACE) == -1) { + /* TODO: print tdb error !! */ + return NT_STATUS_UNSUCCESSFUL; + } + + ret = NT_STATUS_OK; + } + } + + return ret; +} + +static NTSTATUS db_set_mapping(const DOM_SID *sid, unid_t id, int id_type) +{ + TDB_DATA ksid, kid, data; + fstring ksidstr; + fstring kidstr; + + if (!sid) return NT_STATUS_INVALID_PARAMETER; + + sid_to_string(ksidstr, sid); + + ksid.dptr = ksidstr; + ksid.dsize = strlen(ksidstr) + 1; + + if (id_type & ID_USERID) { + slprintf(kidstr, sizeof(kidstr), "UID %d", id.uid); + } else if (id_type & ID_GROUPID) { + slprintf(kidstr, sizeof(kidstr), "GID %d", id.gid); + } else { + return NT_STATUS_INVALID_PARAMETER; + } + + kid.dptr = kidstr; + kid.dsize = strlen(kidstr) + 1; + + /* *DELETE* prevoius mappings if any. + * This is done both SID and [U|G]ID passed in */ + + data = tdb_fetch(idmap_tdb, ksid); + if (data.dptr) { + tdb_delete(idmap_tdb, data); + tdb_delete(idmap_tdb, ksid); + } + data = tdb_fetch(idmap_tdb, kid); + if (data.dptr) { + tdb_delete(idmap_tdb, data); + tdb_delete(idmap_tdb, kid); + } + + if (tdb_store(idmap_tdb, ksid, kid, TDB_INSERT) == -1) { + DEBUG(0, ("idb_set_mapping: tdb_store 1 error: %s\n", tdb_errorstr(idmap_tdb))); + return NT_STATUS_UNSUCCESSFUL; + } + if (tdb_store(idmap_tdb, kid, ksid, TDB_INSERT) == -1) { + DEBUG(0, ("idb_set_mapping: tdb_store 2 error: %s\n", tdb_errorstr(idmap_tdb))); + return NT_STATUS_UNSUCCESSFUL; + } + return NT_STATUS_OK; +} + +/***************************************************************************** + Initialise idmap database. +*****************************************************************************/ +static NTSTATUS db_idmap_init(void) +{ + SMB_STRUCT_STAT stbuf; + char *tdbfile = NULL; + int32 version; + BOOL tdb_is_new = False; + + /* use the old database if present */ + if (!file_exist(lock_path("idmap.tdb"), &stbuf)) { + if (file_exist(lock_path("winbindd_idmap.tdb"), &stbuf)) { + DEBUG(0, ("idmap_init: using winbindd_idmap.tdb file!\n")); + tdbfile = strdup(lock_path("winbindd_idmap.tdb")); + if (!tdbfile) { + DEBUG(0, ("idmap_init: out of memory!\n")); + return NT_STATUS_NO_MEMORY; + } + } else { + tdb_is_new = True; + } + } + if (!tdbfile) { + tdbfile = strdup(lock_path("idmap.tdb")); + if (!tdbfile) { + DEBUG(0, ("idmap_init: out of memory!\n")); + return NT_STATUS_NO_MEMORY; + } + } + + /* Open tdb cache */ + if (!(idmap_tdb = tdb_open_log(tdbfile, 0, + TDB_DEFAULT, O_RDWR | O_CREAT, + 0600))) { + DEBUG(0, ("idmap_init: Unable to open idmap database\n")); + SAFE_FREE(tdbfile); + return NT_STATUS_UNSUCCESSFUL; + } + + SAFE_FREE(tdbfile); + + /* check against earlier versions */ + if (tdb_is_new) { + /* TODO: delete the file if this fail */ + tdb_store_int32(idmap_tdb, "IDMAP_VERSION", IDMAP_VERSION); + } else { + version = tdb_fetch_int32(idmap_tdb, "IDMAP_VERSION"); + if (version != IDMAP_VERSION) { + DEBUG(0, ("idmap_init: Unable to open idmap database, it's in an old format!\n")); + return NT_STATUS_INTERNAL_DB_ERROR; + } + } + + /* Create high water marks for group and user id */ + if (!lp_idmap_uid(&idmap_state.uid_low, &idmap_state.uid_high)) { + DEBUG(0, ("idmap uid range missing or invalid\n")); + DEBUGADD(0, ("idmap will be unable to map foreign SIDs\n")); + } else { + if (tdb_fetch_int32(idmap_tdb, HWM_USER) == -1) { + if (tdb_store_int32(idmap_tdb, HWM_USER, idmap_state.uid_low) == -1) { + DEBUG(0, ("idmap_init: Unable to initialise user hwm in idmap database\n")); + return NT_STATUS_INTERNAL_DB_ERROR; + } + } + } + + if (!lp_idmap_gid(&idmap_state.gid_low, &idmap_state.gid_high)) { + DEBUG(0, ("idmap gid range missing or invalid\n")); + DEBUGADD(0, ("idmap will be unable to map foreign SIDs\n")); + } else { + if (tdb_fetch_int32(idmap_tdb, HWM_GROUP) == -1) { + if (tdb_store_int32(idmap_tdb, HWM_GROUP, idmap_state.gid_low) == -1) { + DEBUG(0, ("idmap_init: Unable to initialise group hwm in idmap database\n")); + return NT_STATUS_INTERNAL_DB_ERROR; + } + } + } + + return NT_STATUS_OK; +} + +/* Close the tdb */ +static NTSTATUS db_idmap_close(void) +{ + if (idmap_tdb) { + if (tdb_close(idmap_tdb) == 0) { + return NT_STATUS_OK; + } else { + return NT_STATUS_UNSUCCESSFUL; + } + } + return NT_STATUS_OK; +} + + +/* Dump status information to log file. Display different stuff based on + the debug level: + + Debug Level Information Displayed + ================================================================= + 0 Percentage of [ug]id range allocated + 0 High water marks (next allocated ids) +*/ + +#define DUMP_INFO 0 + +static void db_idmap_status(void) +{ + int user_hwm, group_hwm; + + DEBUG(0, ("winbindd idmap status:\n")); + + /* Get current high water marks */ + + if ((user_hwm = tdb_fetch_int32(idmap_tdb, HWM_USER)) == -1) { + DEBUG(DUMP_INFO, + ("\tCould not get userid high water mark!\n")); + } + + if ((group_hwm = tdb_fetch_int32(idmap_tdb, HWM_GROUP)) == -1) { + DEBUG(DUMP_INFO, + ("\tCould not get groupid high water mark!\n")); + } + + /* Display next ids to allocate */ + + if (user_hwm != -1) { + DEBUG(DUMP_INFO, + ("\tNext userid to allocate is %d\n", user_hwm)); + } + + if (group_hwm != -1) { + DEBUG(DUMP_INFO, + ("\tNext groupid to allocate is %d\n", group_hwm)); + } + + /* Display percentage of id range already allocated. */ + + if (user_hwm != -1) { + int num_users = user_hwm - idmap_state.uid_low; + int total_users = + idmap_state.uid_high - idmap_state.uid_low; + + DEBUG(DUMP_INFO, + ("\tUser id range is %d%% full (%d of %d)\n", + num_users * 100 / total_users, num_users, + total_users)); + } + + if (group_hwm != -1) { + int num_groups = group_hwm - idmap_state.gid_low; + int total_groups = + idmap_state.gid_high - idmap_state.gid_low; + + DEBUG(DUMP_INFO, + ("\tGroup id range is %d%% full (%d of %d)\n", + num_groups * 100 / total_groups, num_groups, + total_groups)); + } + + /* Display complete mapping of users and groups to rids */ +} + +struct idmap_methods db_methods = { + + db_idmap_init, + db_get_sid_from_id, + db_get_id_from_sid, + db_set_mapping, + db_idmap_close, + db_idmap_status + +}; + +NTSTATUS idmap_reg_tdb(struct idmap_methods **meth) +{ + *meth = &db_methods; + + return NT_STATUS_OK; +} |