Browse code

Updated release manpage

Jaidyn Lev authored on 2018-07-29 00:40:25
Showing 3 changed files
1 1
deleted file mode 100644
... ...
@@ -1,185 +0,0 @@
1
-.\"	$OpenBSD: help.1,v 1.3 2016/09/02 12:17:32 tb Exp $
2
-.\"
3
-.\" Copyright (c) 1999 Aaron Campbell
4
-.\" All rights reserved.
5
-.\"
6
-.\" Redistribution and use in source and binary forms, with or without
7
-.\" modification, are permitted provided that the following conditions
8
-.\" are met:
9
-.\"
10
-.\" 1. Redistributions of source code must retain the above copyright
11
-.\"    notice, this list of conditions and the following disclaimer.
12
-.\" 2. Redistributions in binary form must reproduce the above copyright
13
-.\"    notice, this list of conditions and the following disclaimer in the
14
-.\"    documentation and/or other materials provided with the distribution.
15
-.\"
16
-.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17
-.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18
-.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19
-.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20
-.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21
-.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22
-.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23
-.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24
-.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25
-.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
-.\"
27
-.Dd $Mdocdate: September 2 2016 $
28
-.Dt HELP 1
29
-.Os
30
-.Sh NAME
31
-.Nm help
32
-.Nd help for new users and administrators
33
-.Sh DESCRIPTION
34
-This document is meant to familiarize new users and system administrators with
35
-LibertyBSD
36
-and, if necessary,
37
-.Ux
38
-in general.
39
-.Pp
40
-Firstly, a wealth of information is contained within the system manual pages.
41
-In
42
-.Ux ,
43
-the
44
-.Xr man 1
45
-command is used to view them.
46
-Type
47
-.Ic man man
48
-for instructions on how to use it properly.
49
-Pay especially close attention to the
50
-.Fl k
51
-option.
52
-.Pp
53
-System administrators should have already read the
54
-.Xr afterboot 8
55
-man page which explains a variety of tasks that are typically performed
56
-after the first system boot.
57
-When configuring any aspect of the system, first consider any possible security
58
-implications your changes may have.
59
-.Ss The Unix shell
60
-After logging in, some system messages are typically displayed, and then the
61
-user is able to enter commands to be processed by the shell program.
62
-The shell is a command-line interpreter that reads user input (normally from
63
-a terminal) and executes commands.
64
-There are many different shells available;
65
-LibertyBSD
66
-ships with
67
-.Xr csh 1 ,
68
-.Xr ksh 1 ,
69
-and
70
-.Xr sh 1 .
71
-Each user's shell is indicated by the last field of their corresponding entry
72
-in the system password file
73
-.Pf ( Pa /etc/passwd ) .
74
-.Ss Basic Unix commands
75
-.Bl -tag -width "chmodXXX"
76
-.It Cm man
77
-Interface to the system manual pages.
78
-For any of the commands listed below, type
79
-.Ic man Ar command
80
-for detailed information on what it does and how to use it.
81
-.It Cm pwd
82
-Print working directory.
83
-Files are organized in a hierarchy (see
84
-.Xr hier 7 )
85
-called a tree.
86
-This command will indicate in which directory you are currently located.
87
-.It Cm cd
88
-Change working directory.
89
-Use this command to navigate throughout the file hierarchy.
90
-For example, type
91
-.Ic cd /
92
-to change the working directory to the root.
93
-.It Cm ls
94
-List directory contents.
95
-Type
96
-.Ic ls -l
97
-for a detailed listing.
98
-.It Cm cat
99
-Although it has many more uses,
100
-.Ic cat Ar filename
101
-will print the contents of a plain-text file to the screen.
102
-.It Cm vi
103
-Edit text files.
104
-For example,
105
-.Ic vi Ar filename .
106
-See also
107
-.Xr mg 1 .
108
-.It Cm mkdir
109
-Make a directory.
110
-For example,
111
-.Ic mkdir Ar dirname .
112
-.It Cm rmdir
113
-Remove a directory.
114
-.It Cm rm
115
-Remove files.
116
-Files are generally only removable by their owners.
117
-See the
118
-.Xr chmod 1
119
-command for information on file permissions.
120
-.It Cm chmod
121
-Change file modes, including permissions.
122
-It is not immediately obvious how to use this command; please read its manual
123
-page carefully, as proper file permissions, especially on system files, are
124
-vital in maintaining security and integrity.
125
-.It Cm cp
126
-Copy files.
127
-.It Cm mv
128
-Move and rename files.
129
-.It Cm ps
130
-List active processes.
131
-Most
132
-.Ux Ns -based
133
-operating systems, including
134
-LibertyBSD,
135
-are multitasking, meaning many programs share system resources at the same
136
-time.
137
-A common usage is
138
-.Ic ps -auxw ,
139
-which will display information about all active processes.
140
-.It Cm kill
141
-Kill processes.
142
-Used mostly for terminating run-away/unresponsive programs, but also used to
143
-signal programs for requesting certain operations (e.g., re-read their
144
-configuration).
145
-.It Cm date
146
-Print the current system date and time.
147
-.It Cm mail
148
-Access mailbox.
149
-.It Cm exit
150
-Log out of the system.
151
-.El
152
-.Pp
153
-When a command is entered, it is first checked to see if it is built-in to the
154
-shell.
155
-If not, the shell looks for the command in any directories contained within the
156
-.Ev PATH
157
-environment variable (see
158
-.Xr environ 7 ) .
159
-If the command is not found, an error message is printed.
160
-Otherwise, the shell runs the command, passing it any arguments specified on
161
-the command line.
162
-.Pp
163
-Shell built-in commands do not have their own manual page,
164
-so it's necessary to read the manual page for the user's shell.
165
-Tools such as
166
-.Xr which 1
167
-and
168
-.Dq whence ,
169
-a
170
-.Xr ksh 1
171
-built-in command,
172
-can be used to see what commands are being executed.
173
-.Sh SEE ALSO
174
-.Xr csh 1 ,
175
-.Xr ksh 1 ,
176
-.Xr man 1 ,
177
-.Xr whatis 1 ,
178
-.Xr whereis 1 ,
179
-.Xr which 1 ,
180
-.Xr afterboot 8
181
-.Sh HISTORY
182
-This manual page was written by
183
-.An Aaron Campbell Aq Mt aaron@openbsd.org
184
-and first appeared in
185
-.Ox 2.6 .
... ...
@@ -1,4 +1,4 @@
1
-.\"	$OpenBSD: release.8,v 1.86 2017/01/24 14:08:53 tb Exp $
1
+.\"	$OpenBSD: release.8,v 1.93 2018/02/15 19:01:39 tb Exp $
2 2
 .\"
3 3
 .\"	Copyright (c) 2000 Marco S. Hyman
4 4
 .\"	Copyright (c) 2016 Theo Buehler <tb@openbsd.org>
... ...
@@ -10,12 +10,12 @@
10 10
 .\"	LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
11 11
 .\"	FOR A PARTICULAR PURPOSE.
12 12
 .\"
13
-.Dd $Mdocdate: January 24 2017 $
13
+.Dd $Mdocdate: February 15 2018 $
14 14
 .Dt RELEASE 8
15 15
 .Os
16 16
 .Sh NAME
17 17
 .Nm release
18
-.Nd building a LibertyBSD release
18
+.Nd building an LibertyBSD release
19 19
 .Sh DESCRIPTION
20 20
 There are several steps necessary to build a release:
21 21
 .Pp
... ...
@@ -38,18 +38,6 @@ Make the third party packages.
38 38
 Create boot and installation disk images.
39 39
 .El
40 40
 .Pp
41
-This manual describes the steps for the
42
-.Em release
43
-and
44
-.Em stable
45
-branches.
46
-To build a
47
-.Em current
48
-release, additional steps may be required.
49
-See
50
-.Lk https://www.openbsd.org/faq/current.html
51
-for any needed workarounds.
52
-.Pp
53 41
 Commands to be run as a user are preceded by a dollar sign
54 42
 .Sq $ .
55 43
 Commands that must be run as the superuser are preceded by a hash mark
... ...
@@ -62,44 +50,36 @@ Most of the defaults can be overridden by setting
62 50
 the appropriate variables in
63 51
 .Xr mk.conf 5 .
64 52
 .Ss 1. Fetch sources
65
-A
66
-.Nm
67
-should use sources that were checked out using the same
68
-.Xr cvs 1
69
-tag.
70
-There are two families of tags:
71
-.Bl -tag -width LIBERTYBSD_x_y_BASE
72
-.It LIBERTYBSD_x_y_BASE
73
-The sources for the
74
-LibertyBSD x.y
75
-release.
76
-.It LIBERTYBSD_x_y
77
-The sources for the
78
-LibertyBSD x.y
79
-stable branch.
80
-It contains the patches described in
81
-.Lk https://libertybsd.net/errata.html .
82
-.El
53
+You can fetch sources from 
54
+.Lk https://ftp.libertybsd.net/pub/LibertyBSD/x.y/ ,
55
+.Lk ftp://ftp.libertybsd.net/pub/LibertyBSD/x.y/ ,
56
+or from a mirror.
83 57
 .Pp
84
-See
85
-.Lk https://libertybsd.net/anoncvs.html
86
-for instructions on fetching the sources for the first time.
58
+You can find a list of mirrors at
59
+.Lk https://libertybsd.net/download.shtml .
87 60
 .Pp
88
-To update existing sources to the versions identified by one of the above
89
-tags, use the commands:
90
-.Bd -literal -offset indent
91
-$ cd /usr/src && cvs up -r TAG -Pd
92
-$ cd /usr/xenocara && cvs up -r TAG -Pd
93
-$ cd /usr/ports && cvs up -r TAG -Pd
94
-.Ed
61
+The files you'll need are
62
+.Pa src.tar.gz ,
63
+.Pa sys.tar.gz ,
64
+and
65
+.Pa xenocara.tar.gz .
66
+.Pp
67
+As for dealing with these tarballs:
68
+.Bl -compact -offset indent
69
+.It
70
+.Pa src.tar.gz
71
+should be extracted to
72
+.Pa /usr/src
73
+.It
74
+.Pa sys.tar.gz
75
+should be extracted to
76
+.Pa /usr/src/sys
77
+.It
78
+.Pa xenocara.tar.gz
79
+should be extracted to
80
+.Pa /usr/xenocara
81
+.El
95 82
 .Pp
96
-.Sy Warning :
97
-.Xr cvs 1
98
-tags are
99
-.Sq sticky .
100
-See
101
-.Xr cvs 1
102
-for more information.
103 83
 .Ss 2. Build and install a new kernel
104 84
 Always build and install a new kernel and reboot before
105 85
 building the programs that will use the kernel.
... ...
@@ -128,7 +108,7 @@ Reboot.
128 108
 .Ss 3. Build a new base system
129 109
 The build process will place the object files in a tree under
130 110
 .Pa /usr/obj .
131
-This directory should be empty and owned by build:wobj with mode 770.
111
+This directory must be owned by build:wobj with mode 770.
132 112
 .Pp
133 113
 Create the tree of obj directories and begin the build:
134 114
 .Bd -literal -offset indent
... ...
@@ -144,7 +124,11 @@ and
144 124
 using
145 125
 .Xr sysmerge 8
146 126
 and
147
-.Xr MAKEDEV 8 .
127
+.Xr MAKEDEV 8 :
128
+.Bd -literal -offset indent
129
+# sysmerge
130
+# cd /dev && ./MAKEDEV all
131
+.Ed
148 132
 .Pp
149 133
 At this point, the base system is up to date and running the code
150 134
 that will be made into a release.
... ...
@@ -163,6 +147,9 @@ To build a release, it is necessary to prepare a filesystem mounted with the
163 147
 .Em noperm
164 148
 .Xr mount 8
165 149
 option.
150
+Either standard FFS or
151
+.Xr mount_mfs 8
152
+may be used.
166 153
 The root of this filesystem must have owner
167 154
 .Sy build
168 155
 and mode 700.
... ...
@@ -170,7 +157,7 @@ On this filesystem, create a
170 157
 .Va DESTDIR
171 158
 directory.
172 159
 This will be the root of a complete
173
-LibertyBSD
160
+.Ox
174 161
 installation.
175 162
 .Pp
176 163
 .Sy Warning :
... ...
@@ -189,7 +176,7 @@ is also used and must not be configured.
189 176
 .Pp
190 177
 Make the release and check the contents of the release tarballs:
191 178
 .Bd -literal -offset indent
192
-# export DESTDIR=your-destdir; export RELEASEDIR=your-releasedir
179
+# export DESTDIR=your-destdir RELEASEDIR=your-releasedir
193 180
 # cd /usr/src/etc && make release
194 181
 # cd /usr/src/distrib/sets && sh checkflist
195 182
 # unset RELEASEDIR DESTDIR
... ...
@@ -227,14 +214,14 @@ will be removed.
227 214
 .Pp
228 215
 The steps to build and validate the Xenocara release are:
229 216
 .Bd -literal -offset indent
230
-# export DESTDIR=your-destdir; export RELEASEDIR=your-releasedir
217
+# export DESTDIR=your-destdir RELEASEDIR=your-releasedir
231 218
 # make release
232 219
 # make checkdist
233 220
 # unset RELEASEDIR DESTDIR
234 221
 .Ed
235 222
 .Pp
236 223
 At this point,
237
-the LibertyBSD 
224
+.Ox
238 225
 base system and X Window System tarballs are in
239 226
 .Va RELEASEDIR .
240 227
 .Ss 7. Make the third party packages
... ...
@@ -250,8 +237,7 @@ and
250 237
 are suitable for installs without network connectivity.
251 238
 They contain the tarballs and ports built in the previous steps.
252 239
 .Bd -literal -offset indent
253
-# export RELDIR=your-releasedir
254
-# export RELXDIR=your-xenocara-releasedir
240
+# export RELDIR=your-releasedir RELXDIR=your-xenocara-releasedir
255 241
 # cd /usr/src/distrib/$(machine)/iso && make
256 242
 # make install
257 243
 .Ed
258 244
deleted file mode 100644
... ...
@@ -1,91 +0,0 @@
1
-.\"	$OpenBSD: uname.1,v 1.17 2011/10/21 14:48:02 ajacoutot Exp $
2
-.\"
3
-.\" Copyright (c) 1990 The Regents of the University of California.
4
-.\" All rights reserved.
5
-.\"
6
-.\" Redistribution and use in source and binary forms, with or without
7
-.\" modification, are permitted provided that the following conditions
8
-.\" are met:
9
-.\" 1. Redistributions of source code must retain the above copyright
10
-.\"    notice, this list of conditions and the following disclaimer.
11
-.\" 2. Redistributions in binary form must reproduce the above copyright
12
-.\"    notice, this list of conditions and the following disclaimer in the
13
-.\"    documentation and/or other materials provided with the distribution.
14
-.\" 3. Neither the name of the University nor the names of its contributors
15
-.\"    may be used to endorse or promote products derived from this software
16
-.\"    without specific prior written permission.
17
-.\"
18
-.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19
-.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21
-.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22
-.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24
-.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25
-.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26
-.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27
-.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28
-.\" SUCH DAMAGE.
29
-.\"
30
-.\"     from: @(#)du.1	6.13 (Berkeley) 6/20/91
31
-.\"
32
-.Dd $Mdocdate: October 21 2011 $
33
-.Dt UNAME-OBSD 1
34
-.Os
35
-.Sh NAME
36
-.Nm uname-obsd
37
-.Nd print operating system name as if it were OpenBSD
38
-.Sh SYNOPSIS
39
-.Nm uname-obsd
40
-.Op Fl amnprsv
41
-.Sh DESCRIPTION
42
-The
43
-.Nm uname-obsd
44
-utility operates in exactly the same way as
45
-.Xr uname 1
46
-except that the operating system name is printed as "OpenBSD".
47
-.Pp
48
-This is useful when building software that checks the operating
49
-system's name using
50
-.Xr uname 1
51
-but doesn't know about LibertyBSD. And example of this is the GNU
52
-build system's config.guess/config.sub files.
53
-.Pp
54
-To use uname-obsd when building, simply issue the command
55
-.D1 alias uname=/usr/bin/uname-obsd
56
-.Pp
57
-The options are as follows:
58
-.Bl -tag -width Ds
59
-.It Fl a
60
-Behave as though all of the options
61
-.Fl mnrsv
62
-were specified.
63
-.It Fl m
64
-Print the machine hardware name.
65
-.It Fl n
66
-Print the nodename (the nodename may be a name
67
-that the system is known by to a communications
68
-network).
69
-.It Fl p
70
-Print the machine processor architecture name.
71
-.It Fl r
72
-Print the operating system release.
73
-.It Fl s
74
-Print "OpenBSD".
75
-.It Fl v
76
-Print the operating system version.
77
-.El
78
-.Pp
79
-If no options are specified,
80
-.Nm uname
81
-prints "OpenBSD", as if the
82
-.Fl s
83
-option had been specified.
84
-.Sh EXIT STATUS
85
-.Ex -std uname-obsd
86
-.Sh SEE ALSO
87
-.Xr uname-obsd 1
88
-.Sh HISTORY
89
-The
90
-.Nm
91
-command first appeared in LibertyBSD 5.8.