annotate dos2unix.xml @ 0:bf1e9386e828 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
author iuc
date Mon, 20 Oct 2025 16:57:15 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
1 <tool id="dos2unix" name="Text file format converters (dos2unix)" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE_VERSION@">
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
2 <description>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
3 Convert text files with DOS or Mac line breaks to Unix line breaks and other text cleaning options.
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
4 </description>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
5 <macros>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
6 <import>macros.xml</import>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
7 </macros>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
8 <edam_topics>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
9 <edam_topic>topic_3572</edam_topic>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
10 </edam_topics>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
11 <edam_operations>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
12 <edam_operation>operation_0335</edam_operation>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
13 </edam_operations>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
14 <expand macro="requirements"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
15 <command detect_errors="exit_code"><![CDATA[
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
16 #if $info
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
17 dos2unix --info $mac_mode '$input_file' > '$output_file'
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
18 #else
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
19 dos2unix --newfile --safe $add_end_of_line $mac_mode $bom '$input_file' '$output_file'
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
20 #end if
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
21 ]]></command>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
22 <inputs>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
23 <param name="input_file" format="txt,tsv,csv,tabular" type="data" label="The input file to convert to Unix format"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
24 <param name="add_end_of_line" type="boolean" truevalue="--add-eol" falsevalue="--no-add-eol" checked="true" label="Add (or don't add) a line break to the last line if there isn't one."/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
25 <param name="bom" type="boolean" truevalue="--remove-bom" falsevalue="--keep-bom" checked="true" label="Remove Byte Order Mark (BOM). Do not write a BOM in the output file."/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
26 <param name="mac_mode" type="boolean" truevalue="-c mac" falsevalue="" checked="false" label="Run in Mac Mode." help="By default line breaks are converted from DOS to Unix and vice versa. Mac line breaks are not converted. In Mac mode line breaks are converted from Mac to Unix and vice versa. DOS line breaks are not changed."/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
27 <param name="info" type="boolean" truevalue="--info" falsevalue="" checked="false" label="Display file information. No conversion is done." help="The following information is printed, in this order: number of DOS line breaks, number of Unix line breaks, number of Mac line breaks, byte order mark, text or binary, file name."/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
28 </inputs>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
29 <outputs>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
30 <data name="output_file" format="txt"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
31 </outputs>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
32 <tests>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
33 <test expect_num_outputs="1">
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
34 <param name="input_file" value="censored.txt"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
35 <param name="add_end_of_line" value="false"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
36 <param name="bom" value="false"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
37 <param name="mac_mode" value="false"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
38 <param name="info" value="true"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
39 <output name="output_file">
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
40 <assert_contents>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
41 <has_text text="UTF-8"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
42 </assert_contents>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
43 </output>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
44 </test>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
45 <test expect_num_outputs="1">
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
46 <param name="input_file" value="censored_no_bom.txt"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
47 <param name="add_end_of_line" value="false"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
48 <param name="bom" value="false"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
49 <param name="mac_mode" value="false"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
50 <param name="info" value="true"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
51 <output name="output_file">
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
52 <assert_contents>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
53 <has_text text="no_bom"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
54 </assert_contents>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
55 </output>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
56 </test>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
57 <test expect_num_outputs="1">
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
58 <param name="input_file" value="censored.txt"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
59 <param name="add_end_of_line" value="true"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
60 <param name="bom" value="true"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
61 <param name="mac_mode" value="false"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
62 <param name="info" value="false"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
63 <output name="output_file" file="censored_no_bom.txt"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
64 </test>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
65 </tests>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
66 <help><![CDATA[
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
67 This tool can be used to convert files in DOS or Mac format to Unix format.
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
68 In DOS/Windows text files a line break, also known as newline, is a combination of two
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
69 characters: a Carriage Return (CR) followed by a Line Feed (LF). In Unix text files a
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
70 line break is a single character: the Line Feed (LF). In Mac text files, prior to Mac OS X,
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
71 a line break was single Carriage Return (CR) character. Nowadays Mac OS uses Unix style (LF) line breaks.
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
72 ]]></help>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
73 <citations>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
74 <expand macro="citations"/>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
75 </citations>
bf1e9386e828 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/dos2unix commit 273375ad5619a511617f30f977b9734e656016fc
iuc
parents:
diff changeset
76 </tool>