Difference between revisions of "Page Template"

From CBLFS
Jump to navigationJump to search
m
 
(4 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
|-
 
|-
 
!Download Source:
 
!Download Source:
−
| ftp://sources.redhat.com/pub/dm/device-mapper.{{Device-mapper-Version}}.tgz
+
| URL
 +
|-
 +
!Download Patch:
 +
| URL - This should be a URL beginning with http://svn.cross-lfs.org/svn/repos/patches/.  See http://patches.cross-lfs.org/patch-submitter for instructions on submitting patches for CBLFS.
 
|}
 
|}
  
 
----
 
----
  
−
{{Package-Introduction|The Device-mapper is a new component of the linux kernel that supports logical volume management.|http://sources.redhat.com/dm/}}
+
{{Package-Introduction|Brief description of the package you are enlightening us with.  Try to provide a description in your own words.  Add a link to the package's homepage for someone unfamiliar with the package to research further.|http://homepage/to/cool/package}}
 +
 
 +
----
 +
 
 +
'''<font style="color: green">If there is some reason you are adding a package and are unable to provide a brief description of it's functionality, please do two things. First, reconsider installing software that you have no idea what it does.  Second, please use this template. It allows us to identify packages that need introductions without "hunting" through the wiki.</font>'''
 +
 
 +
{{Blank-Package-Introduction}}
 +
 
 +
'''<font style="color: green">Use this template to add notes where ever a note is appropriate.</font>'''
 +
 
 +
{{Note|ADD SOMETHING NOTEWORTHY}}
  
 
== Dependencies ==
 
== Dependencies ==
 +
 +
'''<font style="color: green">If there are no dependencies, omit this section.</font>'''
 +
 +
=== Required ===
 +
* [[Required Dependency #1]]
 +
* [[Required Dependency #2]]
 +
 +
=== Recommended ===
 +
* [[Recommended Dependency #1]]
 +
* [[Recommended Dependency #2]]
 +
 +
=== Optional ===
 +
* [[Optional Dependency #1]]
 +
* [[Optional Dependency #2]]
 +
 +
=== Runtime ===
 +
* [[Runtime Dependency #1]]
 +
* [[Runtime Dependency #2]]
 +
 +
== Creating the <NAME> User & Group ==
 +
 +
'''<font style="color: green">This is an optional section. If your package requires a user/group add this section to the page then append the table on the [[System User and Groups]] page. Below is an example.  If there is no need to create a user or group, omit this section.</font>'''
 +
 +
groupadd -g ''[id]'' ''[name]'' &&
 +
useradd -c "''[desc]''" -d /dev/null \
 +
        -u ''[id]'' -g ''[name]'' -s /bin/false ''[name]''
 +
 +
== Configuration Information ==
 +
 +
'''<font style="color: green">This section can contain options that you may want to include when configuring the package, but should be left as a choice.  However, don't just reproduce the output of ./configure --help; be judicious in your selection.  If there are no configuration options that warrant discussion, omit this section.</font>'''
 +
 +
{|
 +
|-
 +
|''--enable-someoption:'' brief description of the non-default functionality provided by someoption.
 +
|-
 +
|''--disable-someotheroption:'' brief description of the default functionality removed by disabling someotheroption.
 +
|-
 +
|''--with-somepackage=DIR:''
 +
|}
 +
 +
'''<font style="color: green">Generally speaking, CBLFS packages are installed in the /usr hierarchy although there are some exceptions.  Even if you passed --prefix=/home/fubar/stuff/CBLFS/is/really/awesome/some/package/version/5.0/hope/this/works to the configure script, please use --prefix=/usr for the wiki.  Thanks.  Also, the instructions presume that the source package has been retrieved to the local machine, unpacked, and you have cd'd to the top of the source tree.  Generally, we don't need those instructions unless there is something very unique about the process for the package you are adding.</font>'''
  
 
== Non-Multilib ==
 
== Non-Multilib ==
Line 15: Line 69:
 
Compile the package:
 
Compile the package:
  
−
  ./configure --mandir=/usr/share/man --enable-dmeventd \
+
  ./configure --prefix=/usr &&
−
    --enable-pkgconfig --disable-selinux &&
 
 
  make
 
  make
  
Line 24: Line 77:
  
 
== Multilib ==
 
== Multilib ==
 +
 +
'''<font style="color: green">If appropriate, add this line and only include the 64-bit instructions:</font>'''
 +
 +
'''''This package does not provide any libraries or other ABI-specific information so only one installation is required.'''''
 +
 +
'''<font style="color: green">If package documentation is not installed by the 'make install' step, only include the commands to install the documentation in the 64-bit section.</font>'''
  
 
=== 32Bit ===
 
=== 32Bit ===
Line 29: Line 88:
 
Compile the package:
 
Compile the package:
  
−
  CC="gcc ${BUILD32}" ./configure --mandir=/usr/share/man \
+
  CC="gcc ${BUILD32}" ./configure --prefix=/usr &&
−
    --enable-dmeventd --enable-pkgconfig --disable-selinux &&
 
 
  make
 
  make
  
Line 41: Line 99:
 
Compile the package:
 
Compile the package:
  
−
sed -i "/usrlibdir/s:/lib:&32:" configure &&
+
  CC="gcc ${BUILDN32}" ./configure --prefix=/usr \
−
  CC="gcc ${BUILDN32}" ./configure --mandir=/usr/share/man \
+
     --libdir=/usr/lib32 &&
−
     --enable-dmeventd --libdir=/lib32 \
 
−
    --enable-pkgconfig --disable-selinux &&
 
 
  make
 
  make
  
Line 55: Line 111:
 
Compile the package:
 
Compile the package:
  
−
sed -i "/usrlibdir/s:/lib:&64:" configure &&
+
  CC="gcc ${BUILD64}" ./configure --prefix=/usr \
−
  CC="gcc ${BUILD64}" ./configure --libdir=/lib64 \
+
     --libdir=/usr/lib64 &&
−
     --mandir=/usr/share/man --enable-dmeventd \
 
−
    --enable-pkgconfig --disable-selinux &&
 
 
  make
 
  make
  
Line 65: Line 119:
 
  make install
 
  make install
  
−
== Confuration ==
+
== Configuring ==
 +
 
 +
'''<font style="color: green">This section should contain information about the post-installation configuration of a package, bootscript(s), other files, creating directories.  Omit this section if there is no post-installation configuration required.</font>'''
 +
 
 +
== Contents ==
 +
 
 +
'''<font style="color: green">You can find an application [[User:Weibullguy|here]] that can be used to make creating this table reasonably pain free.</font>'''
  
−
=== Bootscript ===
+
{| style="text-align: left;"
 +
|-valign="top"
 +
!Installed Directories:
 +
|/path/to/dir
 +
|-valign="top"
 +
!Installed Programs:
 +
|Program 1, Program 2
 +
|-valign="top"
 +
!Installed Libraries:
 +
|library1.{a,so}, library2.{a,so}
 +
|}
  
−
The following bootscript is only needed in a very specific situation, If you use an initramfs or some other early userspace to initialize device mapper.  This script only runs '''dmsetup mknodes''' and reports the status of the command on start. If you need this functionality, install the bootscript with the following command:
+
=== Short Descriptions ===
  
−
make install-devmapper
+
{| style="text-align: left;"
 +
|-valign="top"
 +
!Program 1
 +
|is a program that converts pennies to dollars.
 +
|-valign="top"
 +
!Program 2
 +
|is a program that converts dollars to pennies.
 +
|-valign="top"
 +
!library1.{so,a}
 +
|is a library that contains functions necessary to convert from dollars to pennies and vice versa.
 +
|}
  
−
[[Category:Block Device]]
+
[[Category:<PUT APPROPRIATE CATEGORY HERE>]] '''<font style="color: green">See http://cblfs.cross-lfs.org/index.php/Special:Categories for a list of categories.  Likely your package will fit in one of the existing categories.  If not, and think long and hard about it, create a new category.'''

Latest revision as of 19:02, 17 July 2009

Download Source: URL
Download Patch: URL - This should be a URL beginning with http://svn.cross-lfs.org/svn/repos/patches/. See http://patches.cross-lfs.org/patch-submitter for instructions on submitting patches for CBLFS.

Introduction to Page Template

Brief description of the package you are enlightening us with. Try to provide a description in your own words. Add a link to the package's homepage for someone unfamiliar with the package to research further.

Project Homepage: http://homepage/to/cool/package

If there is some reason you are adding a package and are unable to provide a brief description of it's functionality, please do two things. First, reconsider installing software that you have no idea what it does. Second, please use this template. It allows us to identify packages that need introductions without "hunting" through the wiki.

Introduction to Page Template

Project Homepage: Unknown

Use this template to add notes where ever a note is appropriate.

Caution.png

Note

ADD SOMETHING NOTEWORTHY

Dependencies

If there are no dependencies, omit this section.

Required

Recommended

Optional

Runtime

Creating the <NAME> User & Group

This is an optional section. If your package requires a user/group add this section to the page then append the table on the System User and Groups page. Below is an example. If there is no need to create a user or group, omit this section. 

groupadd -g [id] [name] &&
useradd -c "[desc]" -d /dev/null \
       -u [id] -g [name] -s /bin/false [name]

Configuration Information

This section can contain options that you may want to include when configuring the package, but should be left as a choice. However, don't just reproduce the output of ./configure --help; be judicious in your selection. If there are no configuration options that warrant discussion, omit this section.

--enable-someoption: brief description of the non-default functionality provided by someoption.
--disable-someotheroption: brief description of the default functionality removed by disabling someotheroption.
--with-somepackage=DIR:

Generally speaking, CBLFS packages are installed in the /usr hierarchy although there are some exceptions. Even if you passed --prefix=/home/fubar/stuff/CBLFS/is/really/awesome/some/package/version/5.0/hope/this/works to the configure script, please use --prefix=/usr for the wiki. Thanks. Also, the instructions presume that the source package has been retrieved to the local machine, unpacked, and you have cd'd to the top of the source tree. Generally, we don't need those instructions unless there is something very unique about the process for the package you are adding.

Non-Multilib

Compile the package: 

./configure --prefix=/usr &&
make

Install the package: 

make install

Multilib

If appropriate, add this line and only include the 64-bit instructions:

This package does not provide any libraries or other ABI-specific information so only one installation is required.

If package documentation is not installed by the 'make install' step, only include the commands to install the documentation in the 64-bit section.

32Bit

Compile the package: 

CC="gcc ${BUILD32}" ./configure --prefix=/usr &&
make

Install the package: 

make install

N32

Compile the package: 

CC="gcc ${BUILDN32}" ./configure --prefix=/usr \
    --libdir=/usr/lib32 &&
make

Install the package: 

make install

64Bit

Compile the package: 

CC="gcc ${BUILD64}" ./configure --prefix=/usr \
    --libdir=/usr/lib64 &&
make

Install the package: 

make install

Configuring

This section should contain information about the post-installation configuration of a package, bootscript(s), other files, creating directories. Omit this section if there is no post-installation configuration required.

Contents

You can find an application here that can be used to make creating this table reasonably pain free.

Installed Directories: /path/to/dir
Installed Programs: Program 1, Program 2
Installed Libraries: library1.{a,so}, library2.{a,so}

Short Descriptions

Program 1 is a program that converts pennies to dollars.
Program 2 is a program that converts dollars to pennies.
library1.{so,a} is a library that contains functions necessary to convert from dollars to pennies and vice versa.

[[Category:<PUT APPROPRIATE CATEGORY HERE>]] See http://cblfs.cross-lfs.org/index.php/Special:Categories for a list of categories. Likely your package will fit in one of the existing categories. If not, and think long and hard about it, create a new category.

Retrieved from "https://cblfs.clfs.org/index.php?title=Page_Template&oldid=18695"